find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bugbug-io:bugbug-io-folders-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: BugBug.io Public Folders API
  version: v2
  x-logo:
    url: /static/images/logo.svg
    altText: BugBug.io
  description: 'BugBug.io is a modern browser-based app for software testers, developers, or product managers in need of quick & reliable test automation. You can run tests from your CI/CD pipeline or build system. You can run tests and suites in the cloud via BugBug Command Line Interface.


    Please use Authorize button to Try it out.'
  contact:
    email: support@bugbug.io
tags:
- name: Folders
paths:
  /v2/folders/:
    get:
      operationId: v2_folders_list
      description: Returns folders for the project. Filter by `kind` or `parentId`.
      summary: List folders
      parameters:
      - in: query
        name: kind
        schema:
          type: string
          x-spec-enum-id: 9c17c40f667f186e
          enum:
          - component
          - test
        description: '* `test` - Test

          * `component` - Component'
      - in: query
        name: ordering
        schema:
          type: array
          items:
            type: string
            enum:
            - -created
            - -depth
            - -name
            - created
            - depth
            - name
        description: 'Ordering


          * `name` - Name

          * `-name` - Name (descending)

          * `created` - Created

          * `-created` - Created (descending)

          * `depth` - Depth

          * `-depth` - Depth (descending)'
        explode: false
        style: form
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: parentId
        schema:
          type: string
          format: uuid
      - in: query
        name: query
        schema:
          type: string
      tags:
      - Folders
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedV2FolderList'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
    post:
      operationId: v2_folders_create
      description: Creates a new folder. Project is taken from the auth token.
      summary: Create a folder
      parameters: []
      tags:
      - Folders
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/V2FolderCreate'
          application/json:
            schema:
              $ref: '#/components/schemas/V2FolderCreate'
        required: true
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Folder'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
  /v2/folders/{id}/:
    get:
      operationId: v2_folders_retrieve
      description: Returns a single folder.
      summary: Get folder by ID
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this folder.
        required: true
      tags:
      - Folders
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Folder'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
    patch:
      operationId: v2_folders_partial_update
      description: Updates folder name and/or moves the folder to a different parent. Pass `parentId=null` to move to root.
      summary: Update folder (rename or move)
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this folder.
        required: true
      tags:
      - Folders
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedV2FolderUpdate'
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedV2FolderUpdate'
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Folder'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
        '400':
          description: Request body failed validation.
        '404':
          description: Resource not found.
    delete:
      operationId: v2_folders_destroy
      description: Deletes a folder. Fails with 400 if folder is not empty unless `force=true` is passed. When forced, contained tests/components are unlinked and subtree is soft-deleted.
      summary: Delete folder
      parameters:
      - in: query
        name: force
        schema:
          type: boolean
        description: If true, deletes folder even if non-empty (cascades to subtree).
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this folder.
        required: true
      tags:
      - Folders
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '204':
          description: No response body
        '401':
          description: Authentication credentials were missing or invalid.
        '404':
          description: Resource not found.
  /v2/folders/tree/:
    get:
      operationId: v2_folders_tree_list
      description: Returns the full nested folder tree for a given kind.
      summary: Get folder tree
      parameters:
      - in: query
        name: kind
        schema:
          type: string
          enum:
          - component
          - test
        description: Folder kind.
        required: true
      - in: query
        name: ordering
        schema:
          type: array
          items:
            type: string
            enum:
            - -created
            - -depth
            - -name
            - created
            - depth
            - name
        description: 'Ordering


          * `name` - Name

          * `-name` - Name (descending)

          * `created` - Created

          * `-created` - Created (descending)

          * `depth` - Depth

          * `-depth` - Depth (descending)'
        explode: false
        style: form
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: parentId
        schema:
          type: string
          format: uuid
      - in: query
        name: query
        schema:
          type: string
      tags:
      - Folders
      security:
      - tokenAuth: []
      - Bearer: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedV2FolderTreeNodeList'
          description: ''
        '401':
          description: Authentication credentials were missing or invalid.
components:
  schemas:
    V2Folder:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          readOnly: true
        kind:
          enum:
          - test
          - component
          type: string
          description: '* `test` - Test

            * `component` - Component'
          x-spec-enum-id: 9c17c40f667f186e
          readOnly: true
        depth:
          type: integer
          readOnly: true
        parentId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
      required:
      - depth
      - id
      - kind
      - name
      - parentId
    PaginatedV2FolderTreeNodeList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/V2FolderTreeNode'
    PaginatedV2FolderList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/V2Folder'
    V2FolderCreate:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        kind:
          enum:
          - test
          - component
          type: string
          description: '* `test` - Test

            * `component` - Component'
          x-spec-enum-id: 9c17c40f667f186e
        parentId:
          type:
          - string
          - 'null'
          format: uuid
      required:
      - kind
      - name
    PatchedV2FolderUpdate:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        parentId:
          type:
          - string
          - 'null'
          format: uuid
    V2FolderTreeNode:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        kind:
          type: string
        depth:
          type: integer
        parentId:
          type:
          - string
          - 'null'
          format: uuid
        created:
          type: string
          format: date-time
        contentCount:
          type: integer
        children:
          type: array
          items:
            type: object
            additionalProperties: {}
      required:
      - children
      - contentCount
      - created
      - depth
      - id
      - kind
      - name
      - parentId
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"