diff --git a/.github/workflows/api.yaml b/.github/workflows/api.yaml index ea717e7edccb..0ca4399f9314 100644 --- a/.github/workflows/api.yaml +++ b/.github/workflows/api.yaml @@ -18,6 +18,7 @@ env: GALAXY_TEST_DBURI: 'postgresql://postgres:postgres@localhost:5432/galaxy?client_encoding=utf8' GALAXY_TEST_RAISE_EXCEPTION_ON_HISTORYLESS_HDA: '1' GALAXY_CONFIG_SQLALCHEMY_WARN_20: '1' + GALAXY_TEST_REQUIRE_ALL_NEEDED_TOOLS: '1' concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true @@ -55,15 +56,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/bioblend.yaml b/.github/workflows/bioblend.yaml new file mode 100644 index 000000000000..f0da9f2ed0e6 --- /dev/null +++ b/.github/workflows/bioblend.yaml @@ -0,0 +1,80 @@ +name: BioBlend Tests +on: + pull_request: + paths: + - .github/workflows/bioblend.yaml + - lib/galaxy/schema/** + - lib/galaxy/webapps/galaxy/api/** + - lib/galaxy/webapps/galaxy/services/** + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true +jobs: + test: + runs-on: ubuntu-latest + services: + postgres: + image: postgres + # Provide the password for postgres + env: + POSTGRES_PASSWORD: postgres + # Set health checks to wait until postgres has started + options: >- + --health-cmd pg_isready + --health-interval 10s + --health-timeout 5s + --health-retries 5 + ports: + - 5432:5432 + strategy: + fail-fast: false + matrix: + tox_env: [py313] + galaxy_python_version: ["3.8"] + steps: + - name: Checkout Galaxy + uses: actions/checkout@v4 + with: + fetch-depth: 1 + path: galaxy + - name: Checkout Bioblend + uses: actions/checkout@v4 + with: + repository: galaxyproject/bioblend + path: bioblend + - name: Cache pip dir + uses: actions/cache@v4 + with: + path: ~/.cache/pip + key: pip-cache-${{ matrix.tox_env }} + - name: Calculate Python version for BioBlend from tox_env + id: get_bioblend_python_version + run: echo "bioblend_python_version=$(echo "${{ matrix.tox_env }}" | sed -e 's/^py\([3-9]\)\([0-9]\+\)/\1.\2/')" >> $GITHUB_OUTPUT + - name: Set up Python for BioBlend + uses: actions/setup-python@v5 + with: + python-version: ${{ steps.get_bioblend_python_version.outputs.bioblend_python_version }} + - name: Install tox + run: | + python3 -m pip install --upgrade pip setuptools + python3 -m pip install 'tox>=1.8.0' + - name: Set up Python for Galaxy + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.galaxy_python_version }} + - name: Run tests + env: + PGPASSWORD: postgres + PGPORT: 5432 + PGHOST: localhost + run: | + # Create a PostgreSQL database for Galaxy. The default SQLite3 database makes test fail randomly because of "database locked" error. + createdb -U postgres galaxy + export DATABASE_CONNECTION=postgresql://postgres:@localhost/galaxy + ./bioblend/run_bioblend_tests.sh -g galaxy -v python${{ matrix.galaxy_python_version }} -e ${{ matrix.tox_env }} + - name: The job has failed + if: ${{ failure() }} + run: | + cat galaxy/*.log diff --git a/.github/workflows/build_container_image.yaml b/.github/workflows/build_container_image.yaml index 53a4a285a73d..dbff3546e9ae 100644 --- a/.github/workflows/build_container_image.yaml +++ b/.github/workflows/build_container_image.yaml @@ -10,8 +10,67 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: + ghcrbuild: + name: Build container image for GHCR + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + # https://stackoverflow.com/questions/59810838/how-to-get-the-short-sha-for-the-github-workflow + - name: Set outputs + id: commit + run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT + - name: Set branch name + id: branch + run: | + if [[ "$GITHUB_REF" == "refs/tags/"* ]]; then + echo "name=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT + elif [[ "$GITHUB_REF" == "refs/heads/dev" ]]; then + echo "name=dev" >> $GITHUB_OUTPUT + elif [[ "$GITHUB_REF" == "refs/heads/release_"* ]]; then + echo "name=${GITHUB_REF#refs/heads/release_}-auto" >> $GITHUB_OUTPUT + fi + shell: bash + - name: Extract metadata for container image + id: meta + uses: docker/metadata-action@v4 + with: + images: ghcr.io/${{ github.repository }} + tags: | + type=raw,value=${{steps.branch.outputs.name}} + - name: Build args + id: buildargs + run: | + echo "gitcommit=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT + echo "builddate=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + with: + platforms: linux/amd64 + + - name: Login to GHCR + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build and push container image to ghcr + uses: docker/build-push-action@v4 + with: + build-args: | + GIT_COMMIT=${{ steps.buildargs.outputs.gitcommit }} + BUILD_DATE=${{ steps.buildargs.outputs.builddate }} + IMAGE_TAG=${{ steps.branch.outputs.name }} + file: .k8s_ci.Dockerfile + push: true + context: . + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + platforms: linux/amd64 + build: - name: Build container image + name: Build container image for Galaxy repos runs-on: ubuntu-latest if: github.repository_owner == 'galaxyproject' steps: @@ -58,3 +117,4 @@ jobs: uses: actions-hub/docker@master with: args: push galaxy/galaxy-min:${{ steps.branch.outputs.name }} + diff --git a/.github/workflows/check_test_class_names.yaml b/.github/workflows/check_test_class_names.yaml index b2e4ac3a8d78..33bf31877177 100644 --- a/.github/workflows/check_test_class_names.yaml +++ b/.github/workflows/check_test_class_names.yaml @@ -20,11 +20,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('requirements.txt') }} + cache: 'pip' + cache-dependency-path: 'requirements.txt' - name: Install Python dependencies run: pip install -r requirements.txt -r lib/galaxy/dependencies/dev-requirements.txt - name: Run tests diff --git a/.github/workflows/converter_tests.yaml b/.github/workflows/converter_tests.yaml index 23848f81c014..b953699e6048 100644 --- a/.github/workflows/converter_tests.yaml +++ b/.github/workflows/converter_tests.yaml @@ -44,12 +44,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Cache venv dir - uses: actions/cache@v4 - id: pip-cache - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Move test data run: rsync -av --remove-source-files --exclude .git galaxy-test-data/ 'galaxy root/test-data/' - name: Install planemo diff --git a/.github/workflows/cwl_conformance.yaml b/.github/workflows/cwl_conformance.yaml index fc696787fe11..10fb215bf042 100644 --- a/.github/workflows/cwl_conformance.yaml +++ b/.github/workflows/cwl_conformance.yaml @@ -48,15 +48,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/db_indexes.yaml b/.github/workflows/db_indexes.yaml index cc5ec407b5d4..5141cfc04baa 100644 --- a/.github/workflows/db_indexes.yaml +++ b/.github/workflows/db_indexes.yaml @@ -45,16 +45,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - id: pip-cache - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache tox env uses: actions/cache@v4 with: diff --git a/.github/workflows/dependencies.yaml b/.github/workflows/dependencies.yaml index 9b319d1954e1..2401107eb325 100644 --- a/.github/workflows/dependencies.yaml +++ b/.github/workflows/dependencies.yaml @@ -8,18 +8,17 @@ jobs: name: Update dependencies if: github.repository_owner == 'galaxyproject' runs-on: ubuntu-latest - strategy: - matrix: - python-version: ['3.8'] steps: - uses: actions/checkout@v4 + # Install Python 3.8 for update_lint_requirements.sh + # Install Python 3.9 (as default) to allow `uv lock` to generate metadata for rucio-clients - uses: actions/setup-python@v5 with: - python-version: ${{ matrix.python-version }} + python-version: | + 3.8 + 3.9 - name: Update dependencies - run: | - python -m venv .venv - make update-dependencies + run: make update-dependencies - name: Create pull request uses: peter-evans/create-pull-request@v6 with: diff --git a/.github/workflows/deployment.yaml b/.github/workflows/deployment.yaml index eeb1e865baba..281b60beb071 100644 --- a/.github/workflows/deployment.yaml +++ b/.github/workflows/deployment.yaml @@ -37,11 +37,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('requirements.txt') }} + cache: 'pip' + cache-dependency-path: 'requirements.txt' - uses: nanasess/setup-chromedriver@v2 - name: Run tests run: bash ./test/deployment/usegalaxystar.bash diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 77a01f531907..0758dfb522a1 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -32,11 +32,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('requirements.txt') }} + cache: 'pip' + cache-dependency-path: 'requirements.txt' - name: Install Python dependencies run: pip install -r requirements.txt -r lib/galaxy/dependencies/dev-requirements.txt sphinxcontrib-simpleversioning - name: Add Google Analytics to doc/source/conf.py diff --git a/.github/workflows/first_startup.yaml b/.github/workflows/first_startup.yaml index bc487ab9ec32..05efc45367b9 100644 --- a/.github/workflows/first_startup.yaml +++ b/.github/workflows/first_startup.yaml @@ -23,7 +23,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] defaults: run: shell: bash -l {0} @@ -40,16 +40,12 @@ jobs: uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - id: pip-cache - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache tox env uses: actions/cache@v4 with: diff --git a/.github/workflows/framework_tools.yaml b/.github/workflows/framework_tools.yaml index a06f6e469aad..a55dfa316488 100644 --- a/.github/workflows/framework_tools.yaml +++ b/.github/workflows/framework_tools.yaml @@ -51,15 +51,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/framework_workflows.yaml b/.github/workflows/framework_workflows.yaml index accbbd4c3736..018463833e22 100644 --- a/.github/workflows/framework_workflows.yaml +++ b/.github/workflows/framework_workflows.yaml @@ -16,6 +16,7 @@ on: env: GALAXY_TEST_DBURI: 'postgresql://postgres:postgres@localhost:5432/galaxy?client_encoding=utf8' GALAXY_TEST_RAISE_EXCEPTION_ON_HISTORYLESS_HDA: '1' + GALAXY_TEST_WORKFLOW_AFTER_RERUN: '1' concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true @@ -51,15 +52,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml index 0dc78ef4bb1c..872cdef6c69d 100644 --- a/.github/workflows/integration.yaml +++ b/.github/workflows/integration.yaml @@ -25,7 +25,7 @@ concurrency: jobs: test: name: Test - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 strategy: fail-fast: false matrix: @@ -76,16 +76,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - id: pip-cache - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/integration_selenium.yaml b/.github/workflows/integration_selenium.yaml index 414446b5d827..311fb16a96f0 100644 --- a/.github/workflows/integration_selenium.yaml +++ b/.github/workflows/integration_selenium.yaml @@ -54,15 +54,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index fc03fde8c3a9..37d337fb95fe 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -22,7 +22,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] env: LINT_PATH: 'lib/galaxy/dependencies/pinned-lint-requirements.txt' TYPE_PATH: 'lib/galaxy/dependencies/pinned-typecheck-requirements.txt' @@ -32,15 +32,15 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: | + ${{ env.LINT_PATH }} + ${{ env.TYPE_PATH }} + ${{ env.CORE_PATH }} - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles(env.LINT_PATH, env.TYPE_PATH, env.CORE_PATH) }} - name: Cache tox env uses: actions/cache@v4 with: @@ -55,4 +55,6 @@ jobs: - name: Run mypy checks run: tox -e mypy - uses: psf/black@stable + with: + version: "24.8.0" # last version supporting Python 3.8 - uses: isort/isort-action@v1 diff --git a/.github/workflows/lint_openapi_schema.yml b/.github/workflows/lint_openapi_schema.yml index 4269db840770..4dc692fc2739 100644 --- a/.github/workflows/lint_openapi_schema.yml +++ b/.github/workflows/lint_openapi_schema.yml @@ -20,28 +20,25 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] steps: - uses: actions/checkout@v4 with: path: 'galaxy root' - - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.python-version }} - uses: actions/setup-node@v4 with: node-version: '18.12.1' cache: 'yarn' cache-dependency-path: 'galaxy root/client/yarn.lock' + - uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/maintenance_bot.yaml b/.github/workflows/maintenance_bot.yaml index 71d37d9518e7..b45dd2b87c7a 100644 --- a/.github/workflows/maintenance_bot.yaml +++ b/.github/workflows/maintenance_bot.yaml @@ -12,7 +12,7 @@ jobs: pull-requests: write runs-on: ubuntu-latest env: - MILESTONE_NUMBER: 28 + MILESTONE_NUMBER: 29 steps: - name: Get latest pull request labels id: get_pr_labels diff --git a/.github/workflows/mulled.yaml b/.github/workflows/mulled.yaml index 4d33cc3febd7..4d654af6ddbb 100644 --- a/.github/workflows/mulled.yaml +++ b/.github/workflows/mulled.yaml @@ -28,15 +28,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache tox env uses: actions/cache@v4 with: diff --git a/.github/workflows/osx_startup.yaml b/.github/workflows/osx_startup.yaml index 0a3050cbcb6b..13960eb8e85f 100644 --- a/.github/workflows/osx_startup.yaml +++ b/.github/workflows/osx_startup.yaml @@ -21,7 +21,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] defaults: run: shell: bash -l {0} @@ -34,24 +34,15 @@ jobs: node-version: '18.12.1' cache: 'yarn' cache-dependency-path: 'galaxy root/client/yarn.lock' - - name: Get full Python version - id: full-python-version - shell: bash - run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - name: Cache pip dir uses: actions/cache@v4 - id: pip-cache with: path: ~/Library/Caches/pip key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - - name: Cache tox env - uses: actions/cache@v4 - with: - path: .tox - key: tox-cache-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('galaxy root/requirements.txt') }}-osx - - name: Install miniconda # use this job to test using Python from a conda environment + - name: Install miniforge # use this job to test using Python from a conda environment uses: conda-incubator/setup-miniconda@v3 with: + miniforge-version: latest activate-environment: '' - name: Restore client cache uses: actions/cache@v4 diff --git a/.github/workflows/performance.yaml b/.github/workflows/performance.yaml index 45413a608f19..ab4063c51f7d 100644 --- a/.github/workflows/performance.yaml +++ b/.github/workflows/performance.yaml @@ -50,15 +50,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/pr-title-update.yml b/.github/workflows/pr-title-update.yml new file mode 100644 index 000000000000..6a4c5021f63d --- /dev/null +++ b/.github/workflows/pr-title-update.yml @@ -0,0 +1,27 @@ +name: Update PR title + +on: + pull_request_target: + types: [opened, edited] + branches: + - "release_**" + +jobs: + update-title: + runs-on: ubuntu-latest + permissions: + pull-requests: write + steps: + - uses: actions/checkout@v4 + - name: Update PR title + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PR_NUMBER: ${{ github.event.pull_request.number }} + TARGET_BRANCH: "${{ github.base_ref }}" + PR_TITLE: "${{ github.event.pull_request.title }}" + run: | + VERSION=$(echo $TARGET_BRANCH | grep -oP '\d+\.\d+') + if [[ -n "$VERSION" && ! "$PR_TITLE" =~ ^\[$VERSION\] ]]; then + NEW_TITLE="[$VERSION] $PR_TITLE" + gh pr edit $PR_NUMBER --title "$NEW_TITLE" + fi diff --git a/.github/workflows/reports_startup.yaml b/.github/workflows/reports_startup.yaml index d2a730549837..b7449dc5979c 100644 --- a/.github/workflows/reports_startup.yaml +++ b/.github/workflows/reports_startup.yaml @@ -18,7 +18,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] defaults: run: shell: bash -l {0} @@ -35,16 +35,12 @@ jobs: uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - id: pip-cache - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/selenium.yaml b/.github/workflows/selenium.yaml index 3c3d9126cbb5..195eb02b3de0 100644 --- a/.github/workflows/selenium.yaml +++ b/.github/workflows/selenium.yaml @@ -59,15 +59,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/test_galaxy_packages.yaml b/.github/workflows/test_galaxy_packages.yaml index da5e092118dc..f38f05846e74 100644 --- a/.github/workflows/test_galaxy_packages.yaml +++ b/.github/workflows/test_galaxy_packages.yaml @@ -18,7 +18,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] steps: - uses: actions/checkout@v4 with: @@ -31,11 +31,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Install ffmpeg run: sudo apt-get update && sudo apt-get -y install ffmpeg - name: Install tox diff --git a/.github/workflows/test_galaxy_packages_for_pulsar.yaml b/.github/workflows/test_galaxy_packages_for_pulsar.yaml index 3ce8c2f3bece..5f54f7fd31ad 100644 --- a/.github/workflows/test_galaxy_packages_for_pulsar.yaml +++ b/.github/workflows/test_galaxy_packages_for_pulsar.yaml @@ -16,7 +16,7 @@ concurrency: jobs: test: name: Test - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 # Python 3.7 is not available via setup-python on ubuntu >=24.04 strategy: fail-fast: false matrix: @@ -28,11 +28,8 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Install Apptainer's singularity uses: eWaterCycle/setup-apptainer@v2 - name: Install ffmpeg diff --git a/.github/workflows/toolshed.yaml b/.github/workflows/toolshed.yaml index df121215d9f1..14be278e16bc 100644 --- a/.github/workflows/toolshed.yaml +++ b/.github/workflows/toolshed.yaml @@ -21,7 +21,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] shed-api: ['v1', 'v2'] test-install-client: ['galaxy_api', 'standalone'] services: @@ -45,16 +45,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - id: pip-cache - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/unit-postgres.yaml b/.github/workflows/unit-postgres.yaml index dbb9b21587c7..92ee7795854c 100644 --- a/.github/workflows/unit-postgres.yaml +++ b/.github/workflows/unit-postgres.yaml @@ -44,15 +44,12 @@ jobs: - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache galaxy venv uses: actions/cache@v4 with: diff --git a/.github/workflows/unit.yaml b/.github/workflows/unit.yaml index 33b2857ddeee..671dcac0162d 100644 --- a/.github/workflows/unit.yaml +++ b/.github/workflows/unit.yaml @@ -20,28 +20,25 @@ jobs: strategy: fail-fast: false matrix: - python-version: ['3.8', '3.12'] + python-version: ['3.8', '3.13'] steps: - uses: actions/checkout@v4 with: path: 'galaxy root' - - uses: actions/setup-python@v5 - with: - python-version: ${{ matrix.python-version }} - uses: actions/setup-node@v4 with: node-version: '18.12.1' cache: 'yarn' cache-dependency-path: 'galaxy root/client/yarn.lock' + - uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'galaxy root/requirements.txt' - name: Get full Python version id: full-python-version shell: bash run: echo "version=$(python -c 'import sys; print("-".join(str(v) for v in sys.version_info))')" >> $GITHUB_OUTPUT - - name: Cache pip dir - uses: actions/cache@v4 - with: - path: ~/.cache/pip - key: pip-cache-${{ matrix.python-version }}-${{ hashFiles('galaxy root/requirements.txt') }} - name: Cache tox env uses: actions/cache@v4 with: diff --git a/Makefile b/Makefile index e53f65370ceb..64d649ebf188 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ VENV?=.venv # Source virtualenv to execute command (darker, sphinx, twine, etc...) IN_VENV=if [ -f "$(VENV)/bin/activate" ]; then . "$(VENV)/bin/activate"; fi; -RELEASE_CURR:=24.2 +RELEASE_CURR:=25.0 RELEASE_UPSTREAM:=upstream CONFIG_MANAGE=$(IN_VENV) python lib/galaxy/config/config_manage.py PROJECT_URL?=https://github.com/galaxyproject/galaxy @@ -186,6 +186,9 @@ else $(IN_VENV) cd client && yarn install $(YARN_INSTALL_OPTS) endif +format-xsd: + xmllint --format --output galaxy-tmp.xsd lib/galaxy/tool_util/xsd/galaxy.xsd + mv galaxy-tmp.xsd lib/galaxy/tool_util/xsd/galaxy.xsd build-api-schema: $(IN_VENV) python scripts/dump_openapi_schema.py _schema.yaml @@ -196,8 +199,8 @@ remove-api-schema: rm _shed_schema.yaml update-client-api-schema: client-node-deps build-api-schema - $(IN_VENV) cd client && node openapi_to_schema.mjs ../_schema.yaml > src/api/schema/schema.ts && npx prettier --write src/api/schema/schema.ts - $(IN_VENV) cd client && node openapi_to_schema.mjs ../_shed_schema.yaml > ../lib/tool_shed/webapp/frontend/src/schema/schema.ts && npx prettier --write ../lib/tool_shed/webapp/frontend/src/schema/schema.ts + $(IN_VENV) cd client && npx openapi-typescript ../_schema.yaml > src/api/schema/schema.ts && npx prettier --write src/api/schema/schema.ts + $(IN_VENV) cd client && npx openapi-typescript ../_shed_schema.yaml > ../lib/tool_shed/webapp/frontend/src/schema/schema.ts && npx prettier --write ../lib/tool_shed/webapp/frontend/src/schema/schema.ts $(MAKE) remove-api-schema lint-api-schema: build-api-schema diff --git a/README.rst b/README.rst index 17e11d9ff098..6c4fb522c003 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,7 @@ Community support is available at `Galaxy Help Galaxy Quickstart ================= -Galaxy requires Python 3.8 . To check your Python version, run: +Galaxy requires Python 3.8 or higher. To check your Python version, run: .. code:: console diff --git a/SECURITY.md b/SECURITY.md index c1dcb56f30e9..22f1b73cc79b 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -40,7 +40,7 @@ These are only examples. The security team will provide a severity classificatio ## Notification of Vulnerabilities -For high severity issues, we will notify [the list of public Galaxy owners](https://lists.galaxyproject.org/listinfo/galaxy-public-servers) with: +For high severity issues, we will notify [the list of public Galaxy owners](https://lists.galaxyproject.org/lists/galaxy-public-servers.lists.galaxyproject.org/) with: - A description of the issue - List of supported versions that are affected diff --git a/client/docs/querying-the-api.md b/client/docs/querying-the-api.md index 63dc48b873ea..40360e44aea1 100644 --- a/client/docs/querying-the-api.md +++ b/client/docs/querying-the-api.md @@ -24,44 +24,105 @@ If there is no Composable for the API endpoint you are using, try using a (Pinia ### Direct API Calls -- If the type of data you are querying should not be cached, or you just need to update or create new data, you can use the API directly. Make sure to use the **Fetcher** (see below) instead of Axios, as it provides a type-safe interface to the API along with some extra benefits. +- If the type of data you are querying should not be cached, or you just need to update or create new data, you can use the API directly. Make sure to use the **GalaxyApi client** (see below) instead of Axios, as it provides a type-safe interface to the API along with some extra benefits. -## 2. Prefer Fetcher over Axios (when possible) +## 2. Prefer **GalaxyApi client** over Axios (when possible) -- **Use Fetcher with OpenAPI Specs**: If there is an OpenAPI spec for the API endpoint you are using (in other words, there is a FastAPI route defined in Galaxy), always use the Fetcher. It will provide you with a type-safe interface to the API. +- **Use **GalaxyApi client** with OpenAPI Specs**: If there is an OpenAPI spec for the API endpoint you are using (in other words, there is a FastAPI route defined in Galaxy), always use the GalaxyApi client. It will provide you with a type-safe interface to the API. **Do** -```typescript -import { fetcher } from "@/api/schema"; -const datasetsFetcher = fetcher.path("/api/dataset/{id}").method("get").create(); +```ts +import { ref, onMounted } from "vue"; -const { data: dataset } = await datasetsFetcher({ id: "testID" }); +import { GalaxyApi, type HDADetailed } from "@/api"; +import { errorMessageAsString } from "@/utils/simple-error"; + +interface Props { + datasetId: string; +} + +const props = defineProps(); + +const datasetDetails = ref(); +const errorMessage = ref(); + +async function loadDatasetDetails() { + // Your IDE will provide you with autocompletion for the route and all the parameters + const { data, error } = await GalaxyApi().GET("/api/datasets/{dataset_id}", { + params: { + path: { + dataset_id: props.datasetId, + }, + query: { view: "detailed" }, + }, + }); + + if (error) { + // Handle error here. For example, you can display a message to the user. + errorMessage.value = errorMessageAsString(error); + // Make sure to return here, otherwise `data` will be undefined + return; + } + + // Use `data` here. We are casting it to HDADetailed to help the type inference because + // we requested the "detailed" view and this endpoint returns different types depending + // on the view. In general, the correct type will be inferred automatically using the + // API schema so you don't need to (and shouldn't) cast it. + datasetDetails.value = data as HDADetailed; +} + +onMounted(() => { + loadDatasetDetails(); +}); ``` **Don't** -```js +```ts +import { ref, onMounted } from "vue"; + import axios from "axios"; import { getAppRoot } from "onload/loadConfig"; -import { rethrowSimple } from "utils/simple-error"; +import { errorMessageAsString } from "@/utils/simple-error"; + +interface Props { + datasetId: string; +} + +const props = defineProps(); + +const datasetDetails = ref(); +const errorMessage = ref(); -async getDataset(datasetId) { +async function loadDatasetDetails() { + // You need to construct the URL yourself const url = `${getAppRoot()}api/datasets/${datasetId}`; + // You are forced to use a try-catch block to handle errors + // and you may forget to do so. try { - const response = await axios.get(url); - return response.data; + // This is not type-safe and cannot detect changes in the API schema. + const response = await axios.get(url, { + // You need to know the API parameters, no type inference here. + params: { view: "detailed" }, + }); + // In this case, you need to cast the response to the correct type + // (as in the previous example), but you will also have to do it in the general + // case because there is no type inference. + datasetDetails = response.data as HDADetailed; } catch (e) { - rethrowSimple(e); + errorMessage.value = errorMessageAsString(error); } } -const dataset = await getDataset("testID"); +onMounted(() => { + loadDatasetDetails(); +}); ``` > **Reason** > -> The `fetcher` class provides a type-safe interface to the API, and is already configured to use the correct base URL and error handling. +> The `GalaxyApi client` function provides a type-safe interface to the API, and is already configured to use the correct base URL. In addition, it will force you to handle errors properly, and will provide you with a type-safe response object. It uses `openapi-fetch` and you can find more information about it [here](https://openapi-ts.dev/openapi-fetch/). ## 3. Where to put your API queries? @@ -79,8 +140,8 @@ If so, you should consider putting the query in a Store. If not, you should cons If so, you should consider putting it under src/api/.ts and exporting it from there. This will allow you to reuse the query in multiple places specially if you need to do some extra processing of the data. Also it will help to keep track of what parts of the API are being used and where. -### Should I use the `fetcher` directly or should I write a wrapper function? +### Should I use the `GalaxyApi client` directly or should I write a wrapper function? -- If you **don't need to do any extra processing** of the data, you can use the `fetcher` directly. -- If you **need to do some extra processing**, you should consider writing a wrapper function. Extra processing can be anything from transforming the data to adding extra parameters to the query or omitting some of them, handling conditional types in response data, etc. -- Using a **wrapper function** will help in case we decide to replace the `fetcher` with something else in the future (as we are doing now with _Axios_). +- If you **don't need to do any additional processing** of the data, you **should** use the `GalaxyApi client` directly. +- If you **need to do some additional processing**, then consider writing a wrapper function. Additional processing can be anything from transforming the data to adding extra parameters to the query, providing useful defaults, handling conditional types in response data, etc. +- In any case, please try to avoid modeling your own types if you can use the ones defined in the OpenAPI spec (client/src/api/schema/schema.ts). This will help to keep the codebase consistent and avoid duplication of types or API specification drifting. diff --git a/client/docs/unit-testing/writing-tests.md b/client/docs/unit-testing/writing-tests.md index 9a49db6c510a..830f8f27c9f9 100644 --- a/client/docs/unit-testing/writing-tests.md +++ b/client/docs/unit-testing/writing-tests.md @@ -67,3 +67,50 @@ describe("some module you wrote", () => { We have created some [common helpers for common testing scenarios](https://github.com/galaxyproject/galaxy/blob/dev/client/tests/jest/helpers.js). + +### Mocking API calls + +When testing components that make API calls, you should use [**Mock Service Worker**](https://mswjs.io/docs/getting-started/) in combination with [**openapi-msw**](https://github.com/christoph-fricke/openapi-msw?tab=readme-ov-file#openapi-msw). + +If you want to know more about why MSW is a good choice for mocking API calls, you can read [this article](https://mswjs.io/docs/philosophy). + +If your component makes an API call, for example to get a particular history, you can mock the response of the API call using the `useServerMock` composable in your test file. + +```ts +import { useServerMock } from "@/api/client/__mocks__"; + +const { server, http } = useServerMock(); + +describe("MyComponent", () => { + it("should do something with the history", async () => { + // Mock the response of the API call + server.use( + http.get("/api/histories/{history_id}", ({ params, query, response }) => { + // You can use logic to return different responses based on the request + if (query.get("view") === "detailed") { + return response(200).json(TEST_HISTORY_DETAILED); + } + + // Or simulate an error + if (params.history_id === "must-fail") { + return response("5XX").json(EXPECTED_500_ERROR, { status: 500 }); + } + + return response(200).json(TEST_HISTORY_SUMMARY); + }) + ); + + // Your test code here + }); +}); +``` + +Using this approach, it will ensure the type safety of the API calls and the responses. If you need to mock API calls that are not defined in the OpenAPI specs, you can use the `http.untyped` variant to mock any API route. Or define an untyped response for a specific route with `HttpResponse`. See the example below: + +```ts +const catchAll = http.untyped.all("/resource/*", ({ params }) => { + return HttpResponse.json(/* ... */); +}); +``` + +For more information on how to use `openapi-msw`, you can check the [official documentation](https://github.com/christoph-fricke/openapi-msw?tab=readme-ov-file#handling-unknown-paths). diff --git a/client/gulpfile.js b/client/gulpfile.js index 873bae0c0bd8..06d918958288 100644 --- a/client/gulpfile.js +++ b/client/gulpfile.js @@ -1,10 +1,11 @@ const path = require("path"); -const fs = require("fs"); +const fs = require("fs-extra"); const del = require("del"); const { src, dest, series, parallel, watch } = require("gulp"); const child_process = require("child_process"); const { globSync } = require("glob"); const buildIcons = require("./icons/build_icons"); +const xml2js = require("xml2js"); /* * We'll want a flexible glob down the road, but for now there are no @@ -14,34 +15,44 @@ const buildIcons = require("./icons/build_icons"); const STATIC_PLUGIN_BUILD_IDS = [ "annotate_image", "chiraviz", - "cytoscape", "drawrna", "editor", "example", + "fits_graph_viewer", "fits_image_viewer", - "h5web", - "heatmap/heatmap_default", "hyphyvision", "jqplot/jqplot_bar", "media_player", - "msa", "mvpapp", - "ngl", "nora", "nvd3/nvd3_bar", - "openlayers", "openseadragon", "PCA_3Dplot", - "phylocanvas", "pv", "scatterplot", "tiffviewer", "ts_visjs", - "venn", ]; +const INSTALL_PLUGIN_BUILD_IDS = [ + "cytoscape", + "h5web", + "heatmap", + "ngl", + "msa", + "openlayers", + "phylocanvas", + "plotly", + "venn", + "vizarr", +]; // todo: derive from XML const DIST_PLUGIN_BUILD_IDS = ["new_user"]; const PLUGIN_BUILD_IDS = Array.prototype.concat(DIST_PLUGIN_BUILD_IDS, STATIC_PLUGIN_BUILD_IDS); +const failOnError = + process.env.GALAXY_PLUGIN_BUILD_FAIL_ON_ERROR && process.env.GALAXY_PLUGIN_BUILD_FAIL_ON_ERROR !== "0" + ? true + : false; + const PATHS = { nodeModules: "./node_modules", stagedLibraries: { @@ -57,11 +68,6 @@ const PATHS = { }, }; -const failOnError = - process.env.GALAXY_PLUGIN_BUILD_FAIL_ON_ERROR && process.env.GALAXY_PLUGIN_BUILD_FAIL_ON_ERROR !== "0" - ? true - : false; - PATHS.pluginBaseDir = (process.env.GALAXY_PLUGIN_PATH && process.env.GALAXY_PLUGIN_PATH !== "None" ? process.env.GALAXY_PLUGIN_PATH @@ -162,6 +168,8 @@ function buildPlugins(callback, forceRebuild) { console.log(`No changes detected for ${pluginName}`); } else { console.log(`Installing Dependencies for ${pluginName}`); + + // Else we call yarn install and yarn build child_process.spawnSync( "yarn", ["install", "--production=false", "--network-timeout=300000", "--check-files"], @@ -205,6 +213,64 @@ function buildPlugins(callback, forceRebuild) { return callback(); } +async function installPlugins(callback) { + // iterate through install_plugin_build_ids, identify xml files and install dependencies + for (const plugin_name of INSTALL_PLUGIN_BUILD_IDS) { + const pluginDir = path.join(PATHS.pluginBaseDir, `visualizations/${plugin_name}`); + const xmlPath = path.join(pluginDir, `config/${plugin_name}.xml`); + // Check if the file exists + if (fs.existsSync(xmlPath)) { + await installDependenciesFromXML(xmlPath, pluginDir); + } else { + console.error(`XML file not found: ${xmlPath}`); + } + } + return callback(); +} + +// Function to parse the XML and install dependencies +async function installDependenciesFromXML(xmlPath, pluginDir) { + try { + const pluginXML = fs.readFileSync(xmlPath); + const parsedXML = await xml2js.parseStringPromise(pluginXML); + const requirements = parsedXML.visualization.requirements[0].requirement; + + const installPromises = requirements.map(async (dep) => { + const { type: reqType, package: pkgName, version } = dep.$; + + if (reqType === "npm" && pkgName && version) { + try { + const installResult = child_process.spawnSync( + "npm", + ["install", "--silent", "--no-save", "--prefix .", `${pkgName}@${version}`], + { + cwd: pluginDir, + stdio: "inherit", + shell: true, + } + ); + + if (installResult.status === 0) { + await fs.copy( + path.join(pluginDir, "node_modules", pkgName, "static"), + path.join(pluginDir, "static") + ); + console.log(`Installed package ${pkgName}@${version} in ${pluginDir}`); + } else { + console.error(`Error installing package ${pkgName}@${version} in ${pluginDir}`); + } + } catch (err) { + console.error(`Error handling package ${pkgName}@${version} in ${pluginDir}:`, err); + } + } + }); + + await Promise.all(installPromises); + } catch (err) { + console.error(`Error processing XML file ${xmlPath}:`, err); + } +} + function forceBuildPlugins(callback) { return buildPlugins(callback, true); } @@ -214,8 +280,8 @@ function cleanPlugins() { } const client = parallel(fonts, stageLibs, icons); -const plugins = series(buildPlugins, cleanPlugins, stagePlugins); -const pluginsRebuild = series(forceBuildPlugins, cleanPlugins, stagePlugins); +const plugins = series(buildPlugins, installPlugins, cleanPlugins, stagePlugins); +const pluginsRebuild = series(forceBuildPlugins, installPlugins, cleanPlugins, stagePlugins); function watchPlugins() { const BUILD_PLUGIN_WATCH_GLOB = [ @@ -229,3 +295,4 @@ module.exports.plugins = plugins; module.exports.pluginsRebuild = pluginsRebuild; module.exports.watchPlugins = watchPlugins; module.exports.default = parallel(client, plugins); +module.exports.installPlugins = installPlugins; diff --git a/client/openapi_to_schema.mjs b/client/openapi_to_schema.mjs deleted file mode 100644 index d85b349f096d..000000000000 --- a/client/openapi_to_schema.mjs +++ /dev/null @@ -1,21 +0,0 @@ -// this is a helper script that fixes const values -// upstream fix in https://github.com/drwpow/openapi-typescript/pull/1014 -import openapiTS from "openapi-typescript"; - -const inputFilePath = process.argv[2]; - -const localPath = new URL(inputFilePath, import.meta.url); -openapiTS(localPath, { - transform(schemaObject, metadata) { - if ("const" in schemaObject) { - const constType = typeof schemaObject.const; - switch (constType) { - case "number": - case "boolean": - return `${schemaObject.const}`; - default: - return `"${schemaObject.const}"`; - } - } - }, -}).then((output) => console.log(output)); diff --git a/client/package.json b/client/package.json index c7f55bab3f68..b2a751ff3d94 100644 --- a/client/package.json +++ b/client/package.json @@ -62,6 +62,7 @@ "dom-to-image": "^2.6.0", "dompurify": "^3.0.6", "dumpmeta-webpack-plugin": "^0.2.0", + "echarts": "^5.5.1", "elkjs": "^0.8.2", "file-saver": "^2.0.5", "flush-promises": "^1.0.2", @@ -81,8 +82,7 @@ "markdown-it": "^13.0.2", "markdown-it-regexp": "^0.4.0", "object-hash": "^3.0.0", - "openapi-typescript": "^6.7.6", - "openapi-typescript-fetch": "^1.1.3", + "openapi-fetch": "^0.10.6", "pinia": "^2.1.7", "popper.js": "^1.16.1", "pretty-bytes": "^6.1.1", @@ -101,7 +101,11 @@ "tus-js-client": "^3.1.1", "underscore": "^1.13.6", "util": "^0.12.5", + "vega": "^5.30.0", + "vega-embed": "^6.26.0", + "vega-lite": "^5.21.0", "vue": "^2.7.14", + "vue-echarts": "^7.0.3", "vue-infinite-scroll": "^2.0.2", "vue-multiselect": "^2.1.7", "vue-observe-visibility": "^1.0.0", @@ -172,15 +176,21 @@ "eslint-plugin-vue": "^9.17.0", "eslint-plugin-vuejs-accessibility": "^2.2.0", "expose-loader": "^4.1.0", + "fake-indexeddb": "^6.0.0", + "fs-extra": "^11.2.0", "gulp": "^4.0.2", "ignore-loader": "^0.1.2", "imports-loader": "^4.0.1", "jest": "^29.7.0", "jest-environment-jsdom": "^29.7.0", + "jest-fixed-jsdom": "^0.0.2", "jest-location-mock": "^2.0.0", "jsdom-worker": "^0.3.0", "json-loader": "^0.5.7", "mini-css-extract-plugin": "^2.7.6", + "msw": "^2.3.4", + "openapi-msw": "^0.7.0", + "openapi-typescript": "^7.3.0", "postcss-loader": "^7.3.3", "prettier": "^2.8.8", "process": "^0.11.10", @@ -200,6 +210,7 @@ "webpack-dev-server": "^4.15.1", "webpack-merge": "^5.10.0", "xml-js": "^1.6.11", + "xml2js": "^0.6.2", "yaml-jest": "^1.2.0", "yaml-loader": "^0.8.0" }, diff --git a/client/src/api/client/__mocks__/index.ts b/client/src/api/client/__mocks__/index.ts new file mode 100644 index 000000000000..573116ce03b3 --- /dev/null +++ b/client/src/api/client/__mocks__/index.ts @@ -0,0 +1,68 @@ +import { HttpResponse } from "msw"; +import { setupServer } from "msw/node"; +import { createOpenApiHttp } from "openapi-msw"; + +import { type GalaxyApiPaths } from "@/api/schema"; + +export { HttpResponse }; + +function createApiClientMock() { + return createOpenApiHttp({ baseUrl: window.location.origin }); +} + +let http: ReturnType; +let server: ReturnType; + +/** + * Returns a `server` instance that can be used to mock the Galaxy API server + * and make requests to the Galaxy API using the OpenAPI schema. + * + * It is an instance of Mock Service Worker (MSW) server (https://github.com/mswjs/msw). + * And the `http` object is an instance of OpenAPI-MSW (https://github.com/christoph-fricke/openapi-msw) + * that add support for full type inference from OpenAPI schema definitions. + */ +export function useServerMock() { + if (!server) { + server = setupServer(); + http = createApiClientMock(); + } + + beforeAll(() => { + // Enable API mocking before all the tests. + server.listen({ + onUnhandledRequest: (request) => { + const method = request.method.toLowerCase(); + const apiPath = request.url.replace(window.location.origin, ""); + const errorMessage = ` +No request handler found for ${request.method} ${request.url}. + +Make sure you have added a request handler for this request in your tests. + +Example: + +const { server, http } = useServerMock(); +server.use( + http.${method}('${apiPath}', ({ response }) => { + return response(200).json({}); + }) +); + `; + throw new Error(errorMessage); + }, + }); + }); + + afterEach(() => { + // Reset the request handlers between each test. + // This way the handlers we add on a per-test basis + // do not leak to other, irrelevant tests. + server.resetHandlers(); + }); + + afterAll(() => { + // Finally, disable API mocking after the tests are done. + server.close(); + }); + + return { server, http }; +} diff --git a/client/src/api/client/index.ts b/client/src/api/client/index.ts new file mode 100644 index 000000000000..3de48773d64b --- /dev/null +++ b/client/src/api/client/index.ts @@ -0,0 +1,32 @@ +import createClient from "openapi-fetch"; + +import { type GalaxyApiPaths } from "@/api/schema"; +import { getAppRoot } from "@/onload/loadConfig"; + +function getBaseUrl() { + const isTest = process.env.NODE_ENV === "test"; + return isTest ? window.location.origin : getAppRoot(undefined, true); +} + +function apiClientFactory() { + return createClient({ baseUrl: getBaseUrl() }); +} + +export type GalaxyApiClient = ReturnType; + +let client: GalaxyApiClient; + +/** + * Returns the Galaxy API client. + * + * It can be used to make requests to the Galaxy API using the OpenAPI schema. + * + * See: https://openapi-ts.dev/openapi-fetch/ + */ +export function GalaxyApi(): GalaxyApiClient { + if (!client) { + client = apiClientFactory(); + } + + return client; +} diff --git a/client/src/api/client/serverMock.test.ts b/client/src/api/client/serverMock.test.ts new file mode 100644 index 000000000000..e65b65b60f1a --- /dev/null +++ b/client/src/api/client/serverMock.test.ts @@ -0,0 +1,107 @@ +import { type HistoryDetailed, type HistorySummary, type MessageException } from "@/api"; +import { GalaxyApi } from "@/api"; +import { useServerMock } from "@/api/client/__mocks__"; + +const TEST_HISTORY_SUMMARY: HistorySummary = { + model_class: "History", + id: "test", + name: "Test History", + archived: false, + deleted: false, + purged: false, + published: false, + update_time: "2021-09-01T00:00:00", + count: 0, + annotation: "Test History Annotation", + tags: [], + url: "/api/histories/test", +}; + +const TEST_HISTORY_DETAILED: HistoryDetailed = { + ...TEST_HISTORY_SUMMARY, + create_time: "2021-09-01T00:00:00", + contents_url: "/api/histories/test/contents", + importable: false, + slug: "testSlug", + size: 0, + user_id: "userID", + username_and_slug: "username/slug", + state: "ok", + empty: true, + hid_counter: 0, + genome_build: null, + state_ids: {}, + state_details: {}, +}; + +const EXPECTED_500_ERROR: MessageException = { err_code: 500, err_msg: "Internal Server Error" }; + +// Mock the server responses +const { server, http } = useServerMock(); +server.use( + http.get("/api/histories/{history_id}", ({ params, query, response }) => { + if (query.get("view") === "detailed") { + return response(200).json(TEST_HISTORY_DETAILED); + } + if (params.history_id === "must-fail") { + return response("5XX").json(EXPECTED_500_ERROR, { status: 500 }); + } + return response(200).json(TEST_HISTORY_SUMMARY); + }) +); + +describe("useServerMock", () => { + it("mocks the Galaxy Server", async () => { + { + const { data, error } = await GalaxyApi().GET("/api/histories/{history_id}", { + params: { + path: { history_id: "test" }, + query: { view: "summary" }, + }, + }); + + expect(error).toBeUndefined(); + + expect(data).toBeDefined(); + expect(data).toEqual(TEST_HISTORY_SUMMARY); + } + + { + const { data, error } = await GalaxyApi().GET("/api/histories/{history_id}", { + params: { + path: { history_id: "test" }, + query: { view: "detailed" }, + }, + }); + + expect(error).toBeUndefined(); + + expect(data).toBeDefined(); + expect(data).toEqual(TEST_HISTORY_DETAILED); + } + + { + const { data, error } = await GalaxyApi().GET("/api/histories/{history_id}", { + params: { + path: { history_id: "must-fail" }, + }, + }); + + expect(error).toBeDefined(); + expect(error).toEqual(EXPECTED_500_ERROR); + + expect(data).toBeUndefined(); + } + + { + const { data, error } = await GalaxyApi().GET("/api/configuration"); + + expect(data).toBeUndefined(); + + expect(error).toBeDefined(); + expect(`${JSON.stringify(error)}`).toContain( + "Make sure you have added a request handler for this request in your tests." + ); + } + }); +}); diff --git a/client/src/api/configTemplates.ts b/client/src/api/configTemplates.ts index b3060169b736..ec987c7eb3a7 100644 --- a/client/src/api/configTemplates.ts +++ b/client/src/api/configTemplates.ts @@ -1,4 +1,6 @@ -import { type components } from "@/api/schema/schema"; +import { type components } from "@/api/schema"; + +export type CreateInstancePayload = components["schemas"]["CreateInstancePayload"]; export type Instance = | components["schemas"]["UserFileSourceModel"] @@ -10,13 +12,18 @@ export type TemplateVariable = | components["schemas"]["TemplateVariablePathComponent"] | components["schemas"]["TemplateVariableBoolean"]; export type TemplateSecret = components["schemas"]["TemplateSecret"]; -export type VariableValueType = string | boolean | number; -export type VariableData = { [key: string]: VariableValueType }; -export type SecretData = { [key: string]: string }; +export type VariableData = CreateInstancePayload["variables"]; +export type VariableValueType = VariableData[keyof VariableData]; +export type SecretData = CreateInstancePayload["secrets"]; export type PluginAspectStatus = components["schemas"]["PluginAspectStatus"]; export type PluginStatus = components["schemas"]["PluginStatus"]; +export type UpgradeInstancePayload = components["schemas"]["UpgradeInstancePayload"]; +export type TestUpgradeInstancePayload = components["schemas"]["TestUpgradeInstancePayload"]; +export type UpdateInstancePayload = components["schemas"]["UpdateInstancePayload"]; +export type TestUpdateInstancePayload = components["schemas"]["TestUpdateInstancePayload"]; + export interface TemplateSummary { description: string | null; hidden?: boolean; diff --git a/client/src/api/datasetCollections.ts b/client/src/api/datasetCollections.ts index bc788a35f030..f659ec4982c4 100644 --- a/client/src/api/datasetCollections.ts +++ b/client/src/api/datasetCollections.ts @@ -1,16 +1,20 @@ -import { type CollectionEntry, type DCESummary, type HDCADetailed, type HDCASummary, isHDCA } from "@/api"; -import { fetcher } from "@/api/schema"; +import { type CollectionEntry, type DCESummary, GalaxyApi, type HDCADetailed, type HDCASummary, isHDCA } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; const DEFAULT_LIMIT = 50; -const getCollectionDetails = fetcher.path("/api/dataset_collections/{id}").method("get").create(); - /** * Fetches the details of a collection. * @param params.id The ID of the collection (HDCA) to fetch. */ export async function fetchCollectionDetails(params: { id: string }): Promise { - const { data } = await getCollectionDetails({ id: params.id }); + const { data, error } = await GalaxyApi().GET("/api/dataset_collections/{id}", { + params: { path: params }, + }); + + if (error) { + rethrowSimple(error); + } return data as HDCADetailed; } @@ -19,15 +23,19 @@ export async function fetchCollectionDetails(params: { id: string }): Promise { - const { data } = await getCollectionDetails({ id: params.id, view: "collection" }); + const { data, error } = await GalaxyApi().GET("/api/dataset_collections/{id}", { + params: { + path: params, + query: { view: "collection" }, + }, + }); + + if (error) { + rethrowSimple(error); + } return data as HDCASummary; } -const getCollectionContents = fetcher - .path("/api/dataset_collections/{hdca_id}/contents/{parent_id}") - .method("get") - .create(); - export async function fetchCollectionElements(params: { /** The ID of the top level HDCA that associates this collection with the History it belongs to. */ hdcaId: string; @@ -38,13 +46,16 @@ export async function fetchCollectionElements(params: { /** The maximum number of elements to fetch. */ limit?: number; }): Promise { - const { data } = await getCollectionContents({ - instance_type: "history", - hdca_id: params.hdcaId, - parent_id: params.collectionId, - offset: params.offset, - limit: params.limit, + const { data, error } = await GalaxyApi().GET("/api/dataset_collections/{hdca_id}/contents/{parent_id}", { + params: { + path: { hdca_id: params.hdcaId, parent_id: params.collectionId }, + query: { instance_type: "history", offset: params.offset, limit: params.limit }, + }, }); + + if (error) { + rethrowSimple(error); + } return data; } @@ -65,13 +76,3 @@ export async function fetchElementsFromCollection(params: { limit: params.limit ?? DEFAULT_LIMIT, }); } - -export const fetchCollectionAttributes = fetcher - .path("/api/dataset_collections/{id}/attributes") - .method("get") - .create(); - -const postCopyCollection = fetcher.path("/api/dataset_collections/{id}/copy").method("post").create(); -export async function copyCollection(id: string, dbkey: string): Promise { - await postCopyCollection({ id, dbkey }); -} diff --git a/client/src/api/datasets.ts b/client/src/api/datasets.ts index c6f4e8a9465a..6b8f0606537c 100644 --- a/client/src/api/datasets.ts +++ b/client/src/api/datasets.ts @@ -1,86 +1,80 @@ import axios from "axios"; -import { type FetchArgType } from "openapi-typescript-fetch"; -import { type HDADetailed } from "@/api"; -import { type components, fetcher } from "@/api/schema"; +import { type components, GalaxyApi, type GalaxyApiPaths, type HDADetailed } from "@/api"; import { withPrefix } from "@/utils/redirect"; +import { rethrowSimple } from "@/utils/simple-error"; -export const datasetsFetcher = fetcher.path("/api/datasets").method("get").create(); - -type GetDatasetsApiOptions = FetchArgType; -type GetDatasetsQuery = Pick; -// custom interface for how we use getDatasets -interface GetDatasetsOptions extends GetDatasetsQuery { - sortBy?: string; - sortDesc?: boolean; - query?: string; -} +export async function fetchDatasetDetails(params: { id: string }): Promise { + const { data, error } = await GalaxyApi().GET("/api/datasets/{dataset_id}", { + params: { + path: { + dataset_id: params.id, + }, + query: { view: "detailed" }, + }, + }); -/** Datasets request helper **/ -export async function getDatasets(options: GetDatasetsOptions = {}) { - const params: GetDatasetsApiOptions = {}; - if (options.sortBy) { - const sortPrefix = options.sortDesc ? "-dsc" : "-asc"; - params.order = `${options.sortBy}${sortPrefix}`; - } - if (options.limit) { - params.limit = options.limit; - } - if (options.offset) { - params.offset = options.offset; + if (error) { + rethrowSimple(error); } - if (options.query) { - params.q = ["name-contains"]; - params.qv = [options.query]; - } - const { data } = await datasetsFetcher(params); - return data; -} - -export const fetchDataset = fetcher.path("/api/datasets/{dataset_id}").method("get").create(); - -export const fetchDatasetStorage = fetcher.path("/api/datasets/{dataset_id}/storage").method("get").create(); - -export async function fetchDatasetDetails(params: { id: string }): Promise { - const { data } = await fetchDataset({ dataset_id: params.id, view: "detailed" }); - // We know that the server will return a DatasetDetails object because of the view parameter - // but the type system doesn't, so we have to cast it. - return data as unknown as HDADetailed; + return data as HDADetailed; } -const updateDataset = fetcher.path("/api/datasets/{dataset_id}").method("put").create(); - export async function undeleteDataset(datasetId: string) { - const { data } = await updateDataset({ - dataset_id: datasetId, - type: "dataset", - deleted: false, + const { data, error } = await GalaxyApi().PUT("/api/datasets/{dataset_id}", { + params: { + path: { dataset_id: datasetId }, + }, + body: { + deleted: false, + }, }); + if (error) { + rethrowSimple(error); + } return data; } -const deleteDataset = fetcher.path("/api/datasets/{dataset_id}").method("delete").create(); - export async function purgeDataset(datasetId: string) { - const { data } = await deleteDataset({ dataset_id: datasetId, purge: true }); + const { data, error } = await GalaxyApi().DELETE("/api/datasets/{dataset_id}", { + params: { + path: { dataset_id: datasetId }, + query: { purge: true }, + }, + }); + if (error) { + rethrowSimple(error); + } return data; } -const datasetCopy = fetcher.path("/api/histories/{history_id}/contents/{type}s").method("post").create(); -type HistoryContentsArgs = FetchArgType; +type CopyDatasetParamsType = GalaxyApiPaths["/api/histories/{history_id}/contents/{type}s"]["post"]["parameters"]; +type CopyDatasetBodyType = components["schemas"]["CreateHistoryContentPayload"]; + export async function copyDataset( - datasetId: HistoryContentsArgs["content"], - historyId: HistoryContentsArgs["history_id"], - type: HistoryContentsArgs["type"] = "dataset", - source: HistoryContentsArgs["source"] = "hda" + datasetId: CopyDatasetBodyType["content"], + historyId: CopyDatasetParamsType["path"]["history_id"], + type: CopyDatasetParamsType["path"]["type"] = "dataset", + source: CopyDatasetBodyType["source"] = "hda" ) { - const response = await datasetCopy({ - history_id: historyId, - type, - source: source, - content: datasetId, + const { data, error } = await GalaxyApi().POST("/api/histories/{history_id}/contents/{type}s", { + params: { + path: { history_id: historyId, type }, + }, + body: { + source, + content: datasetId, + // TODO: Investigate. These should be optional, but the API requires explicit null values? + type, + copy_elements: null, + hide_source_items: null, + instance_type: null, + }, }); - return response.data; + if (error) { + rethrowSimple(error); + } + return data; } export function getCompositeDatasetLink(historyDatasetId: string, path: string) { @@ -88,10 +82,12 @@ export function getCompositeDatasetLink(historyDatasetId: string, path: string) } export type DatasetExtraFiles = components["schemas"]["DatasetExtraFiles"]; -export const fetchDatasetExtraFiles = fetcher.path("/api/datasets/{dataset_id}/extra_files").method("get").create(); export async function fetchDatasetAttributes(datasetId: string) { const { data } = await axios.get(withPrefix(`/dataset/get_edit?dataset_id=${datasetId}`)); return data; } + +export type HistoryContentType = components["schemas"]["HistoryContentType"]; +export type HistoryContentSource = components["schemas"]["HistoryContentSource"]; diff --git a/client/src/api/datatypes.ts b/client/src/api/datatypes.ts deleted file mode 100644 index fde4da5b529b..000000000000 --- a/client/src/api/datatypes.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { fetcher } from "@/api/schema"; - -export const datatypesFetcher = fetcher.path("/api/datatypes").method("get").create(); - -export const edamFormatsFetcher = fetcher.path("/api/datatypes/edam_formats/detailed").method("get").create(); -export const edamDataFetcher = fetcher.path("/api/datatypes/edam_data/detailed").method("get").create(); - -const typesAndMappingsFetcher = fetcher.path("/api/datatypes/types_and_mapping").method("get").create(); - -export async function fetchDatatypesAndMappings(upload_only = true) { - const { data } = await typesAndMappingsFetcher({ upload_only }); - return data; -} diff --git a/client/src/api/dbKeys.ts b/client/src/api/dbKeys.ts index ec1525137883..9becc5f4af5c 100644 --- a/client/src/api/dbKeys.ts +++ b/client/src/api/dbKeys.ts @@ -3,6 +3,13 @@ * but now it is used to get the list of more generic "dbkeys". */ -import { fetcher } from "@/api/schema"; +import { GalaxyApi } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; -export const dbKeysFetcher = fetcher.path("/api/genomes").method("get").create(); +export async function getDbKeys() { + const { data, error } = await GalaxyApi().GET("/api/genomes"); + if (error) { + rethrowSimple(error); + } + return data; +} diff --git a/client/src/api/fileSources.ts b/client/src/api/fileSources.ts index 68935db4573f..eb984b938e8f 100644 --- a/client/src/api/fileSources.ts +++ b/client/src/api/fileSources.ts @@ -4,3 +4,4 @@ export type FileSourceTemplateSummary = components["schemas"]["FileSourceTemplat export type FileSourceTemplateSummaries = FileSourceTemplateSummary[]; export type UserFileSourceModel = components["schemas"]["UserFileSourceModel"]; +export type FileSourceTypes = UserFileSourceModel["type"]; diff --git a/client/src/api/forms.ts b/client/src/api/forms.ts deleted file mode 100644 index 04f19169d5a1..000000000000 --- a/client/src/api/forms.ts +++ /dev/null @@ -1,4 +0,0 @@ -import { fetcher } from "@/api/schema"; - -export const deleteForm = fetcher.path("/api/forms/{id}").method("delete").create(); -export const undeleteForm = fetcher.path("/api/forms/{id}/undelete").method("post").create(); diff --git a/client/src/api/groups.ts b/client/src/api/groups.ts deleted file mode 100644 index 6def92076885..000000000000 --- a/client/src/api/groups.ts +++ /dev/null @@ -1,13 +0,0 @@ -import axios from "axios"; - -import { type components, fetcher } from "@/api/schema"; - -type GroupModel = components["schemas"]["GroupModel"]; -export async function getAllGroups(): Promise { - const { data } = await axios.get("/api/groups"); - return data; -} - -export const deleteGroup = fetcher.path("/api/groups/{group_id}").method("delete").create(); -export const purgeGroup = fetcher.path("/api/groups/{group_id}/purge").method("post").create(); -export const undeleteGroup = fetcher.path("/api/groups/{group_id}/undelete").method("post").create(); diff --git a/client/src/api/histories.archived.ts b/client/src/api/histories.archived.ts index 9109c2d97e95..e580a94207ff 100644 --- a/client/src/api/histories.archived.ts +++ b/client/src/api/histories.archived.ts @@ -1,13 +1,13 @@ -import { type FetchArgType } from "openapi-typescript-fetch"; - -import { type components, fetcher } from "@/api/schema"; +import { type components, GalaxyApi, type GalaxyApiPaths } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; export type ArchivedHistorySummary = components["schemas"]["ArchivedHistorySummary"]; export type ArchivedHistoryDetailed = components["schemas"]["ArchivedHistoryDetailed"]; -export type AsyncTaskResultSummary = components["schemas"]["AsyncTaskResultSummary"]; +export type AnyArchivedHistory = ArchivedHistorySummary | ArchivedHistoryDetailed; -type GetArchivedHistoriesParams = FetchArgType; -type SerializationOptions = Pick; +type MaybeArchivedHistoriesQueryParams = GalaxyApiPaths["/api/histories/archived"]["get"]["parameters"]["query"]; +type ArchivedHistoriesQueryParams = Exclude; +type SerializationOptions = Pick; interface FilterOptions { query?: string; @@ -26,97 +26,44 @@ interface SortingOptions { interface GetArchivedHistoriesOptions extends FilterOptions, PaginationOptions, SortingOptions, SerializationOptions {} interface ArchivedHistoriesResult { - histories: ArchivedHistorySummary[] | ArchivedHistoryDetailed[]; + histories: AnyArchivedHistory[]; totalMatches: number; } const DEFAULT_PAGE_SIZE = 10; -const getArchivedHistories = fetcher.path("/api/histories/archived").method("get").create(); - /** * Get a list of archived histories. */ -export async function fetchArchivedHistories( - options: GetArchivedHistoriesOptions = {} -): Promise { +export async function fetchArchivedHistories(options: GetArchivedHistoriesOptions): Promise { const params = optionsToApiParams(options); - const { data, headers } = await getArchivedHistories(params); - const totalMatches = parseInt(headers.get("total_matches") ?? "0"); + + const { response, data, error } = await GalaxyApi().GET("/api/histories/archived", { + params: { + query: params, + }, + }); + + if (error) { + rethrowSimple(error); + } + + const totalMatches = parseInt(response.headers.get("total_matches") ?? "0"); if (params.view === "detailed") { return { histories: data as ArchivedHistoryDetailed[], totalMatches, }; } + return { histories: data as ArchivedHistorySummary[], totalMatches, }; } -const postArchiveHistory = fetcher.path("/api/histories/{history_id}/archive").method("post").create(); - -/** - * Archive a history. - * @param historyId The history to archive - * @param archiveExportId The optional archive export record to associate. This can be used to restore a snapshot copy of the history in the future. - * @param purgeHistory Whether to purge the history after archiving. Can only be used in combination with an archive export record. - * @returns The archived history summary. - */ -export async function archiveHistory( - historyId: string, - archiveExportId?: string, - purgeHistory?: boolean -): Promise { - const { data } = await postArchiveHistory({ - history_id: historyId, - archive_export_id: archiveExportId, - purge_history: purgeHistory, - }); - return data as ArchivedHistorySummary; -} - -const putUnarchiveHistory = fetcher - .path("/api/histories/{history_id}/archive/restore") - .method("put") - // @ts-ignore: workaround for optional query parameters in PUT. More info here https://github.com/ajaishankar/openapi-typescript-fetch/pull/55 - .create({ force: undefined }); - -/** - * Unarchive/restore a history. - * @param historyId The history to unarchive. - * @param force Whether to force un-archiving for purged histories. - * @returns The restored history summary. - */ -export async function unarchiveHistory(historyId: string, force?: boolean): Promise { - const { data } = await putUnarchiveHistory({ history_id: historyId, force }); - return data as ArchivedHistorySummary; -} - -const reimportHistoryFromStore = fetcher.path("/api/histories/from_store_async").method("post").create(); - -/** - * Reimport an archived history as a new copy from the associated export record. - * - * @param archivedHistory The archived history to reimport. It must have an associated export record. - * @returns The async task result summary to track the reimport progress. - */ -export async function reimportArchivedHistoryFromExportRecord( - archivedHistory: ArchivedHistorySummary -): Promise { - if (!archivedHistory.export_record_data) { - throw new Error("The archived history does not have an associated export record."); - } - const { data } = await reimportHistoryFromStore({ - model_store_format: archivedHistory.export_record_data.model_store_format, - store_content_uri: archivedHistory.export_record_data.target_uri, - }); - return data as AsyncTaskResultSummary; -} - -function optionsToApiParams(options: GetArchivedHistoriesOptions): GetArchivedHistoriesParams { - const params: GetArchivedHistoriesParams = {}; +function optionsToApiParams(options: GetArchivedHistoriesOptions): ArchivedHistoriesQueryParams { + const params: ArchivedHistoriesQueryParams = {}; if (options.query) { params.q = ["name-contains"]; params.qv = [options.query]; diff --git a/client/src/api/histories.export.ts b/client/src/api/histories.export.ts index 40d19f026077..19f54919b683 100644 --- a/client/src/api/histories.export.ts +++ b/client/src/api/histories.export.ts @@ -1,16 +1,7 @@ -import { type components, fetcher } from "@/api/schema"; -import { - type ExportRecord, - ExportRecordModel, - type ObjectExportTaskResponse, -} from "@/components/Common/models/exportRecordModel"; +import { GalaxyApi, type ModelStoreFormat, type ObjectExportTaskResponse } from "@/api"; +import { type ExportRecord, ExportRecordModel } from "@/components/Common/models/exportRecordModel"; import { DEFAULT_EXPORT_PARAMS } from "@/composables/shortTermStorage"; - -type ModelStoreFormat = components["schemas"]["ModelStoreFormat"]; - -const _getExportRecords = fetcher.path("/api/histories/{history_id}/exports").method("get").create(); -const _exportToFileSource = fetcher.path("/api/histories/{history_id}/write_store").method("post").create(); -const _importFromStoreAsync = fetcher.path("/api/histories/from_store_async").method("post").create(); +import { rethrowSimple } from "@/utils/simple-error"; /** * A list of objects with the available export formats IDs and display names. @@ -27,17 +18,20 @@ export const AVAILABLE_EXPORT_FORMATS: { id: ModelStoreFormat; name: string }[] * @returns a promise with a list of export records associated with the given history. */ export async function fetchHistoryExportRecords(historyId: string) { - const response = await _getExportRecords( - { - history_id: historyId, - }, - { - headers: { - Accept: "application/vnd.galaxy.task.export+json", + const { data, error } = await GalaxyApi().GET("/api/histories/{history_id}/exports", { + params: { + path: { history_id: historyId }, + header: { + accept: "application/vnd.galaxy.task.export+json", }, - } - ); - return response.data.map((item: unknown) => new ExportRecordModel(item as ObjectExportTaskResponse)); + }, + }); + + if (error) { + rethrowSimple(error); + } + + return data.map((item) => new ExportRecordModel(item as ObjectExportTaskResponse)); } /** @@ -46,7 +40,7 @@ export async function fetchHistoryExportRecords(historyId: string) { * @param exportDirectory the output directory in the file source * @param fileName the name of the output archive * @param exportParams additional parameters to configure the export - * @returns A promise with the request response + * @returns A promise with the async task response that can be used to track the export progress. */ export async function exportHistoryToFileSource( historyId: string, @@ -56,24 +50,42 @@ export async function exportHistoryToFileSource( ) { const exportDirectoryUri = `${exportDirectory}/${fileName}.${exportParams.modelStoreFormat}`; - return _exportToFileSource({ - history_id: historyId, - target_uri: exportDirectoryUri, - model_store_format: exportParams.modelStoreFormat as ModelStoreFormat, - include_files: exportParams.includeFiles, - include_deleted: exportParams.includeDeleted, - include_hidden: exportParams.includeHidden, + const { data, error } = await GalaxyApi().POST("/api/histories/{history_id}/write_store", { + params: { + path: { history_id: historyId }, + }, + body: { + target_uri: exportDirectoryUri, + model_store_format: exportParams.modelStoreFormat, + include_files: exportParams.includeFiles, + include_deleted: exportParams.includeDeleted, + include_hidden: exportParams.includeHidden, + }, }); + + if (error) { + rethrowSimple(error); + } + + return data; } /** * Imports a new history using the information stored in the given export record. * @param record The export record to be imported - * @returns A promise with the request response + * @returns A promise with the async task response that can be used to track the import progress. */ export async function reimportHistoryFromRecord(record: ExportRecord) { - return _importFromStoreAsync({ - store_content_uri: record.importUri, - model_store_format: record.modelStoreFormat, + const { data, error } = await GalaxyApi().POST("/api/histories/from_store_async", { + body: { + store_content_uri: record.importUri, + model_store_format: record.modelStoreFormat, + }, }); + + if (error) { + rethrowSimple(error); + } + + return data; } diff --git a/client/src/api/histories.ts b/client/src/api/histories.ts deleted file mode 100644 index ef0aeaa5df0b..000000000000 --- a/client/src/api/histories.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { fetcher } from "@/api/schema"; - -export const historiesFetcher = fetcher.path("/api/histories").method("get").create(); -export const archivedHistoriesFetcher = fetcher.path("/api/histories/archived").method("get").create(); -export const deleteHistory = fetcher.path("/api/histories/{history_id}").method("delete").create(); -export const deleteHistories = fetcher.path("/api/histories/batch/delete").method("put").create(); -export const undeleteHistory = fetcher.path("/api/histories/deleted/{history_id}/undelete").method("post").create(); -export const undeleteHistories = fetcher.path("/api/histories/batch/undelete").method("put").create(); -export const publishedHistoriesFetcher = fetcher.path("/api/histories/published").method("get").create(); -export const historyFetcher = fetcher.path("/api/histories/{history_id}").method("get").create(); -export const updateHistoryItemsInBulk = fetcher - .path("/api/histories/{history_id}/contents/bulk") - .method("put") - .create(); -export const sharing = fetcher.path("/api/histories/{history_id}/sharing").method("get").create(); -export const enableLink = fetcher.path("/api/histories/{history_id}/enable_link_access").method("put").create(); diff --git a/client/src/api/index.ts b/client/src/api/index.ts index 3f3c1c689144..6f9ce9d0213d 100644 --- a/client/src/api/index.ts +++ b/client/src/api/index.ts @@ -1,12 +1,22 @@ /** Contains type alias and definitions related to Galaxy API models. */ -import { type components } from "@/api/schema"; +import { GalaxyApi } from "@/api/client"; +import { type components, type GalaxyApiPaths } from "@/api/schema"; + +export { type components, GalaxyApi, type GalaxyApiPaths }; /** * Contains minimal information about a History. */ export type HistorySummary = components["schemas"]["HistorySummary"]; +/** + * Represents the possible values for the `sort_by` parameter when querying histories. + * We can not extract this from the schema for an unknown reason. + * The desired solution would be: `GalaxyApiPaths["/api/histories"]["get"]["parameters"]["query"]["sort_by"]`. + */ +export type HistorySortByLiteral = "create_time" | "name" | "update_time" | "username" | undefined; + /** * Contains minimal information about a History with additional content stats. * This is a subset of information that can be relatively frequently updated after @@ -128,6 +138,14 @@ export interface DCECollection extends DCESummary { object: DCObject; } +/** + * DatasetCollectionElement specific type for datasets. + */ +export interface DCEDataset extends DCESummary { + element_type: "hda"; + object: HDAObject; +} + /** * Contains summary information about a HDCA (HistoryDatasetCollectionAssociation). * @@ -148,6 +166,8 @@ export type HDCADetailed = components["schemas"]["HDCADetailed"]; */ export type DCObject = components["schemas"]["DCObject"]; +export type HDAObject = components["schemas"]["HDAObject"]; + export type DatasetCollectionAttributes = components["schemas"]["DatasetCollectionAttributesResult"]; export type ConcreteObjectStoreModel = components["schemas"]["ConcreteObjectStoreModel"]; @@ -180,6 +200,10 @@ export function isHDCA(entry?: CollectionEntry): entry is HDCASummary { ); } +export function isDCE(item: object): item is DCESummary { + return item && "element_type" in item; +} + /** * Returns true if the given element of a collection is a DatasetCollection. */ @@ -187,6 +211,13 @@ export function isCollectionElement(element: DCESummary): element is DCECollecti return element.element_type === "dataset_collection"; } +/** + * Returns true if the given element of a collection is a Dataset. + */ +export function isDatasetElement(element: DCESummary): element is DCEDataset { + return element.element_type === "hda"; +} + /** * Returns true if the given dataset entry is an instance of DatasetDetails. */ @@ -269,3 +300,16 @@ export type DatasetTransform = { action: "to_posix_lines" | "spaces_to_tabs" | "datatype_groom"; datatype_ext: "bam" | "qname_sorted.bam" | "qname_input_sorted.bam" | "isa-tab" | "isa-json"; }; + +/** + * Base type for all exceptions returned by the API. + */ +export type MessageException = components["schemas"]["MessageExceptionModel"]; + +export type StoreExportPayload = components["schemas"]["StoreExportPayload"]; +export type ModelStoreFormat = components["schemas"]["ModelStoreFormat"]; +export type ObjectExportTaskResponse = components["schemas"]["ObjectExportTaskResponse"]; +export type ExportObjectRequestMetadata = components["schemas"]["ExportObjectRequestMetadata"]; +export type ExportObjectResultMetadata = components["schemas"]["ExportObjectResultMetadata"]; + +export type AsyncTaskResultSummary = components["schemas"]["AsyncTaskResultSummary"]; diff --git a/client/src/api/invocations.ts b/client/src/api/invocations.ts index 22a7c7854c0d..935fa7463bff 100644 --- a/client/src/api/invocations.ts +++ b/client/src/api/invocations.ts @@ -1,65 +1,14 @@ -import axios from "axios"; - -import { getAppRoot } from "@/onload"; - -import { type ApiResponse, type components, fetcher } from "./schema"; +import { type components } from "./schema"; export type WorkflowInvocationElementView = components["schemas"]["WorkflowInvocationElementView"]; export type WorkflowInvocationCollectionView = components["schemas"]["WorkflowInvocationCollectionView"]; export type InvocationJobsSummary = components["schemas"]["InvocationJobsResponse"]; export type InvocationStep = components["schemas"]["InvocationStep"]; +export type InvocationMessage = components["schemas"]["InvocationMessageResponseUnion"]; export type StepJobSummary = | components["schemas"]["InvocationStepJobsResponseStepModel"] | components["schemas"]["InvocationStepJobsResponseJobModel"] | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"]; -export const invocationsFetcher = fetcher.path("/api/invocations").method("get").create(); - -export const stepJobsSummaryFetcher = fetcher - .path("/api/invocations/{invocation_id}/step_jobs_summary") - .method("get") - .create(); - -export type WorkflowInvocation = WorkflowInvocationElementView | WorkflowInvocationCollectionView; - -export interface WorkflowInvocationJobsSummary { - id: string; -} - -export interface WorkflowInvocationStep { - id: string; -} - -export async function invocationForJob(params: { jobId: string }): Promise { - const { data } = await axios.get(`${getAppRoot()}api/invocations?job_id=${params.jobId}`); - if (data.length > 0) { - return data[0] as WorkflowInvocation; - } else { - return null; - } -} - -// TODO: Replace these provisional functions with fetchers after https://github.com/galaxyproject/galaxy/pull/16707 is merged -export async function fetchInvocationDetails(params: { id: string }): Promise> { - const { data } = await axios.get(`${getAppRoot()}api/invocations/${params.id}`); - return { - data, - } as ApiResponse; -} - -export async function fetchInvocationJobsSummary(params: { - id: string; -}): Promise> { - const { data } = await axios.get(`${getAppRoot()}api/invocations/${params.id}/jobs_summary`); - return { - data, - } as ApiResponse; -} - -export async function fetchInvocationStep(params: { id: string }): Promise> { - const { data } = await axios.get(`${getAppRoot()}api/invocations/steps/${params.id}`); - return { - data, - } as ApiResponse; -} +export type WorkflowInvocation = components["schemas"]["WorkflowInvocationResponse"]; diff --git a/client/src/api/jobs.ts b/client/src/api/jobs.ts index ccc4023e9e66..31e9801ddfdd 100644 --- a/client/src/api/jobs.ts +++ b/client/src/api/jobs.ts @@ -1,21 +1,9 @@ -import { type components, fetcher } from "@/api/schema"; +import { type components } from "@/api/schema"; export type JobDestinationParams = components["schemas"]["JobDestinationParams"]; - -export const getJobDetails = fetcher.path("/api/jobs/{job_id}").method("get").create(); - -export const jobLockStatus = fetcher.path("/api/job_lock").method("get").create(); -export const jobLockUpdate = fetcher.path("/api/job_lock").method("put").create(); - -export const fetchJobDestinationParams = fetcher.path("/api/jobs/{job_id}/destination_params").method("get").create(); - -export const jobsFetcher = fetcher.path("/api/jobs").method("get").create(); - export type ShowFullJobResponse = components["schemas"]["ShowFullJobResponse"]; +export type JobBaseModel = components["schemas"]["JobBaseModel"]; export type JobDetails = components["schemas"]["ShowFullJobResponse"] | components["schemas"]["EncodedJobDetails"]; -export const fetchJobDetails = fetcher.path("/api/jobs/{job_id}").method("get").create(); - export type JobInputSummary = components["schemas"]["JobInputSummary"]; -export const fetchJobCommonProblems = fetcher.path("/api/jobs/{job_id}/common_problems").method("get").create(); - -export const postJobErrorReport = fetcher.path("/api/jobs/{job_id}/error").method("post").create(); +export type JobDisplayParametersSummary = components["schemas"]["JobDisplayParametersSummary"]; +export type JobMetric = components["schemas"]["JobMetric"]; diff --git a/client/src/api/landings.ts b/client/src/api/landings.ts new file mode 100644 index 000000000000..03bbfc01d840 --- /dev/null +++ b/client/src/api/landings.ts @@ -0,0 +1,4 @@ +import { type components } from "@/api/schema"; + +export type ClaimLandingPayload = components["schemas"]["ClaimLandingPayload"]; +export type WorkflowLandingRequest = components["schemas"]["WorkflowLandingRequest"]; diff --git a/client/src/api/notifications.broadcast.ts b/client/src/api/notifications.broadcast.ts index cbea28ada102..170de0619443 100644 --- a/client/src/api/notifications.broadcast.ts +++ b/client/src/api/notifications.broadcast.ts @@ -1,29 +1,43 @@ -import { type components, fetcher } from "@/api/schema"; +import { GalaxyApi, type GalaxyApiPaths } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; -type BroadcastNotificationResponse = components["schemas"]["BroadcastNotificationResponse"]; +// TODO: Move these functions to broadcastStore and refactor other calls to go through the store -const broadcastFetcher = fetcher.path("/api/notifications/broadcast/{notification_id}").method("get").create(); -export async function fetchBroadcast(id: string): Promise { - const { data } = await broadcastFetcher({ notification_id: id }); +export async function fetchAllBroadcasts() { + const { data, error } = await GalaxyApi().GET("/api/notifications/broadcast"); + if (error) { + rethrowSimple(error); + } return data; } -const broadcastsFetcher = fetcher.path("/api/notifications/broadcast").method("get").create(); -export async function fetchAllBroadcasts(): Promise { - const { data } = await broadcastsFetcher({}); - return data; -} +type CreateBroadcastNotificationRequestBody = + GalaxyApiPaths["/api/notifications/broadcast"]["post"]["requestBody"]["content"]["application/json"]; +export async function createBroadcast(broadcast: CreateBroadcastNotificationRequestBody) { + const { data, error } = await GalaxyApi().POST("/api/notifications/broadcast", { + body: broadcast, + }); + + if (error) { + rethrowSimple(error); + } -const postBroadcast = fetcher.path("/api/notifications/broadcast").method("post").create(); -type BroadcastNotificationCreateRequest = components["schemas"]["BroadcastNotificationCreateRequest"]; -export async function createBroadcast(broadcast: BroadcastNotificationCreateRequest) { - const { data } = await postBroadcast(broadcast); return data; } -const putBroadcast = fetcher.path("/api/notifications/broadcast/{notification_id}").method("put").create(); -type NotificationBroadcastUpdateRequest = components["schemas"]["NotificationBroadcastUpdateRequest"]; -export async function updateBroadcast(id: string, broadcast: NotificationBroadcastUpdateRequest) { - const { data } = await putBroadcast({ notification_id: id, ...broadcast }); +type UpdateBroadcastNotificationRequestBody = + GalaxyApiPaths["/api/notifications/broadcast/{notification_id}"]["put"]["requestBody"]["content"]["application/json"]; +export async function updateBroadcast(id: string, broadcast: UpdateBroadcastNotificationRequestBody) { + const { data, error } = await GalaxyApi().PUT("/api/notifications/broadcast/{notification_id}", { + params: { + path: { notification_id: id }, + }, + body: broadcast, + }); + + if (error) { + rethrowSimple(error); + } + return data; } diff --git a/client/src/api/notifications.preferences.ts b/client/src/api/notifications.preferences.ts deleted file mode 100644 index 8509d7cd2691..000000000000 --- a/client/src/api/notifications.preferences.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { type components, fetcher } from "@/api/schema"; - -type UserNotificationPreferences = components["schemas"]["UserNotificationPreferences"]; - -export interface UserNotificationPreferencesExtended extends UserNotificationPreferences { - supportedChannels: string[]; -} - -const getNotificationsPreferences = fetcher.path("/api/notifications/preferences").method("get").create(); -export async function getNotificationsPreferencesFromServer(): Promise { - const { data, headers } = await getNotificationsPreferences({}); - return { - ...data, - supportedChannels: headers.get("supported-channels")?.split(",") ?? [], - }; -} - -type UpdateUserNotificationPreferencesRequest = components["schemas"]["UpdateUserNotificationPreferencesRequest"]; -const updateNotificationsPreferences = fetcher.path("/api/notifications/preferences").method("put").create(); -export async function updateNotificationsPreferencesOnServer(request: UpdateUserNotificationPreferencesRequest) { - const { data } = await updateNotificationsPreferences(request); - return data; -} diff --git a/client/src/api/notifications.ts b/client/src/api/notifications.ts index b5724618e3a5..ea35af9e3582 100644 --- a/client/src/api/notifications.ts +++ b/client/src/api/notifications.ts @@ -1,6 +1,9 @@ -import { type components, fetcher } from "@/api/schema"; +import { type components } from "@/api/schema"; export type BaseUserNotification = components["schemas"]["UserNotificationResponse"]; +export type UserNotificationPreferences = components["schemas"]["UserNotificationPreferences"]["preferences"]; +export type NotificationChannel = keyof components["schemas"]["NotificationChannelSettings"]; +export type NotificationCategory = components["schemas"]["PersonalNotificationCategory"]; export interface MessageNotification extends BaseUserNotification { category: "message"; @@ -12,61 +15,26 @@ export interface SharedItemNotification extends BaseUserNotification { content: components["schemas"]["NewSharedItemNotificationContent"]; } -export type UserNotification = MessageNotification | SharedItemNotification; - -export type NotificationChanges = components["schemas"]["UserNotificationUpdateRequest"]; - -export type UserNotificationsBatchUpdateRequest = components["schemas"]["UserNotificationsBatchUpdateRequest"]; - -export type NotificationVariants = components["schemas"]["NotificationVariant"]; - -export type NewSharedItemNotificationContentItemType = - components["schemas"]["NewSharedItemNotificationContent"]["item_type"]; - -type UserNotificationUpdateRequest = components["schemas"]["UserNotificationUpdateRequest"]; - -export type NotificationCreateRequest = components["schemas"]["NotificationCreateRequest"]; - -type NotificationResponse = components["schemas"]["NotificationResponse"]; +type NotificationCreateData = components["schemas"]["NotificationCreateData"]; -const getNotification = fetcher.path("/api/notifications/{notification_id}").method("get").create(); - -export async function loadNotification(id: string): Promise { - const { data } = await getNotification({ notification_id: id }); - return data; -} - -const postNotification = fetcher.path("/api/notifications").method("post").create(); - -export async function sendNotification(notification: NotificationCreateRequest) { - const { data } = await postNotification(notification); - return data; +export interface MessageNotificationCreateData extends NotificationCreateData { + category: "message"; + content: components["schemas"]["MessageNotificationContent"]; } -const putNotification = fetcher.path("/api/notifications/{notification_id}").method("put").create(); +export type NotificationCreateRequest = components["schemas"]["NotificationCreateRequest"]; -export async function updateNotification(id: string, notification: UserNotificationUpdateRequest) { - const { data } = await putNotification({ notification_id: id, ...notification }); - return data; +export interface MessageNotificationCreateRequest extends NotificationCreateRequest { + notification: MessageNotificationCreateData; } -const getNotifications = fetcher.path("/api/notifications").method("get").create(); - -export async function loadNotificationsFromServer(): Promise { - const { data } = await getNotifications({}); - return data as UserNotification[]; -} +export type UserNotification = MessageNotification | SharedItemNotification; -const putBatchNotifications = fetcher.path("/api/notifications").method("put").create(); +export type NotificationChanges = components["schemas"]["UserNotificationUpdateRequest"]; -export async function updateBatchNotificationsOnServer(request: UserNotificationsBatchUpdateRequest) { - const { data } = await putBatchNotifications(request); - return data; -} +export type UserNotificationsBatchUpdateRequest = components["schemas"]["UserNotificationsBatchUpdateRequest"]; -const getNotificationStatus = fetcher.path("/api/notifications/status").method("get").create(); +export type NotificationVariants = components["schemas"]["NotificationVariant"]; -export async function loadNotificationsStatus(since: Date) { - const { data } = await getNotificationStatus({ since: since.toISOString().replace("Z", "") }); - return data; -} +export type NewSharedItemNotificationContentItemType = + components["schemas"]["NewSharedItemNotificationContent"]["item_type"]; diff --git a/client/src/api/objectStores.templates.ts b/client/src/api/objectStores.templates.ts new file mode 100644 index 000000000000..0bc65dde204a --- /dev/null +++ b/client/src/api/objectStores.templates.ts @@ -0,0 +1,4 @@ +import type { components } from "@/api/schema"; + +export type ObjectStoreTemplateSummary = components["schemas"]["ObjectStoreTemplateSummary"]; +export type ObjectStoreTemplateSummaries = ObjectStoreTemplateSummary[]; diff --git a/client/src/api/objectStores.ts b/client/src/api/objectStores.ts index 8380b03e3086..376d75d8e54a 100644 --- a/client/src/api/objectStores.ts +++ b/client/src/api/objectStores.ts @@ -1,37 +1,57 @@ -import { fetcher } from "@/api/schema"; -import { type components } from "@/api/schema/schema"; +import { type components, GalaxyApi } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; export type UserConcreteObjectStore = components["schemas"]["UserConcreteObjectStoreModel"]; -export type ObjectStoreTemplateType = "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; - -const getObjectStores = fetcher.path("/api/object_stores").method("get").create(); +export type ObjectStoreTemplateType = components["schemas"]["UserConcreteObjectStoreModel"]["type"]; export async function getSelectableObjectStores() { - const { data } = await getObjectStores({ selectable: true }); + const { data, error } = await GalaxyApi().GET("/api/object_stores", { + params: { + query: { selectable: true }, + }, + }); + + if (error) { + rethrowSimple(error); + } + return data; } -const getObjectStore = fetcher.path("/api/object_stores/{object_store_id}").method("get").create(); -const getUserObjectStoreInstance = fetcher - .path("/api/object_store_instances/{user_object_store_id}") - .method("get") - .create(); - export async function getObjectStoreDetails(id: string) { if (id.startsWith("user_objects://")) { const userObjectStoreId = id.substring("user_objects://".length); - const { data } = await getUserObjectStoreInstance({ user_object_store_id: userObjectStoreId }); + + const { data, error } = await GalaxyApi().GET("/api/object_store_instances/{uuid}", { + params: { path: { uuid: userObjectStoreId } }, + }); + + if (error) { + rethrowSimple(error); + } + return data; } else { - const { data } = await getObjectStore({ object_store_id: id }); + const { data, error } = await GalaxyApi().GET("/api/object_stores/{object_store_id}", { + params: { path: { object_store_id: id } }, + }); + + if (error) { + rethrowSimple(error); + } + return data; } } -const updateObjectStoreFetcher = fetcher.path("/api/datasets/{dataset_id}/object_store_id").method("put").create(); - export async function updateObjectStore(datasetId: string, objectStoreId: string) { - const { data } = await updateObjectStoreFetcher({ dataset_id: datasetId, object_store_id: objectStoreId }); - return data; + const { error } = await GalaxyApi().PUT("/api/datasets/{dataset_id}/object_store_id", { + params: { path: { dataset_id: datasetId } }, + body: { object_store_id: objectStoreId }, + }); + + if (error) { + rethrowSimple(error); + } } diff --git a/client/src/api/pages.ts b/client/src/api/pages.ts deleted file mode 100644 index 89e89d2e8940..000000000000 --- a/client/src/api/pages.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { fetcher } from "@/api/schema"; - -/** Page request helper **/ -const deletePageById = fetcher.path("/api/pages/{id}").method("delete").create(); -export async function deletePage(itemId: string): Promise { - await deletePageById({ - id: itemId, - }); -} diff --git a/client/src/api/quotas.ts b/client/src/api/quotas.ts deleted file mode 100644 index f164fcf80632..000000000000 --- a/client/src/api/quotas.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { fetcher } from "@/api/schema"; - -export const deleteQuota = fetcher.path("/api/quotas/{id}").method("delete").create(); -export const purgeQuota = fetcher.path("/api/quotas/{id}/purge").method("post").create(); -export const undeleteQuota = fetcher.path("/api/quotas/deleted/{id}/undelete").method("post").create(); diff --git a/client/src/api/remoteFiles.ts b/client/src/api/remoteFiles.ts index b9efeeb3eb6c..5b014a75199f 100644 --- a/client/src/api/remoteFiles.ts +++ b/client/src/api/remoteFiles.ts @@ -1,5 +1,5 @@ -import { type components } from "@/api/schema"; -import { fetcher } from "@/api/schema/fetcher"; +import { type components, GalaxyApi } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; /** The browsing mode: * - `file` - allows to select files or directories contained in a source (default) @@ -28,24 +28,30 @@ export interface FilterFileSourcesOptions { exclude?: FileSourcePluginKind[]; } -const remoteFilesPluginsFetcher = fetcher.path("/api/remote_files/plugins").method("get").create(); - /** * Get the list of available file sources from the server that can be browsed. * @param options The options to filter the file sources. * @returns The list of available (browsable) file sources from the server. */ export async function fetchFileSources(options: FilterFileSourcesOptions = {}): Promise { - const { data } = await remoteFilesPluginsFetcher({ - browsable_only: true, - include_kind: options.include, - exclude_kind: options.exclude, + const { data, error } = await GalaxyApi().GET("/api/remote_files/plugins", { + params: { + query: { + browsable_only: true, + include_kind: options.include, + exclude_kind: options.exclude, + }, + }, }); + + if (error) { + rethrowSimple(error); + } + + // Since we specified browsable_only in the query, we can safely cast the data to the expected type. return data as BrowsableFilesSourcePlugin[]; } -export const remoteFilesFetcher = fetcher.path("/api/remote_files").method("get").create(); - export interface BrowseRemoteFilesResult { entries: RemoteEntry[]; totalMatches: number; @@ -71,28 +77,28 @@ export async function browseRemoteFiles( query?: string, sortBy?: string ): Promise { - const { data, headers } = await remoteFilesFetcher({ - target: uri, - recursive: isRecursive, - writeable, - limit, - offset, - query, - sort_by: sortBy, + const { response, data, error } = await GalaxyApi().GET("/api/remote_files", { + params: { + query: { + format: "uri", + target: uri, + recursive: isRecursive, + writeable, + limit, + offset, + query, + sort_by: sortBy, + }, + }, }); - const totalMatches = parseInt(headers.get("total_matches") ?? "0"); - return { entries: data as RemoteEntry[], totalMatches }; -} -const createEntry = fetcher.path("/api/remote_files").method("post").create(); + if (error) { + rethrowSimple(error); + } -/** - * Create a new entry (directory/record) on the given file source URI. - * @param uri The file source URI to create the entry in. - * @param name The name of the entry to create. - * @returns The created entry details. - */ -export async function createRemoteEntry(uri: string, name: string): Promise { - const { data } = await createEntry({ target: uri, name: name }); - return data; + const totalMatches = parseInt(response.headers.get("total_matches") ?? "0"); + + // Since we specified format=uri in the query, we can safely cast the data to the expected type. + const entries = data as RemoteEntry[]; + return { entries, totalMatches }; } diff --git a/client/src/api/roles.ts b/client/src/api/roles.ts deleted file mode 100644 index 4667ca53a2b5..000000000000 --- a/client/src/api/roles.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { fetcher } from "@/api/schema"; - -const getRoles = fetcher.path("/api/roles").method("get").create(); -export async function getAllRoles() { - const { data } = await getRoles({}); - return data; -} - -export const deleteRole = fetcher.path("/api/roles/{id}").method("delete").create(); -export const purgeRole = fetcher.path("/api/roles/{id}/purge").method("post").create(); -export const undeleteRole = fetcher.path("/api/roles/{id}/undelete").method("post").create(); diff --git a/client/src/api/schema/__mocks__/fetcher.ts b/client/src/api/schema/__mocks__/fetcher.ts deleted file mode 100644 index ffb5b7e2fd1a..000000000000 --- a/client/src/api/schema/__mocks__/fetcher.ts +++ /dev/null @@ -1,95 +0,0 @@ -import { type paths } from "@/api/schema"; - -jest.mock("@/api/schema", () => ({ - fetcher: mockFetcher, -})); - -jest.mock("@/api/schema/fetcher", () => ({ - fetcher: mockFetcher, -})); - -type Path = keyof paths; -type Method = "get" | "post" | "put" | "delete"; - -interface MockValue { - path: Path | RegExp; - method: Method; - value: any; -} - -const mockValues: MockValue[] = []; - -function getMockReturn(path: Path, method: Method, args: any[]) { - for (let i = mockValues.length - 1; i >= 0; i--) { - const matchPath = mockValues[i]!.path; - const matchMethod = mockValues[i]!.method; - const value = mockValues[i]!.value; - - const getValue = () => { - if (typeof value === "function") { - return value(...args); - } else { - return value; - } - }; - - if (matchMethod !== method) { - continue; - } - - if (typeof matchPath === "string") { - if (matchPath === path) { - return getValue(); - } - } else { - if (path.match(matchPath)) { - return getValue(); - } - } - } - - // if no mock has been setup, never resolve API request - return new Promise(() => {}); -} - -function setMockReturn(path: Path | RegExp, method: Method, value: any) { - mockValues.push({ - path, - method, - value, - }); -} - -/** - * Mock implementation for the fetcher found in `@/api/schema/fetcher` - * - * You need to call `jest.mock("@/api/schema")` and/or `jest.mock("@/api/schema/fetcher")` - * (depending on what module the file you are testing imported) - * in order for this mock to take effect. - * - * To specify return values for the mock, use - * `mockFetcher.path(...).method(...).mock(desiredReturnValue)` - * This will cause any use of fetcher on the same path and method to receive the contents of `desiredReturnValue`. - * - * If this return value is a function, it will be ran and passed the parameters passed to the fetcher, and it's result returned. - * - * `path(...)` can take a `RegExp`, in which case any path matching the Regular Expression with a fitting method will be used. - * - * If multiple mock paths match a path, the latest defined will be used. - * - * `clearMocks()` can be used to reset all mock return values set with `.mock()` - */ -export const mockFetcher = { - path: (path: Path | RegExp) => ({ - method: (method: Method) => ({ - // prettier-ignore - create: () => async (...args: any[]) => getMockReturn(path as Path, method, args), - mock: (mockReturn: any) => setMockReturn(path, method, mockReturn), - }), - }), - clearMocks: () => { - mockValues.length = 0; - }, -}; - -export const fetcher = mockFetcher; diff --git a/client/src/api/schema/__mocks__/index.ts b/client/src/api/schema/__mocks__/index.ts deleted file mode 100644 index d498943ddefa..000000000000 --- a/client/src/api/schema/__mocks__/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { fetcher, mockFetcher } from "./fetcher"; diff --git a/client/src/api/schema/fetcher.ts b/client/src/api/schema/fetcher.ts deleted file mode 100644 index 031c28ee8f1b..000000000000 --- a/client/src/api/schema/fetcher.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { type ApiResponse, Fetcher, type Middleware } from "openapi-typescript-fetch"; - -import { getAppRoot } from "@/onload/loadConfig"; -import { rethrowSimple } from "@/utils/simple-error"; - -import { type paths } from "./schema"; - -export { type ApiResponse }; - -const rethrowSimpleMiddleware: Middleware = async (url, init, next) => { - try { - const response = await next(url, init); - return response; - } catch (e) { - rethrowSimple(e); - } -}; - -export const fetcher = Fetcher.for(); -fetcher.configure({ baseUrl: getAppRoot(undefined, true), use: [rethrowSimpleMiddleware] }); diff --git a/client/src/api/schema/index.ts b/client/src/api/schema/index.ts index d931cad37dd6..7adf8ad41bb7 100644 --- a/client/src/api/schema/index.ts +++ b/client/src/api/schema/index.ts @@ -1,2 +1,3 @@ -export { type ApiResponse, fetcher } from "./fetcher"; -export type { components, operations, paths } from "./schema"; +import { type components, type paths as GalaxyApiPaths } from "./schema"; + +export { type components, type GalaxyApiPaths }; diff --git a/client/src/api/schema/mockFetcher.test.ts b/client/src/api/schema/mockFetcher.test.ts deleted file mode 100644 index e4eddd5a3f58..000000000000 --- a/client/src/api/schema/mockFetcher.test.ts +++ /dev/null @@ -1,42 +0,0 @@ -import { fetcher } from "@/api/schema"; - -import { mockFetcher } from "./__mocks__/fetcher"; - -jest.mock("@/api/schema"); - -mockFetcher.path("/api/configuration").method("get").mock("CONFIGURATION"); - -mockFetcher - .path(/^.*\/histories\/.*$/) - .method("get") - .mock("HISTORY"); - -mockFetcher - .path(/\{history_id\}/) - .method("put") - .mock((param: { history_id: string }) => `param:${param.history_id}`); - -describe("mockFetcher", () => { - it("mocks fetcher", async () => { - { - const fetch = fetcher.path("/api/configuration").method("get").create(); - const value = await fetch({}); - - expect(value).toEqual("CONFIGURATION"); - } - - { - const fetch = fetcher.path("/api/histories/deleted").method("get").create(); - const value = await fetch({}); - - expect(value).toEqual("HISTORY"); - } - - { - const fetchHistory = fetcher.path("/api/histories/{history_id}/exports").method("put").create(); - const value = await fetchHistory({ history_id: "test" }); - - expect(value).toEqual("param:test"); - } - }); -}); diff --git a/client/src/api/schema/schema.ts b/client/src/api/schema/schema.ts index 2720918058d5..1e9ab944ad2e 100644 --- a/client/src/api/schema/schema.ts +++ b/client/src/api/schema/schema.ts @@ -5,117 +5,383 @@ export interface paths { "/api/authenticate/baseauth": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns returns an API key for authenticated user based on BaseAuth headers. */ get: operations["get_api_key_api_authenticate_baseauth_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/chat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Query + * @description We're off to ask the wizard + */ + post: operations["query_api_chat_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/chat/{job_id}/feedback": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Feedback + * @description Provide feedback on the chatbot response. + */ + put: operations["feedback_api_chat__job_id__feedback_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return an object containing exposable configuration settings * @description Return an object containing exposable configuration settings. * - * A more complete list is returned if the user is an admin. - * Pass in `view` and a comma-seperated list of keys to control which - * configuration settings are returned. + * A more complete list is returned if the user is an admin. + * Pass in `view` and a comma-seperated list of keys to control which + * configuration settings are returned. */ get: operations["index_api_configuration_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/configuration/decode/{encoded_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Decode a given id * @description Decode a given id. */ get: operations["decode_id_api_configuration_decode__encoded_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/configuration/dynamic_tool_confs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return dynamic tool configuration files * @description Return dynamic tool configuration files. */ get: operations["dynamic_tool_confs_api_configuration_dynamic_tool_confs_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/configuration/encode/{decoded_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Encode a given id * @description Decode a given id. */ get: operations["encode_id_api_configuration_encode__decoded_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/configuration/tool_lineages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return tool lineages for tools that have them * @description Return tool lineages for tools that have them. */ get: operations["tool_lineages_api_configuration_tool_lineages_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/configuration/toolbox": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Reload the Galaxy toolbox (but not individual tools) * @description Reload the Galaxy toolbox (but not individual tools). */ put: operations["reload_toolbox_api_configuration_toolbox_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collection_element/{dce_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Content */ get: operations["content_api_dataset_collection_element__dce_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a new dataset collection instance. */ post: operations["create_api_dataset_collections_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{hdca_id}/contents/{parent_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns direct child contents of indicated dataset collection parent ID. */ get: operations["contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns detailed information about the given collection. */ get: operations["show_api_dataset_collections__id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{id}/attributes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns `dbkey`/`extension` attributes for all the collection elements. */ get: operations["attributes_api_dataset_collections__id__attributes_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{id}/copy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Copy the given collection datasets to a new collection using a new `dbkey` attribute. */ post: operations["copy_api_dataset_collections__id__copy_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{id}/download": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download the content of a dataset collection as a `zip` archive. * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. + * while maintaining approximate collection structure. */ get: operations["dataset_collections__download"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{id}/prepare_download": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Prepare an short term storage object that the collection will be downloaded to. * @description The history dataset collection will be written as a `zip` archive to the - * returned short term storage object. Progress tracking this file's creation - * can be tracked with the short_term_storage API. + * returned short term storage object. Progress tracking this file's creation + * can be tracked with the short_term_storage API. */ post: operations["prepare_collection_download_api_dataset_collections__id__prepare_download_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/dataset_collections/{id}/suitable_converters": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns a list of applicable converters for all datatypes in the given collection. */ get: operations["suitable_converters_api_dataset_collections__id__suitable_converters_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Search datasets or collections using a query system. */ get: operations["index_api_datasets_get"]; + put?: never; + post?: never; /** * Deletes or purges a batch of datasets. * @description Deletes or purges a batch of datasets. - * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, - * no other checks or restrictions are made. + * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, + * no other checks or restrictions are made. */ delete: operations["delete_batch_api_datasets_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays information about and/or content of a dataset. - * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wild variety of parameters - * and return different kinds of responses, the documentation here will be limited. - * To get more information please check the source code. + * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wide variety of parameters + * and return different kinds of responses, the documentation here will be limited. + * To get more information please check the source code. */ get: operations["show_api_datasets__dataset_id__get"]; /** @@ -123,229 +389,672 @@ export interface paths { * @description Updates the values for the history content item with the given ``ID``. */ put: operations["datasets__update_dataset"]; + post?: never; /** * Delete the history dataset content with the given ``ID``. * @description Delete the history content with the given ``ID`` and path specified type. * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. + * **Note**: Currently does not stop any active jobs for which this dataset is an output. */ delete: operations["datasets__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/content/{content_type}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Retrieve information about the content of a dataset. */ get: operations["get_structured_content_api_datasets__dataset_id__content__content_type__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/converted": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return a a map with all the existing converted datasets associated with this instance. * @description Return a map of ` : ` containing all the *existing* converted datasets. */ get: operations["converted_api_datasets__dataset_id__converted_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/converted/{ext}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return information about datasets made by converting this dataset to a new format. * @description Return information about datasets made by converting this dataset to a new format. * - * If there is no existing converted dataset for the format in `ext`, one will be created. + * If there is no existing converted dataset for the format in `ext`, one will be created. * - * **Note**: `view` and `keys` are also available to control the serialization of the dataset. + * **Note**: `view` and `keys` are also available to control the serialization of the dataset. */ get: operations["converted_ext_api_datasets__dataset_id__converted__ext__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/extra_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get the list of extra files/directories associated with a dataset. */ get: operations["extra_files_api_datasets__dataset_id__extra_files_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/get_content_as_text": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns dataset content as Text. */ get: operations["get_content_as_text_api_datasets__dataset_id__get_content_as_text_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/hash": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Compute dataset hash for dataset and update model */ put: operations["compute_hash_api_datasets__dataset_id__hash_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/inheritance_chain": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** For internal use, this endpoint may change without warning. */ get: operations["show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return job metrics for specified job. * @deprecated */ get: operations["get_metrics_api_datasets__dataset_id__metrics_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/object_store_id": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Update an object store ID for a dataset you own. */ put: operations["datasets__update_object_store_id"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/parameters_display": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Resolve parameters as a list for nested display. * @deprecated * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. */ get: operations["resolve_parameters_display_api_datasets__dataset_id__parameters_display_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set permissions of the given history dataset to the given role ids. * @description Set permissions of the given history dataset to the given role ids. */ put: operations["update_permissions_api_datasets__dataset_id__permissions_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{dataset_id}/storage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Display user-facing storage details related to the objectstore a dataset resides in. */ get: operations["show_storage_api_datasets__dataset_id__storage_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datasets/{history_content_id}/display": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays (preview) or downloads dataset content. * @description Streams the dataset for download or the contents preview to be displayed in a browser. */ get: operations["display_api_datasets__history_content_id__display_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; /** * Check if dataset content can be previewed or downloaded. * @description Streams the dataset for download or the contents preview to be displayed in a browser. */ head: operations["display_api_datasets__history_content_id__display_head"]; + patch?: never; + trace?: never; }; "/api/datasets/{history_content_id}/metadata_file": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns the metadata file associated with this history item. */ get: operations["datasets__get_metadata_file"]; + put?: never; + post?: never; + delete?: never; + options?: never; /** Check if metadata file can be downloaded. */ head: operations["get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head"]; + patch?: never; + trace?: never; }; "/api/datatypes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Lists all available data types * @description Gets the list of all available data types. */ get: operations["index_api_datatypes_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/converters": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the list of all installed converters * @description Gets the list of all installed converters. */ get: operations["converters_api_datatypes_converters_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/edam_data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a dictionary/map of datatypes and EDAM data * @description Gets a map of datatypes and their corresponding EDAM data. */ get: operations["edam_data_api_datatypes_edam_data_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/edam_data/detailed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a dictionary of datatypes and EDAM data details * @description Gets a map of datatypes and their corresponding EDAM data. - * EDAM data contains the EDAM iri, label, and definition. + * EDAM data contains the EDAM iri, label, and definition. */ get: operations["edam_data_detailed_api_datatypes_edam_data_detailed_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/edam_formats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a dictionary/map of datatypes and EDAM formats * @description Gets a map of datatypes and their corresponding EDAM formats. */ get: operations["edam_formats_api_datatypes_edam_formats_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/edam_formats/detailed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a dictionary of datatypes and EDAM format details * @description Gets a map of datatypes and their corresponding EDAM formats. - * EDAM formats contain the EDAM iri, label, and definition. + * EDAM formats contain the EDAM iri, label, and definition. */ get: operations["edam_formats_detailed_api_datatypes_edam_formats_detailed_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns mappings for data types and their implementing classes * @description Gets mappings for data types. */ get: operations["mapping_api_datatypes_mapping_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/sniffers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the list of all installed sniffers * @description Gets the list of all installed data type sniffers. */ get: operations["sniffers_api_datatypes_sniffers_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/datatypes/types_and_mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns all the data types extensions and their mappings * @description Combines the datatype information from (/api/datatypes) and the - * mapping information from (/api/datatypes/mapping) into a single - * response. + * mapping information from (/api/datatypes/mapping) into a single + * response. */ get: operations["types_and_mapping_api_datatypes_types_and_mapping_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/display_applications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the list of display applications. * @description Returns the list of display applications. */ get: operations["display_applications_index_api_display_applications_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/display_applications/reload": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Reloads the list of display applications. * @description Reloads the list of display applications. */ post: operations["display_applications_reload_api_display_applications_reload_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/drs_download/{object_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Download */ get: operations["download_api_drs_download__object_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/file_source_instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a list of persisted file source instances defined by the requesting user. */ get: operations["file_sources__instances_index"]; + put?: never; /** Create a user-bound file source. */ post: operations["file_sources__create_instance"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/file_source_instances/test": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Test payload for creating user-bound file source. */ post: operations["file_sources__test_new_instance_configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - "/api/file_source_instances/{user_file_source_id}": { + "/api/file_source_instances/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a persisted user file source instance. */ get: operations["file_sources__instances_get"]; /** Update or upgrade user file source instance. */ put: operations["file_sources__instances_update"]; + post?: never; /** Purge user file source instance. */ delete: operations["file_sources__instances_purge"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/file_source_instances/{uuid}/test": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Test a file source instance and return status. */ + get: operations["file_sources__instances_test_instance"]; + put?: never; + /** Test updating or upgrading user file source instance. */ + post: operations["file_sources__test_instances_update"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/file_source_templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a list of file source templates available to build user defined file sources from */ get: operations["file_sources__templates_index"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/file_source_templates/{template_id}/{template_version}/oauth2": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Template Oauth2 */ + get: operations["file_sources__template_oauth2"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/folders/{folder_id}/contents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. * @description Returns a list of a folder's contents (files and sub-folders). * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. + * Additional metadata for the folder is provided in the response as a separate object containing data + * for breadcrumb path building, permissions and other folder's details. * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). + * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. + * **Security note**: + * - Accessing a library folder or sub-folder requires only access to the parent library. + * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. + * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. */ get: operations["index_api_folders__folder_id__contents_get"]; + put?: never; /** Creates a new library file from an existing HDA/HDCA. */ post: operations["add_history_datasets_to_library_api_folders__folder_id__contents_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/folders/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays information about a particular library folder. * @description Returns detailed information about the library folder with the given ID. @@ -366,94 +1075,279 @@ export interface paths { * @description Marks the specified library folder as deleted (or undeleted). */ delete: operations["delete_api_folders__id__delete"]; + options?: never; + head?: never; /** * Update * @description Updates the information of an existing library folder. */ patch: operations["update_api_folders__id__patch"]; + trace?: never; }; "/api/folders/{id}/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Gets the current or available permissions of a particular library folder. * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. + * The results can be paginated and additionally filtered by a query. */ get: operations["get_permissions_api_folders__id__permissions_get"]; + put?: never; /** * Sets the permissions to manage a library folder. * @description Sets the permissions to manage a library folder. */ post: operations["set_permissions_api_folders__id__permissions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/forms/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete */ delete: operations["delete_api_forms__id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/forms/{id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Undelete */ post: operations["undelete_api_forms__id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/ftp_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays remote files available to the user. Please use /api/remote_files instead. * @deprecated * @description Lists all remote files available to the user from different sources. * - * The total count of files and directories is returned in the 'total_matches' header. + * The total count of files and directories is returned in the 'total_matches' header. */ get: operations["index_api_ftp_files_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/genomes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return a list of installed genomes */ get: operations["index_api_genomes_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/genomes/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return information about build */ get: operations["show_api_genomes__id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/genomes/{id}/indexes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return all available indexes for a genome id for provided type */ get: operations["indexes_api_genomes__id__indexes_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/genomes/{id}/sequences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return raw sequence data */ get: operations["sequences_api_genomes__id__sequences_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Displays a collection (list) of groups. */ get: operations["index_api_groups_get"]; + put?: never; /** Creates a new group. */ post: operations["create_api_groups_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Displays information about a group. */ get: operations["show_group_api_groups__group_id__get"]; /** Modifies a group. */ put: operations["update_api_groups__group_id__put"]; + post?: never; /** Delete */ delete: operations["delete_api_groups__group_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/purge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Purge */ post: operations["purge_api_groups__group_id__purge_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Displays a collection (list) of groups. */ get: operations["group_roles_api_groups__group_id__roles_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Displays information about a group role. */ get: operations["group_role_api_groups__group_id__roles__role_id__get"]; /** Adds a role to a group */ put: operations["update_api_groups__group_id__roles__role_id__put"]; + post?: never; /** Removes a role from a group */ delete: operations["delete_api_groups__group_id__roles__role_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Undelete */ post: operations["undelete_api_groups__group_id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/user/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays information about a group user. * @description Displays information about a group user. @@ -462,25 +1356,49 @@ export interface paths { /** * Adds a user to a group * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group + * Adds a user to a group */ put: operations["update_api_groups__group_id__user__user_id__put"]; + post?: never; /** * Removes a user from a group * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group + * Removes a user from a group */ delete: operations["delete_api_groups__group_id__user__user_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays a collection (list) of groups. * @description GET /api/groups/{encoded_group_id}/users - * Displays a collection (list) of groups. + * Displays a collection (list) of groups. */ get: operations["group_users_api_groups__group_id__users_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/groups/{group_id}/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays information about a group user. * @description Displays information about a group user. @@ -489,145 +1407,374 @@ export interface paths { /** * Adds a user to a group * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group + * Adds a user to a group */ put: operations["update_api_groups__group_id__users__user_id__put"]; + post?: never; /** * Removes a user from a group * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group + * Removes a user from a group */ delete: operations["delete_api_groups__group_id__users__user_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/help/forum/search": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search the Galaxy Help forum. * @description Search the Galaxy Help forum using the Discourse API. * - * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. + * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. */ get: operations["search_forum_api_help_forum_search_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns histories available to the current user. */ get: operations["index_api_histories_get"]; + put?: never; /** * Creates a new history. * @description The new history can also be copied form a existing history or imported from an archive or URL. */ post: operations["create_api_histories_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/archived": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a list of all archived histories for the current user. * @description Get a list of all archived histories for the current user. * - * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. + * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. */ get: operations["get_archived_histories_api_histories_archived_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/batch/delete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Marks several histories with the given IDs as deleted. */ put: operations["batch_delete_api_histories_batch_delete_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/batch/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Marks several histories with the given IDs as undeleted. */ put: operations["batch_undelete_api_histories_batch_undelete_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/count": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns number of histories for the current user. */ get: operations["count_api_histories_count_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/deleted": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns deleted histories for the current user. */ get: operations["index_deleted_api_histories_deleted_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/deleted/{history_id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Restores a deleted history with the given ID (that hasn't been purged). */ post: operations["undelete_api_histories_deleted__history_id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/from_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create histories from a model store. */ post: operations["create_from_store_api_histories_from_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/from_store_async": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Launch a task to create histories from a model store. */ post: operations["create_from_store_async_api_histories_from_store_async_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/most_recently_used": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns the most recently used history of the user. */ get: operations["show_recent_api_histories_most_recently_used_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/published": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return all histories that are published. */ get: operations["published_api_histories_published_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/shared_with_me": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return all histories that are shared with the current user. */ get: operations["shared_with_me_api_histories_shared_with_me_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns the history with the given ID. */ get: operations["history_api_histories__history_id__get"]; /** Updates the values for the history with the given ID. */ put: operations["update_api_histories__history_id__put"]; + post?: never; /** Marks the history with the given ID as deleted. */ delete: operations["delete_api_histories__history_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Archive a history. * @description Marks the given history as 'archived' and returns the history. * - * Archiving a history will remove it from the list of active histories of the user but it will still be - * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. + * Archiving a history will remove it from the list of active histories of the user but it will still be + * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. * - * Associating an export record: + * Associating an export record: * - * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the - * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and - * must be in the ready state. - * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. + * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the + * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and + * must be in the ready state. + * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. * - * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. - * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. + * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. + * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. */ post: operations["archive_history_api_histories__history_id__archive_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/archive/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Restore an archived history. * @description Restores an archived history and returns it. * - * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). + * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). * - * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them - * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export - * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. + * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them + * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export + * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. */ put: operations["restore_archived_history_api_histories__history_id__archive_restore_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/citations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return all the citations for the tools used to produce the datasets in the history. */ get: operations["citations_api_histories__history_id__citations_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the contents of the given history. * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. * - * **Note**: Anonymous users are allowed to get their current history contents. + * **Note**: Anonymous users are allowed to get their current history contents. */ get: operations["history_contents__index"]; /** * Batch update specific properties of a set items contained in the given History. * @description Batch update specific properties of a set items contained in the given History. * - * If you provide an invalid/unknown property key the request will not fail, but no changes - * will be made to the items. + * If you provide an invalid/unknown property key the request will not fail, but no changes + * will be made to the items. */ put: operations["update_batch_api_histories__history_id__contents_put"]; /** @@ -636,78 +1783,218 @@ export interface paths { * @description Create a new `HDA` or `HDCA` in the given History. */ post: operations["history_contents__create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Build and return a compressed archive of the selected history contents. * @description Build and return a compressed archive of the selected history contents. * - * **Note**: this is a volatile endpoint and settings and behavior may change. + * **Note**: this is a volatile endpoint and settings and behavior may change. */ get: operations["history_contents__archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/archive/{filename}.{format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Build and return a compressed archive of the selected history contents. * @description Build and return a compressed archive of the selected history contents. * - * **Note**: this is a volatile endpoint and settings and behavior may change. + * **Note**: this is a volatile endpoint and settings and behavior may change. */ get: operations["history_contents__archive_named"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/bulk": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Executes an operation on a set of items contained in the given History. * @description Executes an operation on a set of items contained in the given History. * - * The items to be processed can be explicitly set or determined by a dynamic query. + * The items to be processed can be explicitly set or determined by a dynamic query. */ put: operations["bulk_operation_api_histories__history_id__contents_bulk_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/dataset_collections/{id}/download": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download the content of a dataset collection as a `zip` archive. * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. + * while maintaining approximate collection structure. */ get: operations["history_contents__download_collection"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/datasets/{id}/materialize": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Materialize a deferred dataset into real, usable dataset. */ post: operations["materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{dataset_id}/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set permissions of the given history dataset to the given role ids. * @description Set permissions of the given history dataset to the given role ids. */ put: operations["update_permissions_api_histories__history_id__contents__dataset_id__permissions_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{history_content_id}/display": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays (preview) or downloads dataset content. * @description Streams the dataset for download or the contents preview to be displayed in a browser. */ get: operations["history_contents_display_api_histories__history_id__contents__history_content_id__display_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; /** * Check if dataset content can be previewed or downloaded. * @description Streams the dataset for download or the contents preview to be displayed in a browser. */ head: operations["history_contents_display_api_histories__history_id__contents__history_content_id__display_head"]; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{history_content_id}/extra_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get the list of extra files/directories associated with a dataset. */ get: operations["extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{history_content_id}/metadata_file": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns the metadata file associated with this history item. */ get: operations["history_contents__get_metadata_file"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{history_content_id}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show tags based on history_content_id */ get: operations["index_api_histories__history_id__contents__history_content_id__tags_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{history_content_id}/tags/{tag_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show tag based on history_content_id */ get: operations["show_api_histories__history_id__contents__history_content_id__tags__tag_name__get"]; /** Update tag based on history_content_id */ @@ -716,14 +2003,24 @@ export interface paths { post: operations["create_api_histories__history_id__contents__history_content_id__tags__tag_name__post"]; /** Delete tag based on history_content_id */ delete: operations["delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. * @deprecated * @description Return detailed information about an `HDA` or `HDCA` within a history. * - * **Note**: Anonymous users are allowed to get their current history contents. + * **Note**: Anonymous users are allowed to get their current history contents. */ get: operations["history_contents__show_legacy"]; /** @@ -732,44 +2029,80 @@ export interface paths { * @description Updates the values for the history content item with the given ``ID``. */ put: operations["history_contents__update_legacy"]; + post?: never; /** * Delete the history dataset with the given ``ID``. * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. + * **Note**: Currently does not stop any active jobs for which this dataset is an output. */ delete: operations["history_contents__delete_legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{id}/validate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Validates the metadata associated with a dataset within a History. * @description Validates the metadata associated with a dataset within a History. */ put: operations["validate_api_histories__history_id__contents__id__validate_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{type}s": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the contents of the given history filtered by type. * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. + * - The contents can be filtered and queried using the appropriate parameters. + * - The amount of information returned for each item can be customized. * - * **Note**: Anonymous users are allowed to get their current history contents. + * **Note**: Anonymous users are allowed to get their current history contents. */ get: operations["history_contents__index_typed"]; + put?: never; /** * Create a new `HDA` or `HDCA` in the given History. * @description Create a new `HDA` or `HDCA` in the given History. */ post: operations["history_contents__create_typed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{type}s/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. * @description Return detailed information about an `HDA` or `HDCA` within a history. * - * **Note**: Anonymous users are allowed to get their current history contents. + * **Note**: Anonymous users are allowed to get their current history contents. */ get: operations["history_contents__show"]; /** @@ -777,68 +2110,170 @@ export interface paths { * @description Updates the values for the history content item with the given ``ID``. */ put: operations["history_contents__update_typed"]; + post?: never; /** * Delete the history content with the given ``ID`` and path specified type. * @description Delete the history content with the given ``ID`` and path specified type. * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. + * **Note**: Currently does not stop any active jobs for which this dataset is an output. */ delete: operations["history_contents__delete_typed"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{type}s/{id}/jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return detailed information about an `HDA` or `HDCAs` jobs. * @description Return detailed information about an `HDA` or `HDCAs` jobs. * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ get: operations["show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{type}s/{id}/prepare_store_download": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Prepare a dataset or dataset collection for export-style download. */ post: operations["prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents/{type}s/{id}/write_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ post: operations["write_store_api_histories__history_id__contents__type_s__id__write_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/contents_from_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create contents from store. * @description Create history contents from model store. - * Input can be a tarfile created with build_objects script distributed - * with galaxy-data, from an exported history with files stripped out, - * or hand-crafted JSON dictionary. + * Input can be a tarfile created with build_objects script distributed + * with galaxy-data, from an exported history with files stripped out, + * or hand-crafted JSON dictionary. */ post: operations["create_from_store_api_histories__history_id__contents_from_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/custom_builds_metadata": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns meta data for custom builds. */ get: operations["get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/disable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item inaccessible by a URL link. * @description Makes this item inaccessible by a URL link and return the current sharing status. */ put: operations["disable_link_access_api_histories__history_id__disable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/enable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item accessible by a URL link. * @description Makes this item accessible by a URL link and return the current sharing status. */ put: operations["enable_link_access_api_histories__history_id__enable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/exports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get previous history exports. * @description By default the legacy job-based history exports (jeha) are returned. * - * Change the `accept` content type header to return the new task-based history exports. + * Change the `accept` content type header to return the new task-based history exports. */ get: operations["get_history_exports_api_histories__history_id__exports_get"]; /** @@ -846,85 +2281,214 @@ export interface paths { * @deprecated * @description This will start a job to create a history export archive. * - * Calling this endpoint multiple times will return the 202 status code until the archive - * has been completely generated and is ready to download. When ready, it will return - * the 200 status code along with the download link information. + * Calling this endpoint multiple times will return the 202 status code until the archive + * has been completely generated and is ready to download. When ready, it will return + * the 200 status code along with the download link information. * - * If the history will be exported to a `directory_uri`, instead of returning the download - * link information, the Job ID will be returned so it can be queried to determine when - * the file has been written. + * If the history will be exported to a `directory_uri`, instead of returning the download + * link information, the Job ID will be returned so it can be queried to determine when + * the file has been written. * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. */ put: operations["archive_export_api_histories__history_id__exports_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/exports/{jeha_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * If ready and available, return raw contents of exported history as a downloadable archive. * @deprecated * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation - * of the history export - when ready, that route will return 200 status - * code (instead of 202) and this route can be used to download the archive. + * of the history export - when ready, that route will return 200 status + * code (instead of 202) and this route can be used to download the archive. * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. + * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or + * `/api/histories/{id}/write_store` instead. */ get: operations["history_archive_download_api_histories__history_id__exports__jeha_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. + * **Warning**: We allow anyone to fetch job state information about any object they + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ get: operations["index_jobs_summary_api_histories__history_id__jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/materialize": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ post: operations["materialize_to_history_api_histories__history_id__materialize_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/prepare_store_download": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Return a short term storage token to monitor download of the history. */ post: operations["prepare_store_download_api_histories__history_id__prepare_store_download_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item public and accessible by a URL link. * @description Makes this item publicly available by a URL link and return the current sharing status. */ put: operations["publish_api_histories__history_id__publish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/share_with_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Share this item with specific users. * @description Shares this item with specific users and return the current sharing status. */ put: operations["share_with_users_api_histories__history_id__share_with_users_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/sharing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the current sharing status of the given item. * @description Return the sharing status of the item. */ get: operations["sharing_api_histories__history_id__sharing_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/slug": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set a new slug for this shared item. * @description Sets a new slug to access this item by URL. The new slug must be unique. */ put: operations["set_slug_api_histories__history_id__slug_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show tags based on history_id */ get: operations["index_api_histories__history_id__tags_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/tags/{tag_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show tag based on history_id */ get: operations["show_api_histories__history_id__tags__tag_name__get"]; /** Update tag based on history_id */ @@ -933,72 +2497,258 @@ export interface paths { post: operations["create_api_histories__history_id__tags__tag_name__post"]; /** Delete tag based on history_id */ delete: operations["delete_api_histories__history_id__tags__tag_name__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/unpublish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Removes this item from the published list. * @description Removes this item from the published list and return the current sharing status. */ put: operations["unpublish_api_histories__history_id__unpublish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/histories/{history_id}/write_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Prepare history for export-style download and write to supplied URI. */ post: operations["write_store_api_histories__history_id__write_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get the list of a user's workflow invocations. */ get: operations["index_invocations_api_invocations_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/from_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create Invocations From Store * @description Create invocation(s) from a supplied model store. */ post: operations["create_invocations_from_store_api_invocations_from_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/steps/{step_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show details of workflow invocation step. */ get: operations["step_api_invocations_steps__step_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get detailed description of a workflow invocation. */ get: operations["show_invocation_api_invocations__invocation_id__get"]; + put?: never; + post?: never; /** Cancel the specified workflow invocation. */ delete: operations["cancel_invocation_api_invocations__invocation_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get job state summary info aggregated across all current jobs of the workflow invocation. * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ get: operations["invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/invocations/{invocation_id}/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get Invocation Metrics */ + get: operations["get_invocation_metrics_api_invocations__invocation_id__metrics_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/prepare_store_download": { - /** Prepare a workflow invocation export-style download. */ + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Prepare a workflow invocation export-style download. */ post: operations["prepare_store_download_api_invocations__invocation_id__prepare_store_download_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/report": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get JSON summarizing invocation for reporting. */ get: operations["show_invocation_report_api_invocations__invocation_id__report_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/report.pdf": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get PDF summarizing invocation for reporting. */ get: operations["show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/invocations/{invocation_id}/request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a description modeling an API request to invoke this workflow - this is recreated and will be more specific in some ways than the initial creation request. */ + get: operations["invocation_as_request_api_invocations__invocation_id__request_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/step_jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get job state summary info aggregated per step of the workflow invocation. * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. + * can guess an encoded ID for - it isn't considered protected data. This keeps + * polling IDs as part of state calculation for large histories and collections as + * efficient as possible. */ get: operations["invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/steps/{step_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Show details of workflow invocation step. * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. @@ -1006,12 +2756,37 @@ export interface paths { get: operations["invocation_step_api_invocations__invocation_id__steps__step_id__get"]; /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ put: operations["update_invocation_step_api_invocations__invocation_id__steps__step_id__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/invocations/{invocation_id}/write_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Prepare a workflow invocation export-style download and write to supplied URI. */ post: operations["write_store_api_invocations__invocation_id__write_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/job_lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Job Lock Status * @description Get job lock status. @@ -1022,152 +2797,498 @@ export interface paths { * @description Set job lock status. */ put: operations["update_job_lock_api_job_lock_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Index */ get: operations["index_api_jobs_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/search": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Return jobs for current user * @description This method is designed to scan the list of previously run jobs and find records of jobs that had - * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply - * recycle the old results. + * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply + * recycle the old results. */ post: operations["search_jobs_api_jobs_search_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return dictionary containing description of job data. */ get: operations["show_job_api_jobs__job_id__get"]; + put?: never; + post?: never; /** Cancels specified job */ delete: operations["cancel_job_api_jobs__job_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/common_problems": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check inputs and job for common potential problems to aid in error reporting */ get: operations["check_common_problems_api_jobs__job_id__common_problems_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/jobs/{job_id}/console_output": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Returns STDOUT and STDERR from the tool running in a specific job. + * @description Get the stdout and/or stderr from the tool running in a specific job. The position parameters are the index + * of where to start reading stdout/stderr. The length parameters control how much + * stdout/stderr is read. + */ + get: operations["get_console_output_api_jobs__job_id__console_output_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/destination_params": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return destination parameters for specified job. */ get: operations["destination_params_job_api_jobs__job_id__destination_params_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Submits a bug report via the API. */ post: operations["report_error_api_jobs__job_id__error_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/inputs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns input datasets created by a job. */ get: operations["get_inputs_api_jobs__job_id__inputs_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return job metrics for specified job. */ get: operations["get_metrics_api_jobs__job_id__metrics_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/oidc-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a fresh OIDC token * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API */ get: operations["get_token_api_jobs__job_id__oidc_tokens_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/outputs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns output datasets created by a job. */ get: operations["get_outputs_api_jobs__job_id__outputs_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/parameters_display": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Resolve parameters as a list for nested display. * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. + * This API endpoint is unstable and tied heavily to Galaxy's JS client code, + * this endpoint will change frequently. */ get: operations["resolve_parameters_display_api_jobs__job_id__parameters_display_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/jobs/{job_id}/resume": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Resumes a paused job. */ put: operations["resume_paused_job_api_jobs__job_id__resume_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/libraries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a list of summary data for all libraries. * @description Returns a list of summary data for all libraries. */ get: operations["index_api_libraries_get"]; + put?: never; /** * Creates a new library and returns its summary information. * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. */ post: operations["create_api_libraries_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/libraries/deleted": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns a list of summary data for all libraries marked as deleted. * @description Returns a list of summary data for all libraries marked as deleted. */ get: operations["index_deleted_api_libraries_deleted_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/libraries/from_store": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create libraries from a model store. */ post: operations["create_from_store_api_libraries_from_store_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/libraries/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns summary information about a particular library. * @description Returns summary information about a particular library. */ get: operations["show_api_libraries__id__get"]; + put?: never; + post?: never; /** * Marks the specified library as deleted (or undeleted). * @description Marks the specified library as deleted (or undeleted). - * Currently, only admin users can delete or restore libraries. + * Currently, only admin users can delete or restore libraries. */ delete: operations["delete_api_libraries__id__delete"]; + options?: never; + head?: never; /** * Updates the information of an existing library. * @description Updates the information of an existing library. */ patch: operations["update_api_libraries__id__patch"]; + trace?: never; }; "/api/libraries/{id}/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Gets the current or available permissions of a particular library. * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. + * The results can be paginated and additionally filtered by a query. */ get: operations["get_permissions_api_libraries__id__permissions_get"]; + put?: never; /** * Sets the permissions to access and manipulate a library. * @description Sets the permissions to access and manipulate a library. */ post: operations["set_permissions_api_libraries__id__permissions_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/libraries/{library_id}/contents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Return a list of library files and folders. + * @deprecated + * @description This endpoint is deprecated. Please use GET /api/folders/{folder_id}/contents instead. + */ + get: operations["index_api_libraries__library_id__contents_get"]; + put?: never; + /** + * Create a new library file or folder. + * @deprecated + * @description This endpoint is deprecated. Please use POST /api/folders/{folder_id} or POST /api/folders/{folder_id}/contents instead. + */ + post: operations["create_form_api_libraries__library_id__contents_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/libraries/{library_id}/contents/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Return a library file or folder. + * @deprecated + * @description This endpoint is deprecated. Please use GET /api/libraries/datasets/{library_id} instead. + */ + get: operations["library_content_api_libraries__library_id__contents__id__get"]; + /** + * Update a library file or folder. + * @deprecated + * @description This endpoint is deprecated. Please use PATCH /api/libraries/datasets/{library_id} instead. + */ + put: operations["update_api_libraries__library_id__contents__id__put"]; + post?: never; + /** + * Delete a library file or folder. + * @deprecated + * @description This endpoint is deprecated. Please use DELETE /api/libraries/datasets/{library_id} instead. + */ + delete: operations["delete_api_libraries__library_id__contents__id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Lists all available SPDX licenses * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). */ get: operations["index_api_licenses_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/licenses/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Gets the SPDX license metadata associated with the short identifier * @description Returns the license metadata associated with the given - * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). + * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). */ get: operations["get_api_licenses__id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Records a collection of metrics. * @description Record any metrics sent and return some status object. */ post: operations["create_api_metrics_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the list of notifications associated with the user. * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. * - * You can use the `limit` and `offset` parameters to paginate through the notifications. + * You can use the `limit` and `offset` parameters to paginate through the notifications. */ get: operations["get_user_notifications_api_notifications_get"]; /** Updates a list of notifications with the requested values in a single request. */ @@ -1179,31 +3300,53 @@ export interface paths { post: operations["send_notification_api_notifications_post"]; /** Deletes a list of notifications received by the user in a single request. */ delete: operations["delete_user_notifications_api_notifications_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/notifications/broadcast": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns all currently active broadcasted notifications. * @description Only Admin users can access inactive notifications (scheduled or recently expired). */ get: operations["get_all_broadcasted_api_notifications_broadcast_get"]; + put?: never; /** * Broadcasts a notification to every user in the system. * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. - * They are typically used to display important information such as maintenance windows or new features. - * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. + * They are typically used to display important information such as maintenance windows or new features. + * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. * - * Broadcasted notifications can include action links that are displayed as buttons. - * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. + * Broadcasted notifications can include action links that are displayed as buttons. + * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. * - * Some key features of broadcasted notifications include: - * - They are not associated with a specific user, so they cannot be deleted or marked as read. - * - They can be scheduled to be displayed in the future or to expire after a certain time. - * - By default, broadcasted notifications are published immediately and expire six months after publication. - * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. + * Some key features of broadcasted notifications include: + * - They are not associated with a specific user, so they cannot be deleted or marked as read. + * - They can be scheduled to be displayed in the future or to expire after a certain time. + * - By default, broadcasted notifications are published immediately and expire six months after publication. + * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. */ post: operations["broadcast_notification_api_notifications_broadcast_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/notifications/broadcast/{notification_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the information of a specific broadcasted notification. * @description Only Admin users can access inactive notifications (scheduled or recently expired). @@ -1214,209 +3357,555 @@ export interface paths { * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. */ put: operations["update_broadcasted_notification_api_notifications_broadcast__notification_id__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/notifications/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the current user's preferences for notifications. * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. * - * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. - * The supported channels are returned in the `supported-channels` header. + * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. + * The supported channels are returned in the `supported-channels` header. */ get: operations["get_notification_preferences_api_notifications_preferences_get"]; /** * Updates the user's preferences for notifications. * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. * - * - Can be used to completely enable/disable notifications for a particular type (category) - * or to enable/disable a particular channel on each category. + * - Can be used to completely enable/disable notifications for a particular type (category) + * or to enable/disable a particular channel on each category. */ put: operations["update_notification_preferences_api_notifications_preferences_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/notifications/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Returns the current status summary of the user's notifications since a particular date. * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. */ get: operations["get_notifications_status_api_notifications_status_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/notifications/{notification_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Displays information about a notification received by the user. */ get: operations["show_notification_api_notifications__notification_id__get"]; /** Updates the state of a notification received by the user. */ put: operations["update_user_notification_api_notifications__notification_id__put"]; + post?: never; /** * Deletes a notification received by the user. * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. * - * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. - * - It will be eventually removed from the database by a background task after the expiration time. - * - Deleted notifications will be permanently deleted when the expiration time is reached. + * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. + * - It will be eventually removed from the database by a background task after the expiration time. + * - Deleted notifications will be permanently deleted when the expiration time is reached. */ delete: operations["delete_user_notification_api_notifications__notification_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/object_store_instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a list of persisted object store instances defined by the requesting user. */ get: operations["object_stores__instances_index"]; + put?: never; /** Create a user-bound object store. */ post: operations["object_stores__create_instance"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/object_store_instances/test": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Test payload for creating user-bound object store. */ post: operations["object_stores__test_new_instance_configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - "/api/object_store_instances/{user_object_store_id}": { + "/api/object_store_instances/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a persisted user object store instance. */ get: operations["object_stores__instances_get"]; /** Update or upgrade user object store instance. */ put: operations["object_stores__instances_update"]; + post?: never; /** Purge user object store instance. */ delete: operations["object_stores__instances_purge"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/object_store_instances/{uuid}/test": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get a persisted user object store instance. */ + get: operations["object_stores__instances_test_instance"]; + put?: never; + /** Test updating or upgrading user object source instance. */ + post: operations["object_stores__test_instances_update"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/object_store_templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a list of object store templates available to build user defined object stores from */ get: operations["object_stores__templates_index"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/object_stores": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ get: operations["index_api_object_stores_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/object_stores/{object_store_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get information about a concrete object store configured with Galaxy. */ get: operations["show_info_api_object_stores__object_store_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Lists all Pages viewable by the user. * @description Get a list with summary information of all Pages available to the user. */ get: operations["index_api_pages_get"]; + put?: never; /** * Create a page and return summary information. * @description Get a list with details of all Pages available to the user. */ post: operations["create_api_pages_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return a page summary and the content of the last revision. * @description Return summary information about a specific Page and the content of the last revision. */ get: operations["show_api_pages__id__get"]; + put?: never; + post?: never; /** * Marks the specific Page as deleted. * @description Marks the Page with the given ID as deleted. */ delete: operations["delete_api_pages__id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}.pdf": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return a PDF document of the last revision of the Page. * @description Return a PDF document of the last revision of the Page. * - * This feature may not be available in this Galaxy. + * This feature may not be available in this Galaxy. */ get: operations["show_pdf_api_pages__id__pdf_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/disable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item inaccessible by a URL link. * @description Makes this item inaccessible by a URL link and return the current sharing status. */ put: operations["disable_link_access_api_pages__id__disable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/enable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item accessible by a URL link. * @description Makes this item accessible by a URL link and return the current sharing status. */ put: operations["enable_link_access_api_pages__id__enable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/prepare_download": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Return a PDF document of the last revision of the Page. * @description Return a STS download link for this page to be downloaded as a PDF. * - * This feature may not be available in this Galaxy. + * This feature may not be available in this Galaxy. */ post: operations["prepare_pdf_api_pages__id__prepare_download_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item public and accessible by a URL link. * @description Makes this item publicly available by a URL link and return the current sharing status. */ put: operations["publish_api_pages__id__publish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/share_with_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Share this item with specific users. * @description Shares this item with specific users and return the current sharing status. */ put: operations["share_with_users_api_pages__id__share_with_users_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/sharing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the current sharing status of the given Page. * @description Return the sharing status of the item. */ get: operations["sharing_api_pages__id__sharing_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/slug": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set a new slug for this shared item. * @description Sets a new slug to access this item by URL. The new slug must be unique. */ put: operations["set_slug_api_pages__id__slug_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Undelete the specific Page. * @description Marks the Page with the given ID as undeleted. */ put: operations["undelete_api_pages__id__undelete_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/pages/{id}/unpublish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Removes this item from the published list. * @description Removes this item from the published list and return the current sharing status. */ put: operations["unpublish_api_pages__id__unpublish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/quotas": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays a list with information of quotas that are currently active. * @description Displays a list with information of quotas that are currently active. */ get: operations["index_api_quotas_get"]; + put?: never; /** * Creates a new quota. * @description Creates a new quota. */ post: operations["create_api_quotas_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/quotas/deleted": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays a list with information of quotas that have been deleted. * @description Displays a list with information of quotas that have been deleted. */ get: operations["index_deleted_api_quotas_deleted_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/quotas/deleted/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays details on a particular quota that has been deleted. * @description Displays details on a particular quota that has been deleted. */ get: operations["deleted_quota_api_quotas_deleted__id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/quotas/deleted/{id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restores a previously deleted quota. * @description Restores a previously deleted quota. */ post: operations["undelete_api_quotas_deleted__id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/quotas/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays details on a particular active quota. * @description Displays details on a particular active quota. @@ -1427,460 +3916,1488 @@ export interface paths { * @description Updates an existing quota. */ put: operations["update_api_quotas__id__put"]; + post?: never; /** * Deletes an existing quota. * @description Deletes an existing quota. */ delete: operations["delete_api_quotas__id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/quotas/{id}/purge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Purges a previously deleted quota. */ post: operations["purge_api_quotas__id__purge_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/remote_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Displays remote files available to the user. * @description Lists all remote files available to the user from different sources. * - * The total count of files and directories is returned in the 'total_matches' header. + * The total count of files and directories is returned in the 'total_matches' header. */ get: operations["index_api_remote_files_get"]; + put?: never; /** * Creates a new entry (directory/record) on the remote files source. * @description Creates a new entry on the remote files source. */ post: operations["create_entry_api_remote_files_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/remote_files/plugins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Display plugin information for each of the gxfiles:// URI targets available. * @description Display plugin information for each of the gxfiles:// URI targets available. */ get: operations["plugins_api_remote_files_plugins_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Index */ get: operations["index_api_roles_get"]; + put?: never; /** Create */ post: operations["create_api_roles_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/roles/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show */ get: operations["show_api_roles__id__get"]; + put?: never; + post?: never; /** Delete */ delete: operations["delete_api_roles__id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/roles/{id}/purge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Purge */ post: operations["purge_api_roles__id__purge_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/roles/{id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Undelete */ post: operations["undelete_api_roles__id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/short_term_storage/{storage_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Serve the staged download specified by request ID. */ get: operations["serve_api_short_term_storage__storage_request_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/short_term_storage/{storage_request_id}/ready": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Determine if specified storage request ID is ready for download. */ get: operations["is_ready_api_short_term_storage__storage_request_id__ready_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/datasets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Purges a set of datasets by ID from disk. The datasets must be owned by the user. * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. */ delete: operations["cleanup_datasets_api_storage_datasets_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/datasets/discarded": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns discarded datasets owned by the given user. The results can be paginated. */ get: operations["discarded_datasets_api_storage_datasets_discarded_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/datasets/discarded/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ get: operations["discarded_datasets_summary_api_storage_datasets_discarded_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/histories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Purges a set of histories by ID. The histories must be owned by the user. * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. */ delete: operations["cleanup_histories_api_storage_histories_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/histories/archived": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ get: operations["archived_histories_api_storage_histories_archived_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/histories/archived/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ get: operations["archived_histories_summary_api_storage_histories_archived_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/histories/discarded": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns all discarded histories associated with the given user. */ get: operations["discarded_histories_api_storage_histories_discarded_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/storage/histories/discarded/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns information with the total storage space taken by discarded histories associated with the given user. */ get: operations["discarded_histories_summary_api_storage_histories_discarded_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Apply a new set of tags to an item. * @description Replaces the tags associated with an item with the new ones specified in the payload. * - * - The previous tags will be __deleted__. - * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. + * - The previous tags will be __deleted__. + * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. */ put: operations["update_api_tags_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tasks/{task_id}/state": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Determine state of task ID */ get: operations["state_api_tasks__task_id__state_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_data": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Lists all available data tables * @description Get the list of all available data tables. */ get: operations["index_api_tool_data_get"]; + put?: never; /** Import a data manager bundle */ post: operations["create_api_tool_data_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_data/{table_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get details of a given data table * @description Get details of a given tool data table. */ get: operations["show_api_tool_data__table_name__get"]; + put?: never; + post?: never; /** * Removes an item from a data table * @description Removes an item from a data table and reloads it to return its updated details. */ delete: operations["delete_api_tool_data__table_name__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_data/{table_name}/fields/{field_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a particular field in a tool data table * @description Reloads a data table and return its details. */ get: operations["show_field_api_tool_data__table_name__fields__field_name__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_data/{table_name}/fields/{field_name}/files/{file_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a particular field in a tool data table * @description Download a file associated with the data table field. */ get: operations["download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_data/{table_name}/reload": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Reloads a tool data table * @description Reloads a data table and return its details. */ get: operations["reload_api_tool_data__table_name__reload_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_shed_repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Lists installed tool shed repositories. */ get: operations["index_api_tool_shed_repositories_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_shed_repositories/check_for_updates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check for updates to the specified repository, or all installed repositories. */ get: operations["check_for_updates_api_tool_shed_repositories_check_for_updates_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tool_shed_repositories/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show installed tool shed repository. */ get: operations["show_api_tool_shed_repositories__id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tools/fetch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Upload files to Galaxy */ post: operations["fetch_form_api_tools_fetch_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tours": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Index * @description Return list of available tours. */ get: operations["index_api_tours_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/tours/{tour_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Show * @description Return a tour definition. */ get: operations["show_api_tours__tour_id__get"]; + put?: never; /** * Update Tour * @description Return a tour definition. */ post: operations["update_tour_api_tours__tour_id__post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Users * @description Return a collection of users. Filters will only work if enabled in config or user is admin. */ get: operations["get_users_api_users_get"]; + put?: never; /** Create a new Galaxy user. Only admins can create users for now. */ post: operations["create_user_api_users_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/current/recalculate_disk_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Triggers a recalculation of the current user disk usage. * @description This route will be removed in a future version. * - * Please use `/api/users/current/recalculate_disk_usage` instead. + * Please use `/api/users/current/recalculate_disk_usage` instead. */ put: operations["recalculate_disk_usage_api_users_current_recalculate_disk_usage_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/deleted": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Deleted Users * @description Return a collection of deleted users. Only admins can see deleted users. */ get: operations["get_deleted_users_api_users_deleted_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/deleted/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return information about a deleted user. Only admins can see deleted users. */ get: operations["get_deleted_user_api_users_deleted__user_id__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/deleted/{user_id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Restore a deleted user. Only admins can restore users. */ post: operations["undelete_user_api_users_deleted__user_id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/recalculate_disk_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Triggers a recalculation of the current user disk usage. * @deprecated * @description This route will be removed in a future version. * - * Please use `/api/users/current/recalculate_disk_usage` instead. + * Please use `/api/users/current/recalculate_disk_usage` instead. */ put: operations["recalculate_disk_usage_api_users_recalculate_disk_usage_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return information about a specified or the current user. Only admin can see deleted or other users */ get: operations["get_user_api_users__user_id__get"]; /** Update the values of a user. Only admin can update others. */ put: operations["update_user_api_users__user_id__put"]; + post?: never; /** Delete a user. Only admins can delete others or purge users. */ delete: operations["delete_user_api_users__user_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/api_key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return the user's API key */ get: operations["get_or_create_api_key_api_users__user_id__api_key_get"]; + put?: never; /** Create a new API key for the user */ post: operations["create_api_key_api_users__user_id__api_key_post"]; /** Delete the current API key of the user */ delete: operations["delete_api_key_api_users__user_id__api_key_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/api_key/detailed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return the user's API key with extra information. */ get: operations["get_api_key_detailed_api_users__user_id__api_key_detailed_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/beacon": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return information about beacon share settings * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. */ get: operations["get_beacon_settings_api_users__user_id__beacon_get"]; + put?: never; /** * Change beacon setting * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. */ post: operations["set_beacon_settings_api_users__user_id__beacon_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/custom_builds": { - /** Returns collection of custom builds. */ + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Returns collection of custom builds. */ get: operations["get_custom_builds_api_users__user_id__custom_builds_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/custom_builds/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Add new custom build. */ put: operations["add_custom_builds_api_users__user_id__custom_builds__key__put"]; + post?: never; /** Delete a custom build */ delete: operations["delete_custom_build_api_users__user_id__custom_builds__key__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/favorites/{object_type}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Add the object to user's favorites */ put: operations["set_favorite_api_users__user_id__favorites__object_type__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/favorites/{object_type}/{object_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Remove the object from user's favorites */ delete: operations["remove_favorite_api_users__user_id__favorites__object_type___object_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/objectstore_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return the user's object store usage summary broken down by object store ID */ get: operations["get_user_objectstore_usage_api_users__user_id__objectstore_usage_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/recalculate_disk_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Triggers a recalculation of the current user disk usage. */ put: operations["recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/users/{user_id}/roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get User Roles + * @description Return a list of roles associated with this user. Only admins can see user roles. + */ + get: operations["get_user_roles_api_users__user_id__roles_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/send_activation_email": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Sends activation email to user. */ post: operations["send_activation_email_api_users__user_id__send_activation_email_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/theme/{theme}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Set the user's theme choice */ put: operations["set_theme_api_users__user_id__theme__theme__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return the user's quota usage summary broken down by quota source */ get: operations["get_user_usage_api_users__user_id__usage_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/users/{user_id}/usage/{label}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Return the user's quota usage summary for a given quota source label */ get: operations["get_user_usage_for_label_api_users__user_id__usage__label__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/version": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return Galaxy version information: major/minor version, optional extra info * @description Return Galaxy version information: major/minor version, optional extra info. */ get: operations["version_api_version_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Returns visualizations for the current user. */ get: operations["index_api_visualizations_get"]; + put?: never; + /** + * Create a new visualization. + * @description Creates a new visualization using the given payload and does not require the import_id field. + * If import_id given, it imports a copy of an existing visualization into the user's workspace and does not require the rest of the payload. + */ + post: operations["create_api_visualizations_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/visualizations/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a visualization by ID. + * @description Return the visualization. + */ + get: operations["show_api_visualizations__id__get"]; + /** Update a visualization. */ + put: operations["update_api_visualizations__id__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/disable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item inaccessible by a URL link. * @description Makes this item inaccessible by a URL link and return the current sharing status. */ put: operations["disable_link_access_api_visualizations__id__disable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/enable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item accessible by a URL link. * @description Makes this item accessible by a URL link and return the current sharing status. */ put: operations["enable_link_access_api_visualizations__id__enable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item public and accessible by a URL link. * @description Makes this item publicly available by a URL link and return the current sharing status. */ put: operations["publish_api_visualizations__id__publish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/share_with_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Share this item with specific users. * @description Shares this item with specific users and return the current sharing status. */ put: operations["share_with_users_api_visualizations__id__share_with_users_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/sharing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the current sharing status of the given Visualization. * @description Return the sharing status of the item. */ get: operations["sharing_api_visualizations__id__sharing_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/slug": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set a new slug for this shared item. * @description Sets a new slug to access this item by URL. The new slug must be unique. */ put: operations["set_slug_api_visualizations__id__slug_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/visualizations/{id}/unpublish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Removes this item from the published list. * @description Removes this item from the published list and return the current sharing status. */ put: operations["unpublish_api_visualizations__id__unpublish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/whoami": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Return information about the current authenticated user * @description Return information about the current authenticated user. */ get: operations["whoami_api_whoami_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/workflow_landings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Create Landing */ + post: operations["create_landing_api_workflow_landings_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/workflow_landings/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Get Landing */ + get: operations["get_landing_api_workflow_landings__uuid__get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/api/workflow_landings/{uuid}/claim": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Claim Landing */ + post: operations["claim_landing_api_workflow_landings__uuid__claim_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Lists stored workflows viewable by the user. * @description Lists stored workflows viewable by the user. */ get: operations["index_api_workflows_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/menu": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get workflows present in the tools panel. */ get: operations["get_workflow_menu_api_workflows_menu_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Displays information needed to run a workflow. */ get: operations["show_workflow_api_workflows__workflow_id__get"]; + put?: never; + post?: never; /** Add the deleted flag to a workflow. */ delete: operations["delete_workflow_api_workflows__workflow_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/counts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get state counts for accessible workflow. */ get: operations["workflows__invocation_counts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/disable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item inaccessible by a URL link. * @description Makes this item inaccessible by a URL link and return the current sharing status. */ put: operations["disable_link_access_api_workflows__workflow_id__disable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/enable_link_access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item accessible by a URL link. * @description Makes this item accessible by a URL link and return the current sharing status. */ put: operations["enable_link_access_api_workflows__workflow_id__enable_link_access_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get the list of a user's workflow invocations. */ get: operations["index_invocations_api_workflows__workflow_id__invocations_get"]; + put?: never; /** Schedule the workflow specified by `workflow_id` to run. */ post: operations["Invoke_workflow_api_workflows__workflow_id__invocations_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations/{invocation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get detailed description of a workflow invocation. * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. */ get: operations["show_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__get"]; + put?: never; + post?: never; /** * Cancel the specified workflow invocation. * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. */ delete: operations["cancel_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations/{invocation_id}/jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get job state summary info aggregated across all current jobs of the workflow invocation. * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. */ get: operations["workflow_invocation_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations/{invocation_id}/report": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get JSON summarizing invocation for reporting. * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. */ get: operations["show_workflow_invocation_report_api_workflows__workflow_id__invocations__invocation_id__report_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations/{invocation_id}/report.pdf": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get PDF summarizing invocation for reporting. * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. */ get: operations["show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations/{invocation_id}/step_jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get job state summary info aggregated per step of the workflow invocation. * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. */ get: operations["workflow_invocation_step_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__step_jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/invocations/{invocation_id}/steps/{step_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Show details of workflow invocation step. * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. @@ -1891,44 +5408,134 @@ export interface paths { * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. */ put: operations["update_workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Makes this item public and accessible by a URL link. * @description Makes this item publicly available by a URL link and return the current sharing status. */ put: operations["publish_api_workflows__workflow_id__publish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/refactor": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** Updates the workflow stored with the given ID. */ put: operations["refactor_api_workflows__workflow_id__refactor_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/share_with_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Share this item with specific users. * @description Shares this item with specific users and return the current sharing status. */ put: operations["share_with_users_api_workflows__workflow_id__share_with_users_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/sharing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the current sharing status of the given item. * @description Return the sharing status of the item. */ get: operations["sharing_api_workflows__workflow_id__sharing_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/slug": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set a new slug for this shared item. * @description Sets a new slug to access this item by URL. The new slug must be unique. */ put: operations["set_slug_api_workflows__workflow_id__slug_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show tags based on workflow_id */ get: operations["index_api_workflows__workflow_id__tags_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/tags/{tag_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Show tag based on workflow_id */ get: operations["show_api_workflows__workflow_id__tags__tag_name__get"]; /** Update tag based on workflow_id */ @@ -1937,77 +5544,189 @@ export interface paths { post: operations["create_api_workflows__workflow_id__tags__tag_name__post"]; /** Delete tag based on workflow_id */ delete: operations["delete_api_workflows__workflow_id__tags__tag_name__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/undelete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Remove the deleted flag from a workflow. */ post: operations["undelete_workflow_api_workflows__workflow_id__undelete_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/unpublish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Removes this item from the published list. * @description Removes this item from the published list and return the current sharing status. */ put: operations["unpublish_api_workflows__workflow_id__unpublish_put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the list of a user's workflow invocations. * @deprecated */ get: operations["index_invocations_api_workflows__workflow_id__usage_get"]; + put?: never; /** * Schedule the workflow specified by `workflow_id` to run. * @deprecated */ post: operations["Invoke_workflow_api_workflows__workflow_id__usage_post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage/{invocation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get detailed description of a workflow invocation. * @deprecated * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. */ get: operations["show_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__get"]; + put?: never; + post?: never; /** * Cancel the specified workflow invocation. * @deprecated * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. */ delete: operations["cancel_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage/{invocation_id}/jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get job state summary info aggregated across all current jobs of the workflow invocation. * @deprecated * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. */ get: operations["workflow_invocation_jobs_summary_api_workflows__workflow_id__usage__invocation_id__jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage/{invocation_id}/report": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get JSON summarizing invocation for reporting. * @deprecated * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. */ get: operations["show_workflow_invocation_report_api_workflows__workflow_id__usage__invocation_id__report_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage/{invocation_id}/report.pdf": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get PDF summarizing invocation for reporting. * @deprecated * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. */ get: operations["show_workflow_invocation_report_pdf_api_workflows__workflow_id__usage__invocation_id__report_pdf_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage/{invocation_id}/step_jobs_summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get job state summary info aggregated per step of the workflow invocation. * @deprecated * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. */ get: operations["workflow_invocation_step_jobs_summary_api_workflows__workflow_id__usage__invocation_id__step_jobs_summary_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/usage/{invocation_id}/steps/{step_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Show details of workflow invocation step. * @deprecated @@ -2020,31 +5739,102 @@ export interface paths { * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. */ put: operations["update_workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__put"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/api/workflows/{workflow_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List all versions of a workflow. */ get: operations["show_versions_api_workflows__workflow_id__versions_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/ga4gh/drs/v1/objects/{object_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get Object */ get: operations["get_object_ga4gh_drs_v1_objects__object_id__get"]; + put?: never; /** Get Object */ post: operations["get_object_ga4gh_drs_v1_objects__object_id__post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/ga4gh/drs/v1/objects/{object_id}/access/{access_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get Access Url */ get: operations["get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__get"]; + put?: never; /** Get Access Url */ post: operations["get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__post"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/ga4gh/drs/v1/service-info": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Service Info */ get: operations["service_info_ga4gh_drs_v1_service_info_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/oauth2_callback": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Callback entry point for remote resource responses with OAuth2 authorization codes */ + get: operations["oauth2_callback_oauth2_callback_get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { /** APIKeyModel */ @@ -2120,22 +5910,21 @@ export interface components { /** AddInputAction */ AddInputAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "add_input"; /** Collection Type */ collection_type?: string | null; /** Default */ - default?: unknown; + default?: unknown | null; /** Label */ label?: string | null; /** * Optional * @default false */ - optional?: boolean | null; + optional: boolean | null; position?: components["schemas"]["Position"] | null; /** Restrict On Connections */ restrict_on_connections?: boolean | null; @@ -2150,14 +5939,13 @@ export interface components { * AddStepAction * @description Add a new action to the workflow. * - * After the workflow is updated, an order_index will be assigned - * and this step may cause other steps to have their output_index - * adjusted. + * After the workflow is updated, an order_index will be assigned + * and this step may cause other steps to have their output_index + * adjusted. */ AddStepAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "add_step"; @@ -2206,7 +5994,7 @@ export interface components { * @description Whether to purge the history after archiving it. It requires an `archive_export_id` to be set. * @default false */ - purge_history?: boolean; + purge_history: boolean; }; /** ArchivedHistoryDetailed */ ArchivedHistoryDetailed: { @@ -2251,7 +6039,7 @@ export interface components { * @description TODO * @default ? */ - genome_build?: string | null; + genome_build: string | null; /** * History ID * @example 0123456789ABCDEF @@ -2513,7 +6301,7 @@ export interface components { * All Datasets * @default true */ - all_datasets?: unknown; + all_datasets: unknown; /** Archive File */ archive_file?: unknown; /** Archive Source */ @@ -2522,12 +6310,78 @@ export interface components { * Archive Type * @default url */ - archive_type?: unknown; + archive_type: unknown; /** History Id */ history_id?: unknown; /** Name */ name?: unknown; }; + /** Body_create_form_api_libraries__library_id__contents_post */ + Body_create_form_api_libraries__library_id__contents_post: { + /** Create Type */ + create_type: unknown; + /** + * Dbkey + * @default ? + */ + dbkey: unknown; + /** Extended Metadata */ + extended_metadata?: unknown; + /** File Type */ + file_type?: unknown; + /** Files */ + files?: string[] | null; + /** + * Filesystem Paths + * @default + */ + filesystem_paths: unknown; + /** Folder Id */ + folder_id: unknown; + /** From Hda Id */ + from_hda_id?: unknown; + /** From Hdca Id */ + from_hdca_id?: unknown; + /** + * Ldda Message + * @default + */ + ldda_message: unknown; + /** + * Link Data Only + * @default copy_files + */ + link_data_only: unknown; + /** + * Roles + * @default + */ + roles: unknown; + /** + * Server Dir + * @default + */ + server_dir: unknown; + /** + * Tag Using Filenames + * @default false + */ + tag_using_filenames: unknown; + /** + * Tags + * @default [] + */ + tags: unknown; + /** Upload Files */ + upload_files?: unknown; + /** + * Upload Option + * @default upload_file + */ + upload_option: unknown; + /** Uuid */ + uuid?: unknown; + }; /** Body_fetch_form_api_tools_fetch_post */ Body_fetch_form_api_tools_fetch_post: { /** Files */ @@ -2545,12 +6399,10 @@ export interface components { */ action_links?: components["schemas"]["ActionLink"][] | null; /** - * Category - * @default broadcast - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ - category?: "broadcast"; + category: "broadcast"; /** * Message * @description The message of the notification (supports Markdown). @@ -2573,7 +6425,7 @@ export interface components { * @constant * @enum {string} */ - category?: "broadcast"; + category: "broadcast"; /** * Content * @description The content of the broadcast notification. Broadcast notifications are displayed prominently to all users and can contain action links to redirect the user to a specific page. @@ -2616,7 +6468,7 @@ export interface components { * @constant * @enum {string} */ - category?: "broadcast"; + category: "broadcast"; content: components["schemas"]["BroadcastNotificationContent"]; /** * Create time @@ -2694,12 +6546,12 @@ export interface components { /** * @description Features supported by this file source. * @default { - * "pagination": false, - * "search": false, - * "sorting": false - * } + * "pagination": false, + * "search": false, + * "sorting": false + * } */ - supports?: components["schemas"]["FilesSourceSupports"]; + supports: components["schemas"]["FilesSourceSupports"]; /** * Type * @description The type of the plugin. @@ -2749,6 +6601,20 @@ export interface components { */ type: "change_dbkey"; }; + /** ChatPayload */ + ChatPayload: { + /** + * Context + * @description The context for the chatbot. + * @default + */ + context: string | null; + /** + * Query + * @description The query to be sent to the chatbot. + */ + query: string; + }; /** CheckForUpdatesResponse */ CheckForUpdatesResponse: { /** @@ -2773,11 +6639,16 @@ export interface components { /** * Type * @description The digest method used to create the checksum. - * The value (e.g. `sha-256`) SHOULD be listed as `Hash Name String` in the https://www.iana.org/assignments/named-information/named-information.xhtml#hash-alg[IANA Named Information Hash Algorithm Registry]. Other values MAY be used, as long as implementors are aware of the issues discussed in https://tools.ietf.org/html/rfc6920#section-9.4[RFC6920]. - * GA4GH may provide more explicit guidance for use of non-IANA-registered algorithms in the future. Until then, if implementers do choose such an algorithm (e.g. because it's implemented by their storage provider), they SHOULD use an existing standard `type` value such as `md5`, `etag`, `crc32c`, `trunc512`, or `sha1`. + * The value (e.g. `sha-256`) SHOULD be listed as `Hash Name String` in the https://www.iana.org/assignments/named-information/named-information.xhtml#hash-alg[IANA Named Information Hash Algorithm Registry]. Other values MAY be used, as long as implementors are aware of the issues discussed in https://tools.ietf.org/html/rfc6920#section-9.4[RFC6920]. + * GA4GH may provide more explicit guidance for use of non-IANA-registered algorithms in the future. Until then, if implementers do choose such an algorithm (e.g. because it's implemented by their storage provider), they SHOULD use an existing standard `type` value such as `md5`, `etag`, `crc32c`, `trunc512`, or `sha1`. */ type: string; }; + /** ClaimLandingPayload */ + ClaimLandingPayload: { + /** Client Secret */ + client_secret?: string | null; + }; /** CleanableItemsSummary */ CleanableItemsSummary: { /** @@ -2838,12 +6709,18 @@ export interface components { CompositeDataElement: { /** Md5 */ MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** * Auto Decompress * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Collection Type */ collection_type?: string | null; composite: components["schemas"]["CompositeItems"]; @@ -2853,12 +6730,12 @@ export interface components { * Dbkey * @default ? */ - dbkey?: string; + dbkey: string; /** * Deferred * @default false */ - deferred?: boolean; + deferred: boolean; /** Description */ description?: string | null; elements_from?: components["schemas"]["ElementsFromType"] | null; @@ -2866,8 +6743,10 @@ export interface components { * Ext * @default auto */ - ext?: string; + ext: string; extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; /** Info */ info?: string | null; /** Name */ @@ -2876,10 +6755,9 @@ export interface components { * Space To Tab * @default false */ - space_to_tab?: boolean; + space_to_tab: boolean; /** - * Src - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ src: "composite"; @@ -2889,7 +6767,7 @@ export interface components { * To Posix Lines * @default false */ - to_posix_lines?: boolean; + to_posix_lines: boolean; }; /** CompositeFileInfo */ CompositeFileInfo: { @@ -2945,7 +6823,7 @@ export interface components { * @description Hash function name to use to compute dataset hashes. * @default MD5 */ - hash_function?: components["schemas"]["HashFunctionNameEnum"] | null; + hash_function: components["schemas"]["HashFunctionNameEnum"] | null; }; /** ConcreteObjectStoreModel */ ConcreteObjectStoreModel: { @@ -2979,8 +6857,7 @@ export interface components { /** ConnectAction */ ConnectAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "connect"; @@ -3018,8 +6895,8 @@ export interface components { * ConvertedDatasetsMap * @description Map of `file extension` -> `converted dataset encoded id` * @example { - * "csv": "dataset_id" - * } + * "csv": "dataset_id" + * } */ ConvertedDatasetsMap: { [key: string]: string; @@ -3055,10 +6932,11 @@ export interface components { /** * Content * @description Depending on the `source` it can be: - * - The encoded id from the library dataset - * - The encoded id from the library folder - * - The encoded id from the HDA - * - The encoded id from the HDCA + * - The encoded id from the library dataset + * - The encoded id from the library folder + * - The encoded id from the HDA + * - The encoded id from the HDCA + * */ content?: string | null; /** @@ -3066,7 +6944,7 @@ export interface components { * @description If the source is a collection, whether to copy child HDAs into the target history as well. Prior to the galaxy release 23.1 this defaulted to false. * @default true */ - copy_elements?: boolean | null; + copy_elements: boolean | null; /** * DBKey * @description TODO @@ -3087,7 +6965,7 @@ export interface components { * @description Whether to mark the original HDAs as hidden. * @default false */ - hide_source_items?: boolean | null; + hide_source_items: boolean | null; /** * History Id * @description The ID of the history that will contain the collection. Required if `instance_type=history`. @@ -3098,7 +6976,7 @@ export interface components { * @description The type of the instance, either `history` (default) or `library`. * @default history */ - instance_type?: ("history" | "library") | null; + instance_type: ("history" | "library") | null; /** * Name * @description The name of the new collection. @@ -3114,7 +6992,8 @@ export interface components { * @description The type of content to be created in the history. * @default dataset */ - type?: components["schemas"]["HistoryContentType"] | null; + type: components["schemas"]["HistoryContentType"] | null; + } & { [key: string]: unknown; }; /** CreateHistoryFromStore */ @@ -3139,6 +7018,8 @@ export interface components { template_id: string; /** Template Version */ template_version: number; + /** Uuid */ + uuid?: string | null; /** Variables */ variables: { [key: string]: string | boolean | number; @@ -3156,19 +7037,19 @@ export interface components { * Legacy Job State * @deprecated * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. * @default false */ - legacy_job_state?: boolean; + legacy_job_state: boolean; model_store_format?: components["schemas"]["ModelStoreFormat"] | null; /** * Include step details * @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary * @default false */ - step_details?: boolean; + step_details: boolean; /** Store Content Uri */ store_content_uri?: string | null; /** Store Dict */ @@ -3204,7 +7085,7 @@ export interface components { * @description The new message attribute of the LDDA created. * @default */ - ldda_message?: string | null; + ldda_message: string | null; }; /** CreateLibraryFolderPayload */ CreateLibraryFolderPayload: { @@ -3213,7 +7094,7 @@ export interface components { * @description A detailed description of the library folder. * @default */ - description?: string | null; + description: string | null; /** * Name * @description The name of the library folder. @@ -3227,7 +7108,7 @@ export interface components { * @description A detailed description of the Library. * @default */ - description?: string | null; + description: string | null; /** * Name * @description The name of the Library. @@ -3238,7 +7119,7 @@ export interface components { * @description A short text describing the contents of the Library. * @default */ - synopsis?: string | null; + synopsis: string | null; }; /** CreateMetricsPayload */ CreateMetricsPayload: { @@ -3246,7 +7127,7 @@ export interface components { * List of metrics to be recorded. * @default [] */ - metrics?: components["schemas"]["Metric"][]; + metrics: components["schemas"]["Metric"][]; }; /** CreateNewCollectionPayload */ CreateNewCollectionPayload: { @@ -3260,7 +7141,7 @@ export interface components { * @description Whether to create a copy of the source HDAs for the new collection. * @default true */ - copy_elements?: boolean | null; + copy_elements: boolean | null; /** * Element Identifiers * @description List of elements that should be in the new collection. @@ -3276,7 +7157,7 @@ export interface components { * @description Whether to mark the original HDAs as hidden. * @default false */ - hide_source_items?: boolean | null; + hide_source_items: boolean | null; /** * History Id * @description The ID of the history that will contain the collection. Required if `instance_type=history`. @@ -3287,7 +7168,7 @@ export interface components { * @description The type of the instance, either `history` (default) or `library`. * @default history */ - instance_type?: ("history" | "library") | null; + instance_type: ("history" | "library") | null; /** * Name * @description The name of the new collection. @@ -3306,13 +7187,13 @@ export interface components { * @description Raw text contents of the last page revision (type dependent on content_format). * @default */ - content?: string | null; + content: string | null; /** * Content format * @description Either `markdown` or `html`. * @default html */ - content_format?: components["schemas"]["PageContentFormat"]; + content_format: components["schemas"]["PageContentFormat"]; /** * Workflow invocation ID * @description Encoded ID used by workflow generated reports. @@ -3328,6 +7209,7 @@ export interface components { * @description The name of the page. */ title: string; + } & { [key: string]: unknown; }; /** CreateQuotaParams */ @@ -3342,7 +7224,7 @@ export interface components { * @description Whether or not this is a default quota. Valid values are ``no``, ``unregistered``, ``registered``. None is equivalent to ``no``. * @default no */ - default?: components["schemas"]["DefaultQuotaValues"]; + default: components["schemas"]["DefaultQuotaValues"]; /** * Description * @description Detailed text description for this Quota. @@ -3353,13 +7235,13 @@ export interface components { * @description A list of group IDs or names to associate with this quota. * @default [] */ - in_groups?: string[] | null; + in_groups: string[] | null; /** * Users * @description A list of user IDs or user emails to associate with this quota. * @default [] */ - in_users?: string[] | null; + in_users: string[] | null; /** * Name * @description The name of the quota. This must be unique within a Galaxy instance. @@ -3370,7 +7252,7 @@ export interface components { * @description Quotas can have one of three `operations`:- `=` : The quota is exactly the amount specified- `+` : The amount specified will be added to the amounts of the user's other associated quota definitions- `-` : The amount specified will be subtracted from the amounts of the user's other associated quota definitions * @default = */ - operation?: components["schemas"]["QuotaOperation"]; + operation: components["schemas"]["QuotaOperation"]; /** * Quota Source Label * @description If set, quota source label to apply this quota operation to. Otherwise, the default quota is used. @@ -3414,6 +7296,31 @@ export interface components { */ url: string; }; + /** + * CreateType + * @enum {string} + */ + CreateType: "file" | "folder" | "collection"; + /** CreateWorkflowLandingRequestPayload */ + CreateWorkflowLandingRequestPayload: { + /** Client Secret */ + client_secret?: string | null; + /** + * Public + * @description If workflow landing request is public anyone with the uuid can use the landing request. If not public the request must be claimed before use and additional verification might occur. + * @default false + */ + public: boolean; + /** Request State */ + request_state?: Record | null; + /** Workflow Id */ + workflow_id: string; + /** + * Workflow Target Type + * @enum {string} + */ + workflow_target_type: "stored_workflow" | "workflow" | "trs_url"; + }; /** CreatedEntryResponse */ CreatedEntryResponse: { /** @@ -3704,8 +7611,9 @@ export interface components { /** * Fasta HDAs * @description A list of label/value pairs with all the datasets of type `FASTA` contained in the History. - * - `label` is item position followed by the name of the dataset. - * - `value` is the encoded database ID of the dataset. + * - `label` is item position followed by the name of the dataset. + * - `value` is the encoded database ID of the dataset. + * */ fasta_hdas: components["schemas"]["LabelValuePair"][]; /** @@ -3931,7 +7839,7 @@ export interface components { * @description The summary information of each of the elements inside the dataset collection. * @default [] */ - elements?: components["schemas"]["DCESummary"][]; + elements: components["schemas"]["DCESummary"][]; /** * Dataset Collection ID * @example 0123456789ABCDEF @@ -3957,7 +7865,7 @@ export interface components { * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Destination */ destination: | components["schemas"]["HdaDestination"] @@ -3981,7 +7889,7 @@ export interface components { * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Destination */ destination: | components["schemas"]["HdaDestination"] @@ -4013,19 +7921,19 @@ export interface components { * @description A list of roles that can access the dataset. The user has to **have all these roles** in order to access this dataset. Users without access permission **cannot** have other permissions on this dataset. If there are no access roles set on the dataset it is considered **unrestricted**. * @default [] */ - access_dataset_roles?: string[][]; + access_dataset_roles: string[][]; /** * Manage Roles * @description A list of roles that can manage permissions on the dataset. Users with **any** of these roles can manage permissions of this dataset. If you remove yourself you will lose the ability to manage this dataset unless you are an admin. * @default [] */ - manage_dataset_roles?: string[][]; + manage_dataset_roles: string[][]; /** * Modify Roles * @description A list of roles that can modify the library item. This is a library related permission. User with **any** of these roles can modify name, metadata, and other information about this library item. * @default [] */ - modify_item_roles?: string[][]; + modify_item_roles: string[][]; }; /** DatasetCollectionAttributesResult */ DatasetCollectionAttributesResult: { @@ -4094,7 +8002,7 @@ export interface components { * Hash Function * @description The hash function used to generate the hash. */ - hash_function: components["schemas"]["HashFunctionNames"]; + hash_function: components["schemas"]["HashFunctionNameEnum"]; /** * Hash Value * @description The hash value. @@ -4147,13 +8055,13 @@ export interface components { * @description The set of roles (encoded IDs) that can access this dataset. * @default [] */ - access?: string[]; + access: string[]; /** * Management * @description The set of roles (encoded IDs) that can manage this dataset. * @default [] */ - manage?: string[]; + manage: string[]; }; /** DatasetSource */ DatasetSource: { @@ -4337,7 +8245,7 @@ export interface components { * @description If True, the associated file extension will be displayed in the `File Format` select list in the `Upload File from your computer` tool in the `Get Data` tool section of the tool panel * @default false */ - display_in_upload?: boolean; + display_in_upload: boolean; /** * Extension * @description The data type’s Dataset file extension @@ -4418,8 +8326,9 @@ export interface components { /** * Type * @description The type of the default quota. Either one of: - * - `registered`: the associated quota will affect registered users. - * - `unregistered`: the associated quota will affect unregistered users. + * - `registered`: the associated quota will affect registered users. + * - `unregistered`: the associated quota will affect unregistered users. + * */ type: components["schemas"]["DefaultQuotaTypes"]; }; @@ -4445,7 +8354,7 @@ export interface components { * @description Whether to permanently delete from disk the specified datasets. *Warning*: this is a destructive operation. * @default false */ - purge?: boolean | null; + purge: boolean | null; }; /** DeleteDatasetBatchResult */ DeleteDatasetBatchResult: { @@ -4472,7 +8381,7 @@ export interface components { * @description Whether to definitely remove this history from disk. * @default false */ - purge?: boolean; + purge: boolean; }; /** DeleteHistoryContentPayload */ DeleteHistoryContentPayload: { @@ -4481,25 +8390,25 @@ export interface components { * @description Whether to remove the dataset from storage. Datasets will only be removed from storage once all HDAs or LDDAs that refer to this datasets are deleted. * @default false */ - purge?: boolean; + purge: boolean; /** * Recursive * @description When deleting a dataset collection, whether to also delete containing datasets. * @default false */ - recursive?: boolean; + recursive: boolean; /** * Stop Job * @description Whether to stop the creating job if all the job's outputs are deleted. * @default false */ - stop_job?: boolean; + stop_job: boolean; }; /** * DeleteHistoryContentResult * @description Contains minimum information about the deletion state of a history item. * - * Can also contain any other properties of the item. + * Can also contain any other properties of the item. */ DeleteHistoryContentResult: { /** @@ -4526,7 +8435,7 @@ export interface components { * @description Whether to definitely remove this history from disk. * @default false */ - purge?: boolean; + purge: boolean; }; /** DeleteJobPayload */ DeleteJobPayload: { @@ -4551,7 +8460,7 @@ export interface components { * @description Whether to also purge the Quota after deleting it. * @default false */ - purge?: boolean; + purge: boolean; }; /** DeletedCustomBuild */ DeletedCustomBuild: { @@ -4638,8 +8547,7 @@ export interface components { /** DisconnectAction */ DisconnectAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "disconnect"; @@ -4668,7 +8576,7 @@ export interface components { }; /** DisplayApplication */ DisplayApplication: { - /** Filename */ + /** Filename */ filename_: string; /** Id */ id: string; @@ -4684,7 +8592,7 @@ export interface components { /** * Access Methods * @description The list of access methods that can be used to fetch the `DrsObject`. - * Required for single blobs; optional for bundles. + * Required for single blobs; optional for bundles. */ access_methods?: components["schemas"]["AccessMethod"][] | null; /** @@ -4695,30 +8603,30 @@ export interface components { /** * Checksums * @description The checksum of the `DrsObject`. At least one checksum must be provided. - * For blobs, the checksum is computed over the bytes in the blob. - * For bundles, the checksum is computed over a sorted concatenation of the checksums of its top-level contained objects (not recursive, names not included). The list of checksums is sorted alphabetically (hex-code) before concatenation and a further checksum is performed on the concatenated checksum value. - * For example, if a bundle contains blobs with the following checksums: - * md5(blob1) = 72794b6d - * md5(blob2) = 5e089d29 - * Then the checksum of the bundle is: - * md5( concat( sort( md5(blob1), md5(blob2) ) ) ) - * = md5( concat( sort( 72794b6d, 5e089d29 ) ) ) - * = md5( concat( 5e089d29, 72794b6d ) ) - * = md5( 5e089d2972794b6d ) - * = f7a29a04 + * For blobs, the checksum is computed over the bytes in the blob. + * For bundles, the checksum is computed over a sorted concatenation of the checksums of its top-level contained objects (not recursive, names not included). The list of checksums is sorted alphabetically (hex-code) before concatenation and a further checksum is performed on the concatenated checksum value. + * For example, if a bundle contains blobs with the following checksums: + * md5(blob1) = 72794b6d + * md5(blob2) = 5e089d29 + * Then the checksum of the bundle is: + * md5( concat( sort( md5(blob1), md5(blob2) ) ) ) + * = md5( concat( sort( 72794b6d, 5e089d29 ) ) ) + * = md5( concat( 5e089d29, 72794b6d ) ) + * = md5( 5e089d2972794b6d ) + * = f7a29a04 */ checksums: components["schemas"]["Checksum"][]; /** * Contents * @description If not set, this `DrsObject` is a single blob. - * If set, this `DrsObject` is a bundle containing the listed `ContentsObject` s (some of which may be further nested). + * If set, this `DrsObject` is a bundle containing the listed `ContentsObject` s (some of which may be further nested). */ contents?: components["schemas"]["ContentsObject"][] | null; /** * Created Time * Format: date-time * @description Timestamp of content creation in RFC3339. - * (This is the creation time of the underlying content, not of the JSON object.) + * (This is the creation time of the underlying content, not of the JSON object.) */ created_time: string; /** @@ -4739,19 +8647,19 @@ export interface components { /** * Name * @description A string that can be used to name a `DrsObject`. - * This string is made up of uppercase and lowercase letters, decimal digits, hyphen, period, and underscore [A-Za-z0-9.-_]. See http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282[portable filenames]. + * This string is made up of uppercase and lowercase letters, decimal digits, hyphen, period, and underscore [A-Za-z0-9.-_]. See http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282[portable filenames]. */ name?: string | null; /** * Self Uri * @description A drs:// hostname-based URI, as defined in the DRS documentation, that tells clients how to access this object. - * The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. + * The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around. For example, if you arrive at this DRS JSON by resolving a compact identifier-based DRS URI, the `self_uri` presents you with a hostname and properly encoded DRS ID for use in subsequent `access` endpoint calls. */ self_uri: string; /** * Size * @description For blobs, the blob size in bytes. - * For bundles, the cumulative size, in bytes, of items in the `contents` field. + * For bundles, the cumulative size, in bytes, of items in the `contents` field. */ size: number; /** @@ -4762,7 +8670,7 @@ export interface components { /** * Version * @description A string representing a version. - * (Some systems may use checksum, a RFC3339 timestamp, or an incrementing version number.) + * (Some systems may use checksum, a RFC3339 timestamp, or an incrementing version number.) */ version?: string | null; }; @@ -4902,7 +8810,7 @@ export interface components { * @description Dictionary mapping all the tool inputs (by name) to the corresponding data references. * @default {} */ - inputs?: { + inputs: { [key: string]: components["schemas"]["EncodedDatasetJobInfo"]; }; /** @@ -4921,7 +8829,7 @@ export interface components { * Output collections * @default {} */ - output_collections?: { + output_collections: { [key: string]: components["schemas"]["EncodedHdcaSourceId"]; }; /** @@ -4929,7 +8837,7 @@ export interface components { * @description Dictionary mapping all the tool outputs (by name) to the corresponding data references. * @default {} */ - outputs?: { + outputs: { [key: string]: components["schemas"]["EncodedDatasetJobInfo"]; }; /** @@ -4958,6 +8866,11 @@ export interface components { * @description The email of the user that owns this job. Only the owner of the job and administrators can see this value. */ user_email?: string | null; + /** + * User Id + * @description User ID of user that ran this job + */ + user_id?: string | null; }; /** EncodedJobParameterHistoryItem */ EncodedJobParameterHistoryItem: { @@ -4998,19 +8911,19 @@ export interface components { * @description Whether to export as gzip archive. * @default true */ - gzip?: boolean | null; + gzip: boolean | null; /** * Include Deleted * @description Whether to include deleted datasets in the exported archive. * @default false */ - include_deleted?: boolean | null; + include_deleted: boolean | null; /** * Include Hidden * @description Whether to include hidden datasets in the exported archive. * @default false */ - include_hidden?: boolean | null; + include_hidden: boolean | null; }; /** ExportObjectMetadata */ ExportObjectMetadata: { @@ -5055,24 +8968,24 @@ export interface components { * @description Include file contents for deleted datasets (if include_files is True). * @default false */ - include_deleted?: boolean; + include_deleted: boolean; /** * Include Files * @description include materialized files in export when available * @default true */ - include_files?: boolean; + include_files: boolean; /** * Include hidden * @description Include file contents for hidden datasets (if include_files is True). * @default false */ - include_hidden?: boolean; + include_hidden: boolean; /** * @description format of model store to export * @default tar.gz */ - model_store_format?: components["schemas"]["ModelStoreFormat"]; + model_store_format: components["schemas"]["ModelStoreFormat"]; /** * Target URI * @description Galaxy Files URI to write mode store content to. @@ -5098,7 +9011,7 @@ export interface components { * @description Prevent Galaxy from checking for a single file in a directory and re-interpreting the archive * @default true */ - fuzzy_root?: boolean | null; + fuzzy_root: boolean | null; /** Items From */ items_from?: string | null; src: components["schemas"]["Src"]; @@ -5111,8 +9024,7 @@ export interface components { /** ExtractInputAction */ ExtractInputAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "extract_input"; @@ -5125,8 +9037,7 @@ export interface components { /** ExtractUntypedParameter */ ExtractUntypedParameter: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "extract_untyped_parameter"; @@ -5173,18 +9084,35 @@ export interface components { | components["schemas"]["HdcaDataItemsFromTarget"] | components["schemas"]["FtpImportTarget"] )[]; + } & { [key: string]: unknown; }; + /** FetchDatasetHash */ + FetchDatasetHash: { + /** + * Hash Function + * @enum {string} + */ + hash_function: "MD5" | "SHA-1" | "SHA-256" | "SHA-512"; + /** Hash Value */ + hash_value: string; + }; /** FileDataElement */ FileDataElement: { /** Md5 */ MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** * Auto Decompress * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Collection Type */ collection_type?: string | null; /** Created From Basename */ @@ -5193,12 +9121,12 @@ export interface components { * Dbkey * @default ? */ - dbkey?: string; + dbkey: string; /** * Deferred * @default false */ - deferred?: boolean; + deferred: boolean; /** Description */ description?: string | null; elements_from?: components["schemas"]["ElementsFromType"] | null; @@ -5206,8 +9134,10 @@ export interface components { * Ext * @default auto */ - ext?: string; + ext: string; extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; /** Info */ info?: string | null; /** Name */ @@ -5216,10 +9146,9 @@ export interface components { * Space To Tab * @default false */ - space_to_tab?: boolean; + space_to_tab: boolean; /** - * Src - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ src: "files"; @@ -5229,13 +9158,12 @@ export interface components { * To Posix Lines * @default false */ - to_posix_lines?: boolean; + to_posix_lines: boolean; }; /** FileDefaultsAction */ FileDefaultsAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "fill_defaults"; @@ -5288,8 +9216,7 @@ export interface components { state: components["schemas"]["DatasetState"]; tags: components["schemas"]["TagCollection"]; /** - * Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "file"; @@ -5310,7 +9237,7 @@ export interface components { * Hidden * @default false */ - hidden?: boolean; + hidden: boolean; /** Id */ id: string; /** Name */ @@ -5321,7 +9248,7 @@ export interface components { * Type * @enum {string} */ - type: "ftp" | "posix" | "s3fs" | "azure"; + type: "ftp" | "posix" | "s3fs" | "azure" | "onedata" | "webdav" | "dropbox" | "googledrive"; /** Variables */ variables?: | ( @@ -5335,7 +9262,7 @@ export interface components { * Version * @default 0 */ - version?: number; + version: number; }; /** FilesSourcePlugin */ FilesSourcePlugin: { @@ -5372,12 +9299,12 @@ export interface components { /** * @description Features supported by this file source. * @default { - * "pagination": false, - * "search": false, - * "sorting": false - * } + * "pagination": false, + * "search": false, + * "sorting": false + * } */ - supports?: components["schemas"]["FilesSourceSupports"]; + supports: components["schemas"]["FilesSourceSupports"]; /** * Type * @description The type of the plugin. @@ -5409,25 +9336,24 @@ export interface components { * @description Whether this file source supports server-side pagination. * @default false */ - pagination?: boolean; + pagination: boolean; /** * Search * @description Whether this file source supports server-side search. * @default false */ - search?: boolean; + search: boolean; /** * Sorting * @description Whether this file source supports server-side sorting. * @default false */ - sorting?: boolean; + sorting: boolean; }; /** FillStepDefaultsAction */ FillStepDefaultsAction: { /** - * Action Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ action_type: "fill_step_defaults"; @@ -5453,7 +9379,7 @@ export interface components { * @description A detailed description of the library folder. * @default */ - description?: string | null; + description: string | null; /** * Id * @example 0123456789ABCDEF @@ -5462,8 +9388,7 @@ export interface components { /** Name */ name: string; /** - * Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "folder"; @@ -5478,12 +9403,18 @@ export interface components { FtpImportElement: { /** Md5 */ MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** * Auto Decompress * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Collection Type */ collection_type?: string | null; /** Created From Basename */ @@ -5492,12 +9423,12 @@ export interface components { * Dbkey * @default ? */ - dbkey?: string; + dbkey: string; /** * Deferred * @default false */ - deferred?: boolean; + deferred: boolean; /** Description */ description?: string | null; elements_from?: components["schemas"]["ElementsFromType"] | null; @@ -5505,10 +9436,12 @@ export interface components { * Ext * @default auto */ - ext?: string; + ext: string; extra_files?: components["schemas"]["ExtraFiles"] | null; /** Ftp Path */ ftp_path: string; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; /** Info */ info?: string | null; /** Name */ @@ -5517,10 +9450,9 @@ export interface components { * Space To Tab * @default false */ - space_to_tab?: boolean; + space_to_tab: boolean; /** - * Src - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ src: "ftp_import"; @@ -5530,7 +9462,7 @@ export interface components { * To Posix Lines * @default false */ - to_posix_lines?: boolean; + to_posix_lines: boolean; }; /** FtpImportTarget */ FtpImportTarget: { @@ -5539,7 +9471,7 @@ export interface components { * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Collection Type */ collection_type?: string | null; destination: components["schemas"]["HdcaDestination"]; @@ -5568,12 +9500,12 @@ export interface components { * role IDs * @default [] */ - role_ids?: string[]; + role_ids: string[]; /** * user IDs * @default [] */ - user_ids?: string[]; + user_ids: string[]; }; /** * GroupListResponse @@ -5725,6 +9657,11 @@ export interface components { * @description TODO */ api_type?: "file" | null; + /** + * Copied From History Dataset Association Id + * @description ID of HDA this HDA was copied from. + */ + copied_from_history_dataset_association_id?: string | null; /** Copied From Ldda Id */ copied_from_ldda_id?: string | null; /** @@ -5842,7 +9779,7 @@ export interface components { * Metadata * @description The metadata associated with this dataset. */ - metadata?: unknown; + metadata?: unknown | null; /** * Miscellaneous Blurb * @description TODO @@ -5943,6 +9880,7 @@ export interface components { * @description The collection of visualizations that can be applied to this dataset. */ visualizations?: components["schemas"]["Visualization"][] | null; + } & { [key: string]: unknown; }; /** @@ -5968,7 +9906,12 @@ export interface components { * @constant * @enum {string} */ - api_type?: "file"; + api_type: "file"; + /** + * Copied From History Dataset Association Id + * @description ID of HDA this HDA was copied from. + */ + copied_from_history_dataset_association_id?: string | null; /** Copied From Ldda Id */ copied_from_ldda_id?: string | null; /** @@ -6047,7 +9990,7 @@ export interface components { * @description TODO * @default ? */ - genome_build?: string | null; + genome_build: string | null; /** * Hashes * @description The list of hashes associated with this dataset. @@ -6058,7 +10001,7 @@ export interface components { * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). * @default hda */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; + hda_ldda: components["schemas"]["DatasetSourceType"]; /** * HID * @description The index position of this item in the History. @@ -6090,7 +10033,7 @@ export interface components { * Metadata * @description The metadata associated with this dataset. */ - metadata?: unknown; + metadata?: unknown | null; /** * Miscellaneous Blurb * @description TODO @@ -6156,7 +10099,7 @@ export interface components { * @constant * @enum {string} */ - type?: "file"; + type: "file"; /** * Type - ID * @description The type and the encoded ID of this item. Used for caching. @@ -6292,7 +10235,7 @@ export interface components { * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). * @default hda */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; + hda_ldda: components["schemas"]["DatasetSourceType"]; /** * History ID * @example 0123456789ABCDEF @@ -6319,6 +10262,7 @@ export interface components { state: components["schemas"]["DatasetState"]; /** Tags */ tags: string[]; + } & { [key: string]: unknown; }; /** @@ -6354,7 +10298,7 @@ export interface components { * @description TODO * @default ? */ - genome_build?: string | null; + genome_build: string | null; /** * HID * @description The index position of this item in the History. @@ -6420,36 +10364,33 @@ export interface components { */ visible: boolean; }; - /** - * HDCADetailed - * @description History Dataset Collection Association detailed information. - */ - HDCADetailed: { + /** HDCACustom */ + HDCACustom: { /** * Dataset Collection ID * @example 0123456789ABCDEF */ - collection_id: string; + collection_id?: string; /** * Collection Type * @description The type of the collection, can be `list`, `paired`, or define subcollections using `:` as separator like `list:paired` or `list:list`. */ - collection_type: string; + collection_type?: string | null; /** * Contents URL * @description The relative URL to access the contents of this History. */ - contents_url: string; + contents_url?: string | null; /** * Create Time * @description The time and date this item was created. */ - create_time: string | null; + create_time?: string | null; /** * Deleted * @description Whether this item is marked as deleted. */ - deleted: boolean; + deleted?: boolean | null; /** * Element Count * @description The number of elements contained in the dataset collection. It may be None or undefined if the collection could not be populated. @@ -6458,36 +10399,33 @@ export interface components { /** * Elements * @description The summary information of each of the elements inside the dataset collection. - * @default [] */ - elements?: components["schemas"]["DCESummary"][]; + elements?: components["schemas"]["DCESummary"][] | null; /** * Elements Datatypes * @description A set containing all the different element datatypes in the collection. */ - elements_datatypes: string[]; + elements_datatypes?: string[] | null; /** * HID * @description The index position of this item in the History. */ - hid: number; + hid?: number | null; /** * History Content Type * @description This is always `dataset_collection` for dataset collections. - * @constant - * @enum {string} */ - history_content_type: "dataset_collection"; + history_content_type?: "dataset_collection" | null; /** * History ID * @example 0123456789ABCDEF */ - history_id: string; + history_id?: string; /** * Id * @example 0123456789ABCDEF */ - id: string; + id?: string; /** * Implicit Collection Jobs Id * @description Encoded ID for the ICJ object describing the collection of jobs corresponding to this collection @@ -6512,38 +10450,34 @@ export interface components { * Model class * @description The name of the database model class. * @constant - * @enum {string} */ - model_class: "HistoryDatasetCollectionAssociation"; + model_class?: "HistoryDatasetCollectionAssociation"; /** * Name * @description The name of the item. */ - name: string | null; + name?: string | null; /** * Populated * @description Whether the dataset collection elements (and any subcollections elements) were successfully populated. */ - populated?: boolean; + populated?: boolean | null; /** * Populated State * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. */ - populated_state: components["schemas"]["DatasetCollectionPopulatedState"]; + populated_state?: components["schemas"]["DatasetCollectionPopulatedState"] | null; /** * Populated State Message * @description Optional message with further information in case the population of the dataset collection failed. */ populated_state_message?: string | null; - tags: components["schemas"]["TagCollection"]; + tags?: components["schemas"]["TagCollection"] | null; /** * Type * @description This is always `collection` for dataset collections. - * @default collection - * @constant - * @enum {string} */ - type?: "collection"; + type?: "collection" | null; /** * Type - ID * @description The type and the encoded ID of this item. Used for caching. @@ -6553,24 +10487,24 @@ export interface components { * Update Time * @description The last time and date this item was updated. */ - update_time: string | null; + update_time?: string | null; /** * URL * @deprecated * @description The relative URL to access this item. */ - url: string; + url?: string | null; /** * Visible * @description Whether this item is visible or hidden to the user by default. */ - visible: boolean; + visible?: boolean | null; }; /** - * HDCASummary - * @description History Dataset Collection Association summary information. + * HDCADetailed + * @description History Dataset Collection Association detailed information. */ - HDCASummary: { + HDCADetailed: { /** * Dataset Collection ID * @example 0123456789ABCDEF @@ -6602,8 +10536,159 @@ export interface components { */ element_count?: number | null; /** - * HID - * @description The index position of this item in the History. + * Elements + * @description The summary information of each of the elements inside the dataset collection. + * @default [] + */ + elements: components["schemas"]["DCESummary"][]; + /** + * Elements Datatypes + * @description A set containing all the different element datatypes in the collection. + */ + elements_datatypes: string[]; + /** + * HID + * @description The index position of this item in the History. + */ + hid: number; + /** + * History Content Type + * @description This is always `dataset_collection` for dataset collections. + * @constant + * @enum {string} + */ + history_content_type: "dataset_collection"; + /** + * History ID + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** + * Implicit Collection Jobs Id + * @description Encoded ID for the ICJ object describing the collection of jobs corresponding to this collection + */ + implicit_collection_jobs_id?: string | null; + /** + * Job Source ID + * @description The encoded ID of the Job that produced this dataset collection. Used to track the state of the job. + */ + job_source_id?: string | null; + /** + * Job Source Type + * @description The type of job (model class) that produced this dataset collection. Used to track the state of the job. + */ + job_source_type?: components["schemas"]["JobSourceType"] | null; + /** + * Job State Summary + * @description Overview of the job states working inside the dataset collection. + */ + job_state_summary?: components["schemas"]["HDCJobStateSummary"] | null; + /** + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} + */ + model_class: "HistoryDatasetCollectionAssociation"; + /** + * Name + * @description The name of the item. + */ + name: string | null; + /** + * Populated + * @description Whether the dataset collection elements (and any subcollections elements) were successfully populated. + */ + populated?: boolean; + /** + * Populated State + * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. + */ + populated_state: components["schemas"]["DatasetCollectionPopulatedState"]; + /** + * Populated State Message + * @description Optional message with further information in case the population of the dataset collection failed. + */ + populated_state_message?: string | null; + tags: components["schemas"]["TagCollection"]; + /** + * Type + * @description This is always `collection` for dataset collections. + * @default collection + * @constant + * @enum {string} + */ + type: "collection"; + /** + * Type - ID + * @description The type and the encoded ID of this item. Used for caching. + */ + type_id?: string | null; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * URL + * @deprecated + * @description The relative URL to access this item. + */ + url: string; + /** + * Visible + * @description Whether this item is visible or hidden to the user by default. + */ + visible: boolean; + }; + /** + * HDCASummary + * @description History Dataset Collection Association summary information. + */ + HDCASummary: { + /** + * Dataset Collection ID + * @example 0123456789ABCDEF + */ + collection_id: string; + /** + * Collection Type + * @description The type of the collection, can be `list`, `paired`, or define subcollections using `:` as separator like `list:paired` or `list:list`. + */ + collection_type: string; + /** + * Contents URL + * @description The relative URL to access the contents of this History. + */ + contents_url: string; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** + * Deleted + * @description Whether this item is marked as deleted. + */ + deleted: boolean; + /** + * Element Count + * @description The number of elements contained in the dataset collection. It may be None or undefined if the collection could not be populated. + */ + element_count?: number | null; + /** + * Elements Datatypes + * @description A set containing all the different element datatypes in the collection. + */ + elements_datatypes: string[]; + /** + * HID + * @description The index position of this item in the History. */ hid: number; /** @@ -6668,7 +10753,7 @@ export interface components { * @constant * @enum {string} */ - type?: "collection"; + type: "collection"; /** * Type - ID * @description The type and the encoded ID of this item. Used for caching. @@ -6701,103 +10786,96 @@ export interface components { * @description Total number of jobs associated with a dataset collection. * @default 0 */ - all_jobs?: number; + all_jobs: number; /** * Deleted jobs * @description Number of jobs in the `deleted` state. * @default 0 */ - deleted?: number; + deleted: number; /** * Deleted new jobs * @description Number of jobs in the `deleted_new` state. * @default 0 */ - deleted_new?: number; + deleted_new: number; /** * Jobs with errors * @description Number of jobs in the `error` state. * @default 0 */ - error?: number; + error: number; /** * Failed jobs * @description Number of jobs in the `failed` state. * @default 0 */ - failed?: number; + failed: number; /** * New jobs * @description Number of jobs in the `new` state. * @default 0 */ - new?: number; + new: number; /** * OK jobs * @description Number of jobs in the `ok` state. * @default 0 */ - ok?: number; + ok: number; /** * Paused jobs * @description Number of jobs in the `paused` state. * @default 0 */ - paused?: number; + paused: number; /** * Queued jobs * @description Number of jobs in the `queued` state. * @default 0 */ - queued?: number; + queued: number; /** * Resubmitted jobs * @description Number of jobs in the `resubmitted` state. * @default 0 */ - resubmitted?: number; + resubmitted: number; /** * Running jobs * @description Number of jobs in the `running` state. * @default 0 */ - running?: number; + running: number; /** * Skipped jobs * @description Number of jobs that were skipped due to conditional workflow step execution. * @default 0 */ - skipped?: number; + skipped: number; /** * Upload jobs * @description Number of jobs in the `upload` state. * @default 0 */ - upload?: number; + upload: number; /** * Waiting jobs * @description Number of jobs in the `waiting` state. * @default 0 */ - waiting?: number; + waiting: number; }; /** * HashFunctionNameEnum - * @description Particular pieces of information that can be requested for a dataset. + * @description Hash function names that can be used to generate checksums for files. * @enum {string} */ HashFunctionNameEnum: "MD5" | "SHA-1" | "SHA-256" | "SHA-512"; - /** - * HashFunctionNames - * @description Hash function names that can be used to generate checksums for datasets. - * @enum {string} - */ - HashFunctionNames: "MD5" | "SHA-1" | "SHA-256" | "SHA-512"; /** HdaDestination */ HdaDestination: { /** - * Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "hdas"; @@ -6809,7 +10887,7 @@ export interface components { * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Collection Type */ collection_type?: string | null; destination: components["schemas"]["HdcaDestination"]; @@ -6835,7 +10913,7 @@ export interface components { * @description Decompress compressed data before sniffing? * @default false */ - auto_decompress?: boolean; + auto_decompress: boolean; /** Collection Type */ collection_type?: string | null; destination: components["schemas"]["HdcaDestination"]; @@ -6896,17 +10974,17 @@ export interface components { * Avatar Template * @description The avatar template of the user. */ - avatar_template: string; + avatar_template: string | null; /** * Blurb * @description The blurb of the post. */ - blurb: string; + blurb: string | null; /** * Created At * @description The creation date of the post. */ - created_at: string; + created_at: string | null; /** * Id * @description The ID of the post. @@ -6916,34 +10994,35 @@ export interface components { * Like Count * @description The number of likes of the post. */ - like_count: number; + like_count: number | null; /** * Name * @description The name of the post. */ - name: string; + name: string | null; /** * Post Number * @description The post number of the post. */ - post_number: number; + post_number: number | null; /** * Topic Id * @description The ID of the topic of the post. */ - topic_id: number; + topic_id: number | null; /** * Username * @description The username of the post author. */ - username: string; + username: string | null; + } & { [key: string]: unknown; }; /** * HelpForumSearchResponse * @description Response model for the help search API endpoint. * - * This model is based on the Discourse API response for the search endpoint. + * This model is based on the Discourse API response for the search endpoint. */ HelpForumSearchResponse: { /** @@ -7090,7 +11169,7 @@ export interface components { * Tags Descriptions * @description The descriptions of the tags of the topic. */ - tags_descriptions?: unknown; + tags_descriptions?: unknown | null; /** * Title * @description The title of the topic. @@ -7208,13 +11287,14 @@ export interface components { /** * HistoryContentsResult * @description List of history content items. - * Can contain different views and kinds of items. + * Can contain different views and kinds of items. */ HistoryContentsResult: ( | components["schemas"]["HDACustom"] | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -7232,6 +11312,7 @@ export interface components { | components["schemas"]["HDADetailed"] | components["schemas"]["HDASummary"] | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] | components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"] )[]; @@ -7282,7 +11363,7 @@ export interface components { * @description TODO * @default ? */ - genome_build?: string | null; + genome_build: string | null; /** * History ID * @example 0123456789ABCDEF @@ -7478,9 +11559,7 @@ export interface components { */ id: string; /** - * Model class - * @description The name of the database model class. - * @constant + * @description The name of the database model class. (enum property replaced by openapi-typescript) * @enum {string} */ model: "ImplicitCollectionJobs"; @@ -7494,7 +11573,7 @@ export interface components { * @description A dictionary of job states and the number of jobs in that state. * @default {} */ - states?: { + states: { [key: string]: number; }; }; @@ -7513,8 +11592,7 @@ export interface components { */ id: string; /** - * src - * @description Indicates that the tool data should be resolved from a dataset. + * @description Indicates that the tool data should be resolved from a dataset. (enum property replaced by openapi-typescript) * @enum {string} */ src: "hda" | "ldda"; @@ -7522,9 +11600,7 @@ export interface components { /** ImportToolDataBundleUriSource */ ImportToolDataBundleUriSource: { /** - * src - * @description Indicates that the tool data should be resolved by a URI. - * @constant + * @description Indicates that the tool data should be resolved by a URI. (enum property replaced by openapi-typescript) * @enum {string} */ src: "uri"; @@ -7569,8 +11645,7 @@ export interface components { */ tool_version?: string | null; /** - * Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "data_collection_input"; @@ -7612,8 +11687,7 @@ export interface components { */ tool_version?: string | null; /** - * Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "data_input"; @@ -7655,8 +11729,7 @@ export interface components { */ tool_version?: string | null; /** - * Type - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "parameter_input"; @@ -7739,7 +11812,7 @@ export interface components { * Error Message * @default Installation error message, the empty string means no error was recorded */ - error_message?: string; + error_message: string; /** * ID * @description Encoded ID of the install tool shed repository. @@ -7789,8 +11862,7 @@ export interface components { */ history_id: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "history_deleted"; @@ -7798,8 +11870,7 @@ export interface components { /** InvocationCancellationReviewFailedResponse */ InvocationCancellationReviewFailedResponse: { /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "cancelled_on_review"; @@ -7812,8 +11883,7 @@ export interface components { /** InvocationCancellationUserRequestResponse */ InvocationCancellationUserRequestResponse: { /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "user_request"; @@ -7826,8 +11896,7 @@ export interface components { */ output_name: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "workflow_output_not_found"; @@ -7848,8 +11917,7 @@ export interface components { */ hdca_id: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "collection_failed"; @@ -7873,8 +11941,7 @@ export interface components { */ hda_id: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "dataset_failed"; @@ -7892,8 +11959,7 @@ export interface components { */ details?: string | null; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "expression_evaluation_failed"; @@ -7917,8 +11983,7 @@ export interface components { */ job_id: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "job_failed"; @@ -7938,8 +12003,7 @@ export interface components { /** Tool or module output name that was referenced but not produced */ output_name: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "output_not_found"; @@ -7957,8 +12021,7 @@ export interface components { */ details: string; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "when_not_boolean"; @@ -7968,6 +12031,21 @@ export interface components { */ workflow_step_id: number; }; + /** InvocationFailureWorkflowParameterInvalidResponse */ + InvocationFailureWorkflowParameterInvalidResponse: { + /** + * Details + * @description Message raised by validator + */ + details: string; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + reason: "workflow_parameter_invalid"; + /** Workflow parameter step that failed validation */ + workflow_step_id: number; + }; /** InvocationInput */ InvocationInput: { /** @@ -8038,6 +12116,19 @@ export interface components { [key: string]: number; }; }; + InvocationMessageResponseUnion: + | components["schemas"]["InvocationCancellationReviewFailedResponse"] + | components["schemas"]["InvocationCancellationHistoryDeletedResponse"] + | components["schemas"]["InvocationCancellationUserRequestResponse"] + | components["schemas"]["InvocationFailureDatasetFailedResponse"] + | components["schemas"]["InvocationFailureCollectionFailedResponse"] + | components["schemas"]["InvocationFailureJobFailedResponse"] + | components["schemas"]["InvocationFailureOutputNotFoundResponse"] + | components["schemas"]["InvocationFailureExpressionEvaluationFailedResponse"] + | components["schemas"]["InvocationFailureWhenNotBooleanResponse"] + | components["schemas"]["InvocationUnexpectedFailureResponse"] + | components["schemas"]["InvocationEvaluationWarningWorkflowOutputNotFoundResponse"] + | components["schemas"]["InvocationFailureWorkflowParameterInvalidResponse"]; /** InvocationOutput */ InvocationOutput: { /** @@ -8155,7 +12246,7 @@ export interface components { * @constant * @enum {string} */ - render_format?: "markdown"; + render_format: "markdown"; /** * Title * @description The name of the report. @@ -8186,7 +12277,14 @@ export interface components { * InvocationState * @enum {string} */ - InvocationState: "new" | "ready" | "scheduled" | "cancelled" | "cancelling" | "failed"; + InvocationState: + | "new" + | "requires_materialization" + | "ready" + | "scheduled" + | "cancelled" + | "cancelling" + | "failed"; /** * InvocationStep * @description Information about workflow invocation step @@ -8214,7 +12312,7 @@ export interface components { * @description Jobs associated with the workflow invocation step. * @default [] */ - jobs?: components["schemas"]["JobBaseModel"][]; + jobs: components["schemas"]["JobBaseModel"][]; /** * Model class * @description The name of the database model class. @@ -8232,7 +12330,7 @@ export interface components { * @description The dataset collection outputs of the workflow invocation step. * @default {} */ - output_collections?: { + output_collections: { [key: string]: components["schemas"]["InvocationStepCollectionOutput"]; }; /** @@ -8240,7 +12338,7 @@ export interface components { * @description The outputs of the workflow invocation step. * @default {} */ - outputs?: { + outputs: { [key: string]: components["schemas"]["InvocationStepOutput"]; }; /** @@ -8287,7 +12385,7 @@ export interface components { * @constant * @enum {string} */ - src?: "hdca"; + src: "hdca"; }; /** InvocationStepJobsResponseCollectionJobsModel */ InvocationStepJobsResponseCollectionJobsModel: { @@ -8385,7 +12483,7 @@ export interface components { * @constant * @enum {string} */ - src?: "hda"; + src: "hda"; /** * UUID * @description Universal unique identifier of the workflow step output dataset. @@ -8405,8 +12503,7 @@ export interface components { */ details?: string | null; /** - * Reason - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ reason: "unexpected_failure"; @@ -8431,26 +12528,27 @@ export interface components { * @description Indicates if tool state corrections are allowed for workflow invocation. * @default false */ - allow_tool_state_corrections?: boolean | null; + allow_tool_state_corrections: boolean | null; /** * Batch * @description Indicates if the workflow is invoked as a batch. * @default false */ - batch?: boolean | null; + batch: boolean | null; /** - * Dataset Map - * @description TODO + * Legacy Dataset Map + * @deprecated + * @description An older alternative to specifying inputs using database IDs, do not use this and use inputs instead * @default {} */ - ds_map?: { + ds_map: { [key: string]: Record; } | null; /** * Effective Outputs * @description TODO */ - effective_outputs?: unknown; + effective_outputs?: unknown | null; /** * History * @description The encoded history id - passed exactly like this 'hist_id=...' - into which to import. Or the name of the new history into which to import. @@ -8463,12 +12561,12 @@ export interface components { history_id?: string | null; /** * Inputs - * @description TODO + * @description Specify values for formal inputs to the workflow */ inputs?: Record | null; /** * Inputs By - * @description How inputs maps to inputs (datasets/collections) to workflows steps. + * @description How the 'inputs' field maps its inputs (datasets/collections/step parameters) to workflows steps. */ inputs_by?: string | null; /** @@ -8476,13 +12574,13 @@ export interface components { * @description True when fetching by Workflow ID, False when fetching by StoredWorkflow ID * @default false */ - instance?: boolean | null; + instance: boolean | null; /** * Legacy * @description Indicating if to use legacy workflow invocation. * @default false */ - legacy?: boolean | null; + legacy: boolean | null; /** * New History Name * @description The name of the new history into which to import. @@ -8493,68 +12591,63 @@ export interface components { * @description Indicates if the workflow invocation should not be added to the history. * @default false */ - no_add_to_history?: boolean | null; + no_add_to_history: boolean | null; /** - * Parameters - * @description The raw parameters for the workflow invocation. + * Legacy Step Parameters + * @description Parameters specified per-step for the workflow invocation, this is legacy and you should generally use inputs and only specify the formal parameters of a workflow instead. * @default {} */ - parameters?: Record | null; + parameters: Record | null; /** - * Parameters Normalized - * @description Indicates if parameters are already normalized for workflow invocation. + * Legacy Step Parameters Normalized + * @description Indicates if legacy parameters are already normalized to be indexed by the order_index and are specified as a dictionary per step. Legacy-style parameters could previously be specified as one parameter per step or by tool ID. * @default false */ - parameters_normalized?: boolean | null; + parameters_normalized: boolean | null; /** * Preferred Intermediate Object Store ID - * @description The ID of the ? object store that should be used to store ? datasets in this history. + * @description The ID of the object store that should be used to store the intermediate datasets of this workflow - - Galaxy's job configuration may override this in some cases but this workflow preference will override tool and user preferences */ preferred_intermediate_object_store_id?: string | null; /** * Preferred Object Store ID - * @description The ID of the object store that should be used to store new datasets in this history. + * @description The ID of the object store that should be used to store all datasets (can instead specify object store IDs for intermediate and outputs datasts separately) - - Galaxy's job configuration may override this in some cases but this workflow preference will override tool and user preferences */ preferred_object_store_id?: string | null; /** * Preferred Outputs Object Store ID - * @description The ID of the object store that should be used to store ? datasets in this history. + * @description The ID of the object store that should be used to store the marked output datasets of this workflow - Galaxy's job configuration may override this in some cases but this workflow preference will override tool and user preferences. */ preferred_outputs_object_store_id?: string | null; /** * Replacement Parameters - * @description TODO + * @description Class of parameters mostly used for string replacement in PJAs. In best practice workflows, these should be replaced with input parameters * @default {} */ - replacement_params?: Record | null; + replacement_params: Record | null; /** * Require Exact Tool Versions * @description If true, exact tool versions are required for workflow invocation. * @default true */ - require_exact_tool_versions?: boolean | null; + require_exact_tool_versions: boolean | null; /** * Resource Parameters - * @description TODO + * @description If a workflow_resource_params_file file is defined and the target workflow is configured to consumer resource parameters, they can be specified with this parameter. See https://github.com/galaxyproject/galaxy/pull/4830 for more information. * @default {} */ - resource_params?: Record | null; + resource_params: Record | null; /** * Scheduler * @description Scheduler to use for workflow invocation. */ scheduler?: string | null; - /** - * Step Parameters - * @description TODO - */ - step_parameters?: Record | null; /** * Use cached job * @description Indicated whether to use a cached job for workflow invocation. * @default false */ - use_cached_job?: boolean | null; + use_cached_job: boolean | null; /** * Version * @description The version of the workflow to invoke. @@ -8667,6 +12760,24 @@ export interface components { */ update_time: string; }; + /** JobConsoleOutput */ + JobConsoleOutput: { + /** + * Job State + * @description The current job's state + */ + state?: components["schemas"]["JobState"] | null; + /** + * STDERR + * @description Tool STDERR from job. + */ + stderr?: string | null; + /** + * STDOUT + * @description Tool STDOUT from job. + */ + stdout?: string | null; + }; /** JobDestinationParams */ JobDestinationParams: { /** @@ -8684,6 +12795,7 @@ export interface components { * @description ID assigned to submitted job by external job running system */ "Runner Job ID"?: string | null; + } & { [key: string]: unknown; }; /** JobDisplayParametersSummary */ @@ -8878,12 +12990,12 @@ export interface components { /** * JobMetric * @example { - * "name": "start_epoch", - * "plugin": "core", - * "raw_value": "1614261340.0000000", - * "title": "Job Start Time", - * "value": "2021-02-25 14:55:40" - * } + * "name": "start_epoch", + * "plugin": "core", + * "raw_value": "1614261340.0000000", + * "title": "Job Start Time", + * "value": "2021-02-25 14:55:40" + * } */ JobMetric: { /** @@ -8965,7 +13077,12 @@ export interface components { * Value * @description The values of the job parameter */ - value?: components["schemas"]["EncodedJobParameterHistoryItem"][] | number | boolean | string | null; + value?: + | (components["schemas"]["EncodedJobParameterHistoryItem"] | null)[] + | number + | boolean + | string + | null; }; /** * JobSourceType @@ -9001,9 +13118,7 @@ export interface components { */ id: string; /** - * Model class - * @description The name of the database model class. - * @constant + * @description The name of the database model class. (enum property replaced by openapi-typescript) * @enum {string} */ model: "Job"; @@ -9017,7 +13132,7 @@ export interface components { * @description A dictionary of job states and the number of jobs in that state. * @default {} */ - states?: { + states: { [key: string]: number; }; }; @@ -9117,6 +13232,11 @@ export interface components { */ value: string; }; + /** + * LandingRequestState + * @enum {string} + */ + LandingRequestState: "unclaimed" | "claimed"; /** LegacyLibraryPermissionsPayload */ LegacyLibraryPermissionsPayload: { /** @@ -9124,25 +13244,25 @@ export interface components { * @description A list of role encoded IDs defining roles that should have access permission on the library. * @default [] */ - LIBRARY_ACCESS_in?: string[] | string | null; + LIBRARY_ACCESS_in: string[] | string | null; /** * Manage IDs * @description A list of role encoded IDs defining roles that should have manage permission on the library. * @default [] */ - LIBRARY_ADD_in?: string[] | string | null; + LIBRARY_ADD_in: string[] | string | null; /** * Modify IDs * @description A list of role encoded IDs defining roles that should have modify permission on the library. * @default [] */ - LIBRARY_MANAGE_in?: string[] | string | null; + LIBRARY_MANAGE_in: string[] | string | null; /** * Add IDs * @description A list of role encoded IDs defining roles that should be able to add items to the library. * @default [] */ - LIBRARY_MODIFY_in?: string[] | string | null; + LIBRARY_MODIFY_in: string[] | string | null; }; /** LibraryAvailablePermissions */ LibraryAvailablePermissions: { @@ -9158,7 +13278,7 @@ export interface components { page_limit: number; /** * Roles - * @description A list available roles that can be assigned to a particular permission. + * @description A list containing available roles that can be assigned to a particular permission. */ roles: components["schemas"]["BasicRoleModel"][]; /** @@ -9167,4535 +13287,6624 @@ export interface components { */ total: number; }; - /** LibraryCurrentPermissions */ - LibraryCurrentPermissions: { + /** LibraryContentsCollectionCreatePayload */ + LibraryContentsCollectionCreatePayload: { + /** the type of collection to create */ + collection_type: string; /** - * Access Role List - * @description A list containing pairs of role names and corresponding encoded IDs which have access to the Library. + * Copy Elements + * @description if True, copy the elements into the collection + * @default false */ - access_library_role_list: string[][]; + copy_elements: boolean; + /** @description the type of item to create */ + create_type: components["schemas"]["CreateType"]; + /** list of dictionaries containing the element identifiers for the collection */ + element_identifiers: Record[]; /** - * Add Role List - * @description A list containing pairs of role names and corresponding encoded IDs which can add items to the Library. + * Extended Metadata + * @description sub-dictionary containing any extended metadata to associate with the item */ - add_library_item_role_list: string[][]; + extended_metadata?: Record | null; /** - * Manage Role List - * @description A list containing pairs of role names and corresponding encoded IDs which can manage the Library. + * Folder Id + * @description the encoded id of the parent folder of the new item + * @example 0123456789ABCDEF */ - manage_library_role_list: string[][]; + folder_id: string; /** - * Modify Role List - * @description A list containing pairs of role names and corresponding encoded IDs which can modify the Library. + * From Hda Id + * @description (only if create_type is 'file') the encoded id of an accessible HDA to copy into the library */ - modify_library_role_list: string[][]; - }; - /** LibraryDestination */ - LibraryDestination: { + from_hda_id?: string | null; /** - * Description - * @description Description for library to create + * From Hdca Id + * @description (only if create_type is 'file') the encoded id of an accessible HDCA to copy into the library */ - description?: string | null; + from_hdca_id?: string | null; /** - * Name - * @description Must specify a library name + * Hide Source Items + * @description if True, hide the source items in the collection + * @default false */ - name: string; + hide_source_items: boolean; /** - * Synopsis - * @description Description for library to create + * Ldda Message + * @description the new message attribute of the LDDA created + * @default */ - synopsis?: string | null; + ldda_message: string; + /** the name of the collection */ + name?: string | null; /** - * Type - * @constant - * @enum {string} + * Tag Using Filenames + * @description create tags on datasets using the file's original name + * @default false */ - type: "library"; - }; - /** LibraryFolderContentsIndexResult */ - LibraryFolderContentsIndexResult: { - /** Folder Contents */ - folder_contents: ( - | components["schemas"]["FileLibraryFolderItem"] - | components["schemas"]["FolderLibraryFolderItem"] - )[]; - metadata: components["schemas"]["LibraryFolderMetadata"]; - }; - /** LibraryFolderCurrentPermissions */ - LibraryFolderCurrentPermissions: { + tag_using_filenames: boolean; /** - * Add Role List - * @description A list containing pairs of role names and corresponding encoded IDs which can add items to the Library folder. + * Tags + * @description create the given list of tags on datasets + * @default [] */ - add_library_item_role_list: string[][]; + tags: string[]; /** - * Manage Role List - * @description A list containing pairs of role names and corresponding encoded IDs which can manage the Library folder. + * @deprecated + * @description the method to use for uploading files + * @default upload_file */ - manage_folder_role_list: string[][]; + upload_option: components["schemas"]["UploadOption"]; + }; + /** LibraryContentsCreateDatasetCollectionResponse */ + LibraryContentsCreateDatasetCollectionResponse: components["schemas"]["LibraryContentsCreateDatasetResponse"][]; + /** LibraryContentsCreateDatasetResponse */ + LibraryContentsCreateDatasetResponse: { + /** Created From Basename */ + created_from_basename: string | null; + /** Data Type */ + data_type: string; + /** Deleted */ + deleted: boolean; + /** File Ext */ + file_ext: string; + /** File Name */ + file_name: string; + /** File Size */ + file_size: number; + /** Genome Build */ + genome_build: string; + /** Hda Ldda */ + hda_ldda: string; + /** Id */ + id: string; + /** Library Dataset Id */ + library_dataset_id: string; + /** Misc Blurb */ + misc_blurb: string | null; + /** Misc Info */ + misc_info: string | null; /** - * Modify Role List - * @description A list containing pairs of role names and corresponding encoded IDs which can modify the Library folder. + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - modify_folder_role_list: string[][]; + model_class: "LibraryDatasetDatasetAssociation"; + /** Name */ + name: string; + /** Parent Library Id */ + parent_library_id: string; + /** State */ + state: string; + /** Update Time */ + update_time: string; + /** Uuid */ + uuid: string; + /** Visible */ + visible: boolean; + } & { + [key: string]: unknown; }; - /** LibraryFolderDestination */ - LibraryFolderDestination: { + /** LibraryContentsCreateFileListResponse */ + LibraryContentsCreateFileListResponse: components["schemas"]["LibraryContentsCreateFileResponse"][]; + /** LibraryContentsCreateFileResponse */ + LibraryContentsCreateFileResponse: { /** - * Library Folder Id + * Id * @example 0123456789ABCDEF */ - library_folder_id: string; + id: string; + /** Name */ + name: string; + /** Url */ + url: string; + }; + /** LibraryContentsCreateFolderListResponse */ + LibraryContentsCreateFolderListResponse: components["schemas"]["LibraryContentsCreateFolderResponse"][]; + /** LibraryContentsCreateFolderResponse */ + LibraryContentsCreateFolderResponse: { /** - * Type - * @constant - * @enum {string} + * Id + * @example 0123456789ABCDEF */ - type: "library_folder"; + id: string; + /** Name */ + name: string; + /** Url */ + url: string; }; - /** LibraryFolderDetails */ - LibraryFolderDetails: { + /** LibraryContentsDeletePayload */ + LibraryContentsDeletePayload: { /** - * Deleted - * @description Whether this folder is marked as deleted. + * Purge + * @description if True, purge the library dataset + * @default false */ + purge: boolean; + }; + /** LibraryContentsDeleteResponse */ + LibraryContentsDeleteResponse: { + /** Deleted */ deleted: boolean; /** - * Description - * @description A detailed description of the library folder. - * @default + * Id + * @example 0123456789ABCDEF */ - description?: string | null; + id: string; + }; + /** LibraryContentsFileCreatePayload */ + LibraryContentsFileCreatePayload: { + /** @description the type of item to create */ + create_type: components["schemas"]["CreateType"]; /** - * Genome Build - * @description TODO + * database key * @default ? */ - genome_build?: string | null; - /** - * ID - * @description Encoded ID of the library folder. - * @example 0123456789ABCDEF - */ - id: string; + dbkey: string | unknown[]; /** - * Item Count - * @description A detailed description of the library folder. + * Extended Metadata + * @description sub-dictionary containing any extended metadata to associate with the item */ - item_count: number; + extended_metadata?: Record | null; + /** file type */ + file_type?: string | null; /** - * Path - * @description The list of folder names composing the path to this folder. - * @default [] + * Filesystem Paths + * @description (only if upload_option is 'upload_paths' and the user is an admin) file paths on the Galaxy server to upload to the library, one file per line + * @default */ - library_path?: string[]; + filesystem_paths: string; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Folder Id + * @description the encoded id of the parent folder of the new item + * @example 0123456789ABCDEF */ - model_class: "LibraryFolder"; + folder_id: string; /** - * Name - * @description The name of the library folder. + * From Hda Id + * @description (only if create_type is 'file') the encoded id of an accessible HDA to copy into the library */ - name: string; + from_hda_id?: string | null; /** - * Parent Folder ID - * @description Encoded ID of the parent folder. Empty if it's the root folder. + * From Hdca Id + * @description (only if create_type is 'file') the encoded id of an accessible HDCA to copy into the library */ - parent_id?: string | null; + from_hdca_id?: string | null; /** - * Parent Library ID - * @description Encoded ID of the Library this folder belongs to. - * @example 0123456789ABCDEF + * Ldda Message + * @description the new message attribute of the LDDA created + * @default */ - parent_library_id: string; + ldda_message: string; /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. + * @description (only when upload_option is 'upload_directory' or 'upload_paths').Setting to 'link_to_files' symlinks instead of copying the files + * @default copy_files */ - update_time: string; - }; - /** LibraryFolderMetadata */ - LibraryFolderMetadata: { - /** Can Add Library Item */ - can_add_library_item: boolean; - /** Can Modify Folder */ - can_modify_folder: boolean; - /** Folder Description */ - folder_description: string; - /** Folder Name */ - folder_name: string; - /** Full Path */ - full_path: [string, string][]; + link_data_only: components["schemas"]["LinkDataOnly"]; /** - * Parent Library Id - * @example 0123456789ABCDEF + * user selected roles + * @default */ - parent_library_id: string; - /** Total Rows */ - total_rows: number; - }; - /** - * LibraryFolderPermissionAction - * @constant - * @enum {string} - */ - LibraryFolderPermissionAction: "set_permissions"; - /** LibraryFolderPermissionsPayload */ - LibraryFolderPermissionsPayload: { + roles: string; /** - * Action - * @description Indicates what action should be performed on the library folder. + * Server Dir + * @description (only if upload_option is 'upload_directory') relative path of the subdirectory of Galaxy ``library_import_dir`` (if admin) or ``user_library_import_dir`` (if non-admin) to upload. All and only the files (i.e. no subdirectories) contained in the specified directory will be uploaded. + * @default */ - action?: components["schemas"]["LibraryFolderPermissionAction"] | null; + server_dir: string; /** - * Add IDs - * @description A list of role encoded IDs defining roles that should be able to add items to the library. - * @default [] + * Tag Using Filenames + * @description create tags on datasets using the file's original name + * @default false */ - "add_ids[]"?: string[] | string | null; + tag_using_filenames: boolean; /** - * Manage IDs - * @description A list of role encoded IDs defining roles that should have manage permission on the library. + * Tags + * @description create the given list of tags on datasets * @default [] */ - "manage_ids[]"?: string[] | string | null; + tags: string[]; + /** list of the uploaded files */ + upload_files?: Record[] | null; /** - * Modify IDs - * @description A list of role encoded IDs defining roles that should have modify permission on the library. - * @default [] + * @deprecated + * @description the method to use for uploading files + * @default upload_file */ - "modify_ids[]"?: string[] | string | null; + upload_option: components["schemas"]["UploadOption"]; + /** UUID of the dataset to upload */ + uuid?: string | null; + } & { + [key: string]: unknown; }; - /** LibraryLegacySummary */ - LibraryLegacySummary: { + /** LibraryContentsFolderCreatePayload */ + LibraryContentsFolderCreatePayload: { + /** @description the type of item to create */ + create_type: components["schemas"]["CreateType"]; /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * description of the folder to create + * @default */ - create_time: string; + description: string; /** - * Deleted - * @description Whether this Library has been deleted. + * Extended Metadata + * @description sub-dictionary containing any extended metadata to associate with the item */ - deleted: boolean; + extended_metadata?: Record | null; /** - * Description - * @description A detailed description of the Library. - * @default + * Folder Id + * @description the encoded id of the parent folder of the new item + * @example 0123456789ABCDEF */ - description?: string | null; + folder_id: string; /** - * ID - * @description Encoded ID of the Library. - * @example 0123456789ABCDEF + * From Hda Id + * @description (only if create_type is 'file') the encoded id of an accessible HDA to copy into the library */ - id: string; + from_hda_id?: string | null; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * From Hdca Id + * @description (only if create_type is 'file') the encoded id of an accessible HDCA to copy into the library */ - model_class: "Library"; + from_hdca_id?: string | null; /** - * Name - * @description The name of the Library. + * Ldda Message + * @description the new message attribute of the LDDA created + * @default */ - name: string; + ldda_message: string; /** - * Root Folder ID - * @description Encoded ID of the Library's base folder. - * @example 0123456789ABCDEF + * name of the folder to create + * @default */ - root_folder_id: string; + name: string; /** - * Description - * @description A short text describing the contents of the Library. + * Tag Using Filenames + * @description create tags on datasets using the file's original name + * @default false */ - synopsis?: string | null; - }; - /** - * LibraryPermissionAction - * @enum {string} - */ - LibraryPermissionAction: "set_permissions" | "remove_restrictions"; - /** - * LibraryPermissionScope - * @enum {string} - */ - LibraryPermissionScope: "current" | "available"; - /** LibraryPermissionsPayload */ - LibraryPermissionsPayload: { + tag_using_filenames: boolean; /** - * Access IDs - * @description A list of role encoded IDs defining roles that should have access permission on the library. + * Tags + * @description create the given list of tags on datasets * @default [] */ - "access_ids[]"?: string[] | string | null; + tags: string[]; /** - * Action - * @description Indicates what action should be performed on the Library. + * @deprecated + * @description the method to use for uploading files + * @default upload_file */ - action?: components["schemas"]["LibraryPermissionAction"] | null; + upload_option: components["schemas"]["UploadOption"]; + }; + /** LibraryContentsIndexDatasetResponse */ + LibraryContentsIndexDatasetResponse: { /** - * Add IDs - * @description A list of role encoded IDs defining roles that should be able to add items to the library. - * @default [] - */ - "add_ids[]"?: string[] | string | null; - /** - * Manage IDs - * @description A list of role encoded IDs defining roles that should have manage permission on the library. - * @default [] - */ - "manage_ids[]"?: string[] | string | null; - /** - * Modify IDs - * @description A list of role encoded IDs defining roles that should have modify permission on the library. - * @default [] + * Id + * @example 0123456789ABCDEF */ - "modify_ids[]"?: string[] | string | null; + id: string; + /** Name */ + name: string; + /** Type */ + type: string; + /** Url */ + url: string; }; - /** LibrarySummary */ - LibrarySummary: { + /** LibraryContentsIndexFolderResponse */ + LibraryContentsIndexFolderResponse: { /** - * Can User Add - * @description Whether the current user can add contents to this Library. + * Id + * @example 0123456789ABCDEF */ - can_user_add: boolean; + id: string; + /** Name */ + name: string; + /** Type */ + type: string; + /** Url */ + url: string; + }; + /** LibraryContentsIndexListResponse */ + LibraryContentsIndexListResponse: ( + | components["schemas"]["LibraryContentsIndexFolderResponse"] + | components["schemas"]["LibraryContentsIndexDatasetResponse"] + )[]; + /** LibraryContentsShowDatasetResponse */ + LibraryContentsShowDatasetResponse: { + /** Created From Basename */ + created_from_basename: string | null; + /** Data Type */ + data_type: string; + /** Date Uploaded */ + date_uploaded: string; + /** File Ext */ + file_ext: string; + /** File Name */ + file_name: string; + /** File Size */ + file_size: number; /** - * Can User Manage - * @description Whether the current user can manage the Library and its contents. + * Folder Id + * @example 0123456789ABCDEF */ - can_user_manage: boolean; + folder_id: string; + /** Genome Build */ + genome_build: string | null; /** - * Can User Modify - * @description Whether the current user can modify this Library. + * Id + * @example 0123456789ABCDEF */ - can_user_modify: boolean; + id: string; /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * Ldda Id + * @example 0123456789ABCDEF */ - create_time: string; + ldda_id: string; + /** Message */ + message: string | null; + /** Misc Blurb */ + misc_blurb: string | null; + /** Misc Info */ + misc_info: string | null; /** - * Create Time Pretty - * @description Nice time representation of the creation date. + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - create_time_pretty: string; + model_class: "LibraryDataset"; + /** Name */ + name: string; /** - * Deleted - * @description Whether this Library has been deleted. + * Parent Library Id + * @example 0123456789ABCDEF */ + parent_library_id: string; + /** Peek */ + peek: string | null; + /** State */ + state: string; + tags: components["schemas"]["TagCollection"]; + /** Update Time */ + update_time: string; + /** Uploaded By */ + uploaded_by: string | null; + /** Uuid */ + uuid: string; + } & { + [key: string]: unknown; + }; + /** LibraryContentsShowFolderResponse */ + LibraryContentsShowFolderResponse: { + /** Deleted */ deleted: boolean; + /** Description */ + description: string; + /** Genome Build */ + genome_build: string | null; /** - * Description - * @description A detailed description of the Library. - * @default - */ - description?: string | null; - /** - * ID - * @description Encoded ID of the Library. + * Id * @example 0123456789ABCDEF */ id: string; + /** Item Count */ + item_count: number; + /** Library Path */ + library_path: string[]; /** * Model class * @description The name of the database model class. * @constant * @enum {string} */ - model_class: "Library"; - /** - * Name - * @description The name of the Library. - */ + model_class: "LibraryFolder"; + /** Name */ name: string; + /** Parent Id */ + parent_id: string | null; /** - * Public - * @description Whether this Library has been deleted. - */ - public: boolean; - /** - * Root Folder ID - * @description Encoded ID of the Library's base folder. + * Parent Library Id * @example 0123456789ABCDEF */ - root_folder_id: string; + parent_library_id: string; + /** Update Time */ + update_time: string; + }; + /** LibraryCurrentPermissions */ + LibraryCurrentPermissions: { /** - * Description - * @description A short text describing the contents of the Library. + * Access Role List + * @description A list containing pairs of role names and corresponding encoded IDs which have access to the Library. */ - synopsis?: string | null; - }; - /** - * LibrarySummaryList - * @default [] - */ - LibrarySummaryList: components["schemas"]["LibrarySummary"][]; - /** LicenseMetadataModel */ - LicenseMetadataModel: { + access_library_role_list: string[][]; /** - * Details URL - * Format: uri - * @description URL to the SPDX json details for this license + * Add Role List + * @description A list containing pairs of role names and corresponding encoded IDs which can add items to the Library. */ - detailsUrl: string; + add_library_item_role_list: string[][]; /** - * Deprecated License - * @description True if the entire license is deprecated + * Manage Role List + * @description A list containing pairs of role names and corresponding encoded IDs which can manage the Library. */ - isDeprecatedLicenseId: boolean; + manage_library_role_list: string[][]; /** - * OSI approved - * @description Indicates if the [OSI](https://opensource.org/) has approved the license + * Modify Role List + * @description A list containing pairs of role names and corresponding encoded IDs which can modify the Library. */ - isOsiApproved: boolean; + modify_library_role_list: string[][]; + }; + /** LibraryDestination */ + LibraryDestination: { /** - * Identifier - * @description SPDX Identifier + * Description + * @description Description for library to create */ - licenseId: string; + description?: string | null; /** * Name - * @description Full name of the license + * @description Must specify a library name */ name: string; /** - * Recommended - * @description True if this license is recommended to be used + * Synopsis + * @description Description for library to create */ - recommended: boolean; + synopsis?: string | null; /** - * Reference - * @description Reference to the HTML format for the license file + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - reference: string; + type: "library"; + }; + /** LibraryFolderContentsIndexResult */ + LibraryFolderContentsIndexResult: { + /** Folder Contents */ + folder_contents: ( + | components["schemas"]["FileLibraryFolderItem"] + | components["schemas"]["FolderLibraryFolderItem"] + )[]; + metadata: components["schemas"]["LibraryFolderMetadata"]; + }; + /** LibraryFolderCurrentPermissions */ + LibraryFolderCurrentPermissions: { /** - * Reference number - * @description *Deprecated* - this field is generated and is no longer in use + * Add Role List + * @description A list containing pairs of role names and corresponding encoded IDs which can add items to the Library folder. */ - referenceNumber: number; + add_library_item_role_list: string[][]; /** - * Reference URLs - * @description Cross reference URL pointing to additional copies of the license + * Manage Role List + * @description A list containing pairs of role names and corresponding encoded IDs which can manage the Library folder. */ - seeAlso: string[]; + manage_folder_role_list: string[][]; /** - * SPDX URL - * Format: uri + * Modify Role List + * @description A list containing pairs of role names and corresponding encoded IDs which can modify the Library folder. */ - spdxUrl: string; + modify_folder_role_list: string[][]; + }; + /** LibraryFolderDestination */ + LibraryFolderDestination: { /** - * URL - * Format: uri - * @description License URL + * Library Folder Id + * @example 0123456789ABCDEF */ - url: string; + library_folder_id: string; + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + type: "library_folder"; }; - /** - * LimitedUserModel - * @description This is used when config options (expose_user_name and expose_user_email) are in place. - */ - LimitedUserModel: { - /** Email */ - email?: string | null; + /** LibraryFolderDetails */ + LibraryFolderDetails: { + /** + * Deleted + * @description Whether this folder is marked as deleted. + */ + deleted: boolean; + /** + * Description + * @description A detailed description of the library folder. + * @default + */ + description: string | null; + /** + * Genome Build + * @description TODO + * @default ? + */ + genome_build: string | null; /** * ID - * @description Encoded ID of the user + * @description Encoded ID of the library folder. * @example 0123456789ABCDEF */ id: string; - /** Username */ - username?: string | null; - }; - /** Link */ - Link: { - /** Name */ - name: string; - }; - /** - * ListJstreeResponse - * @deprecated - * @description List of files in Jstree format. - * @default [] - */ - ListJstreeResponse: unknown[]; - /** - * ListUriResponse - * @description List of directories and files. - * @default [] - */ - ListUriResponse: (components["schemas"]["RemoteFile"] | components["schemas"]["RemoteDirectory"])[]; - /** - * MandatoryNotificationCategory - * @description These notification categories cannot be opt-out by the user. - * - * The user will always receive notifications from these categories. - * @constant - * @enum {string} - */ - MandatoryNotificationCategory: "broadcast"; - /** MaterializeDatasetInstanceAPIRequest */ - MaterializeDatasetInstanceAPIRequest: { /** - * Content - * @description Depending on the `source` it can be: - * - The encoded id of the source library dataset - * - The encoded id of the HDA - * - * @example 0123456789ABCDEF + * Item Count + * @description A detailed description of the library folder. */ - content: string; + item_count: number; /** - * Source - * @description The source of the content. Can be other history element to be copied or library elements. + * Path + * @description The list of folder names composing the path to this folder. + * @default [] */ - source: components["schemas"]["DatasetSourceType"]; - }; - /** MessageExceptionModel */ - MessageExceptionModel: { - /** Err Code */ - err_code: number; - /** Err Msg */ - err_msg: string; - }; - /** MessageNotificationContent */ - MessageNotificationContent: { + library_path: string[]; /** - * Category - * @default message + * Model class + * @description The name of the database model class. * @constant * @enum {string} */ - category?: "message"; + model_class: "LibraryFolder"; /** - * Message - * @description The message of the notification (supports Markdown). + * Name + * @description The name of the library folder. */ - message: string; + name: string; /** - * Subject - * @description The subject of the notification. + * Parent Folder ID + * @description Encoded ID of the parent folder. Empty if it's the root folder. */ - subject: string; - }; - /** - * MetadataFile - * @description Metadata file associated with a dataset. - */ - MetadataFile: { + parent_id?: string | null; /** - * Download URL - * @description The URL to download this item from the server. + * Parent Library ID + * @description Encoded ID of the Library this folder belongs to. + * @example 0123456789ABCDEF */ - download_url: string; + parent_library_id: string; /** - * File Type - * @description TODO + * Update Time + * Format: date-time + * @description The last time and date this item was updated. */ - file_type: string; + update_time: string; }; - /** Metric */ - Metric: { - /** - * Arguments - * @description A JSON string containing an array of extra data. - */ - args: string; - /** - * Level - * @description An integer representing the metric's log level. - */ - level: number; - /** - * Namespace - * @description Label indicating the source of the metric. - */ - namespace: string; + /** LibraryFolderMetadata */ + LibraryFolderMetadata: { + /** Can Add Library Item */ + can_add_library_item: boolean; + /** Can Modify Folder */ + can_modify_folder: boolean; + /** Folder Description */ + folder_description: string; + /** Folder Name */ + folder_name: string; + /** Full Path */ + full_path: [string, string][]; /** - * Timestamp - * @description The timestamp in ISO format. + * Parent Library Id + * @example 0123456789ABCDEF */ - time: string; + parent_library_id: string; + /** Total Rows */ + total_rows: number; }; /** - * ModelStoreFormat - * @description Available types of model stores for export. + * LibraryFolderPermissionAction + * @constant * @enum {string} */ - ModelStoreFormat: "tgz" | "tar" | "tar.gz" | "bag.zip" | "bag.tar" | "bag.tgz" | "rocrate.zip" | "bco.json"; - /** NestedElement */ - NestedElement: { - /** Md5 */ - MD5?: string | null; + LibraryFolderPermissionAction: "set_permissions"; + /** LibraryFolderPermissionsPayload */ + LibraryFolderPermissionsPayload: { /** - * Auto Decompress - * @description Decompress compressed data before sniffing? - * @default false + * Action + * @description Indicates what action should be performed on the library folder. */ - auto_decompress?: boolean; - /** Collection Type */ - collection_type?: string | null; - /** Created From Basename */ - created_from_basename?: string | null; + action?: components["schemas"]["LibraryFolderPermissionAction"] | null; /** - * Dbkey - * @default ? + * Add IDs + * @description A list of role encoded IDs defining roles that should be able to add items to the library. + * @default [] */ - dbkey?: string; + "add_ids[]": string[] | string | null; /** - * Deferred - * @default false + * Manage IDs + * @description A list of role encoded IDs defining roles that should have manage permission on the library. + * @default [] */ - deferred?: boolean; - /** Description */ - description?: string | null; - /** Elements */ - elements: ( - | ( - | components["schemas"]["FileDataElement"] - | components["schemas"]["PastedDataElement"] - | components["schemas"]["UrlDataElement"] - | components["schemas"]["PathDataElement"] - | components["schemas"]["ServerDirElement"] - | components["schemas"]["FtpImportElement"] - | components["schemas"]["CompositeDataElement"] - ) - | components["schemas"]["NestedElement"] - )[]; - elements_from?: components["schemas"]["ElementsFromType"] | null; + "manage_ids[]": string[] | string | null; /** - * Ext - * @default auto + * Modify IDs + * @description A list of role encoded IDs defining roles that should have modify permission on the library. + * @default [] */ - ext?: string; - extra_files?: components["schemas"]["ExtraFiles"] | null; - /** Info */ - info?: string | null; - /** Name */ - name?: string | number | boolean | null; + "modify_ids[]": string[] | string | null; + }; + /** LibraryLegacySummary */ + LibraryLegacySummary: { /** - * Space To Tab - * @default false + * Create Time + * Format: date-time + * @description The time and date this item was created. */ - space_to_tab?: boolean; - /** Tags */ - tags?: string[] | null; + create_time: string; /** - * To Posix Lines - * @default false + * Deleted + * @description Whether this Library has been deleted. */ - to_posix_lines?: boolean; - }; - /** NewSharedItemNotificationContent */ - NewSharedItemNotificationContent: { + deleted: boolean; /** - * Category - * @default new_shared_item - * @constant - * @enum {string} + * Description + * @description A detailed description of the Library. + * @default */ - category?: "new_shared_item"; + description: string | null; /** - * Item name - * @description The name of the shared item. + * ID + * @description Encoded ID of the Library. + * @example 0123456789ABCDEF */ - item_name: string; + id: string; /** - * Item type - * @description The type of the shared item. + * Model class + * @description The name of the database model class. + * @constant * @enum {string} */ - item_type: "history" | "workflow" | "visualization" | "page"; + model_class: "Library"; /** - * Owner name - * @description The name of the owner of the shared item. + * Name + * @description The name of the Library. */ - owner_name: string; + name: string; /** - * Slug - * @description The slug of the shared item. Used for the link to the item. + * Root Folder ID + * @description Encoded ID of the Library's base folder. + * @example 0123456789ABCDEF */ - slug: string; + root_folder_id: string; + /** + * Description + * @description A short text describing the contents of the Library. + */ + synopsis?: string | null; }; /** - * NotificationBroadcastUpdateRequest - * @description A notification update request specific for broadcasting. + * LibraryPermissionAction + * @enum {string} */ - NotificationBroadcastUpdateRequest: { + LibraryPermissionAction: "set_permissions" | "remove_restrictions"; + /** + * LibraryPermissionScope + * @enum {string} + */ + LibraryPermissionScope: "current" | "available"; + /** LibraryPermissionsPayload */ + LibraryPermissionsPayload: { /** - * Content - * @description The content of the broadcast notification. Broadcast notifications are displayed prominently to all users and can contain action links to redirect the user to a specific page. + * Access IDs + * @description A list of role encoded IDs defining roles that should have access permission on the library. + * @default [] */ - content?: components["schemas"]["BroadcastNotificationContent"] | null; + "access_ids[]": string[] | string | null; /** - * Expiration time - * @description The time when the notification should expire. By default it will expire after 6 months. Expired notifications will be permanently deleted. + * Action + * @description Indicates what action should be performed on the Library. */ - expiration_time?: string | null; + action?: components["schemas"]["LibraryPermissionAction"] | null; /** - * Publication time - * @description The time when the notification should be published. Notifications can be created and then scheduled to be published at a later time. + * Add IDs + * @description A list of role encoded IDs defining roles that should be able to add items to the library. + * @default [] */ - publication_time?: string | null; + "add_ids[]": string[] | string | null; /** - * Source - * @description The source of the notification. Represents the agent that created the notification. + * Manage IDs + * @description A list of role encoded IDs defining roles that should have manage permission on the library. + * @default [] */ - source?: string | null; + "manage_ids[]": string[] | string | null; /** - * Variant - * @description The variant of the notification. Used to express the importance of the notification. + * Modify IDs + * @description A list of role encoded IDs defining roles that should have modify permission on the library. + * @default [] */ - variant?: components["schemas"]["NotificationVariant"] | null; + "modify_ids[]": string[] | string | null; }; - /** - * NotificationCategorySettings - * @description The settings for a notification category. - */ - NotificationCategorySettings: { - /** - * Channels - * @description The channels that the user wants to receive notifications from for this category. - * @default { - * "email": true, - * "push": true - * } - */ - channels?: components["schemas"]["NotificationChannelSettings"]; + /** LibrarySummary */ + LibrarySummary: { /** - * Enabled - * @description Whether the user wants to receive notifications for this category. - * @default true + * Can User Add + * @description Whether the current user can add contents to this Library. */ - enabled?: boolean; - }; - /** - * NotificationChannelSettings - * @description The settings for each channel of a notification category. - */ - NotificationChannelSettings: { + can_user_add: boolean; /** - * Email - * @description Whether the user wants to receive email notifications for this category. This setting will be ignored unless the server supports asynchronous tasks. - * @default true + * Can User Manage + * @description Whether the current user can manage the Library and its contents. */ - email?: boolean; + can_user_manage: boolean; /** - * Push - * @description Whether the user wants to receive push notifications in the browser for this category. - * @default true + * Can User Modify + * @description Whether the current user can modify this Library. */ - push?: boolean; - }; - /** - * NotificationCreateData - * @description Basic common fields for all notification create requests. - */ - NotificationCreateData: { + can_user_modify: boolean; /** - * Category - * @description The category of the notification. Represents the type of the notification. E.g. 'message' or 'new_shared_item'. + * Create Time + * Format: date-time + * @description The time and date this item was created. */ - category: - | components["schemas"]["MandatoryNotificationCategory"] - | components["schemas"]["PersonalNotificationCategory"]; + create_time: string; /** - * Content - * @description The content of the notification. The structure depends on the category. + * Create Time Pretty + * @description Nice time representation of the creation date. */ - content: - | components["schemas"]["MessageNotificationContent"] - | components["schemas"]["NewSharedItemNotificationContent"] - | components["schemas"]["BroadcastNotificationContent"]; + create_time_pretty: string; /** - * Expiration time - * @description The time when the notification should expire. By default it will expire after 6 months. Expired notifications will be permanently deleted. + * Deleted + * @description Whether this Library has been deleted. */ - expiration_time?: string | null; + deleted: boolean; /** - * Publication time - * @description The time when the notification should be published. Notifications can be created and then scheduled to be published at a later time. + * Description + * @description A detailed description of the Library. + * @default */ - publication_time?: string | null; + description: string | null; /** - * Source - * @description The source of the notification. Represents the agent that created the notification. E.g. 'galaxy' or 'admin'. + * ID + * @description Encoded ID of the Library. + * @example 0123456789ABCDEF */ - source: string; + id: string; /** - * Variant - * @description The variant of the notification. Represents the intent or relevance of the notification. E.g. 'info' or 'urgent'. + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - variant: components["schemas"]["NotificationVariant"]; - }; - /** NotificationCreateRequest */ - NotificationCreateRequest: { + model_class: "Library"; /** - * Notification - * @description The notification to create. The structure depends on the category. + * Name + * @description The name of the Library. */ - notification: components["schemas"]["NotificationCreateData"]; + name: string; /** - * Recipients - * @description The recipients of the notification. Can be a combination of users, groups and roles. + * Public + * @description Whether this Library has been deleted. */ - recipients: components["schemas"]["NotificationRecipientsRequest"]; - }; - /** NotificationCreatedResponse */ - NotificationCreatedResponse: { + public: boolean; /** - * Notification - * @description The notification that was created. The structure depends on the category. + * Root Folder ID + * @description Encoded ID of the Library's base folder. + * @example 0123456789ABCDEF */ - notification: components["schemas"]["NotificationResponse"]; + root_folder_id: string; /** - * Total notifications sent - * @description The total number of notifications that were sent to the recipients. + * Description + * @description A short text describing the contents of the Library. */ - total_notifications_sent: number; + synopsis?: string | null; }; - /** NotificationRecipientsRequest */ - NotificationRecipientsRequest: { - /** - * Group IDs - * @description The list of encoded group IDs of the groups that should receive the notification. - * @default [] - */ - group_ids?: string[]; + /** + * LibrarySummaryList + * @default [] + */ + LibrarySummaryList: components["schemas"]["LibrarySummary"][]; + /** LicenseMetadataModel */ + LicenseMetadataModel: { /** - * Role IDs - * @description The list of encoded role IDs of the roles that should receive the notification. - * @default [] + * Details URL + * Format: uri + * @description URL to the SPDX json details for this license */ - role_ids?: string[]; + detailsUrl: string; /** - * User IDs - * @description The list of encoded user IDs of the users that should receive the notification. - * @default [] + * Deprecated License + * @description True if the entire license is deprecated */ - user_ids?: string[]; - }; - /** - * NotificationResponse - * @description Basic common fields for all notification responses. - */ - NotificationResponse: { + isDeprecatedLicenseId: boolean; /** - * Category - * @description The category of the notification. Represents the type of the notification. E.g. 'message' or 'new_shared_item'. + * OSI approved + * @description Indicates if the [OSI](https://opensource.org/) has approved the license */ - category: - | components["schemas"]["MandatoryNotificationCategory"] - | components["schemas"]["PersonalNotificationCategory"]; + isOsiApproved: boolean; /** - * Content - * @description The content of the notification. The structure depends on the category. + * Identifier + * @description SPDX Identifier */ - content: - | components["schemas"]["MessageNotificationContent"] - | components["schemas"]["NewSharedItemNotificationContent"] - | components["schemas"]["BroadcastNotificationContent"]; + licenseId: string; /** - * Create time - * Format: date-time - * @description The time when the notification was created. + * Name + * @description Full name of the license */ - create_time: string; + name: string; /** - * Expiration time - * @description The time when the notification will expire. If not set, the notification will never expire. Expired notifications will be permanently deleted. + * Recommended + * @description True if this license is recommended to be used */ - expiration_time?: string | null; + recommended: boolean; /** - * ID - * @description The encoded ID of the notification. - * @example 0123456789ABCDEF + * Reference + * @description Reference to the HTML format for the license file */ - id: string; + reference: string; /** - * Publication time - * Format: date-time - * @description The time when the notification was published. Notifications can be created and then published at a later time. + * Reference number + * @description *Deprecated* - this field is generated and is no longer in use */ - publication_time: string; + referenceNumber: number; /** - * Source - * @description The source of the notification. Represents the agent that created the notification. E.g. 'galaxy' or 'admin'. + * Reference URLs + * @description Cross reference URL pointing to additional copies of the license */ - source: string; + seeAlso: string[]; /** - * Update time - * Format: date-time - * @description The time when the notification was last updated. + * SPDX URL + * Format: uri */ - update_time: string; + spdxUrl: string; /** - * Variant - * @description The variant of the notification. Represents the intent or relevance of the notification. E.g. 'info' or 'urgent'. + * URL + * Format: uri + * @description License URL */ - variant: components["schemas"]["NotificationVariant"]; + url: string; }; /** - * NotificationStatusSummary - * @description A summary of the notification status for a user. Contains only updates since a particular timestamp. + * LimitedUserModel + * @description This is used when config options (expose_user_name and expose_user_email) are in place. */ - NotificationStatusSummary: { + LimitedUserModel: { + /** Email */ + email?: string | null; /** - * Broadcasts - * @description The list of updated broadcasts. + * ID + * @description Encoded ID of the user + * @example 0123456789ABCDEF */ - broadcasts: components["schemas"]["BroadcastNotificationResponse"][]; - /** - * Notifications - * @description The list of updated notifications for the user. - */ - notifications: components["schemas"]["UserNotificationResponse"][]; - /** - * Total unread count - * @description The total number of unread notifications for the user. - */ - total_unread_count: number; + id: string; + /** Username */ + username?: string | null; + }; + /** Link */ + Link: { + /** Name */ + name: string; }; /** - * NotificationVariant - * @description The notification variant communicates the intent or relevance of the notification. + * LinkDataOnly * @enum {string} */ - NotificationVariant: "info" | "warning" | "urgent"; - /** NotificationsBatchRequest */ - NotificationsBatchRequest: { - /** - * Notification IDs - * @description The list of encoded notification IDs of the notifications that should be updated. - */ - notification_ids: string[]; - }; + LinkDataOnly: "copy_files" | "link_to_files"; /** - * NotificationsBatchUpdateResponse - * @description The response of a batch update request. + * ListJstreeResponse + * @deprecated + * @description List of files in Jstree format. + * @default [] */ - NotificationsBatchUpdateResponse: { - /** - * Updated count - * @description The number of notifications that were updated. - */ - updated_count: number; - }; - /** ObjectExportTaskResponse */ - ObjectExportTaskResponse: { - /** - * Create Time - * Format: date-time - * @description The time and date this item was created. - */ - create_time: string; - export_metadata?: components["schemas"]["ExportObjectMetadata"] | null; + ListJstreeResponse: unknown[]; + /** + * ListUriResponse + * @description List of directories and files. + * @default [] + */ + ListUriResponse: (components["schemas"]["RemoteFile"] | components["schemas"]["RemoteDirectory"])[]; + /** + * MandatoryNotificationCategory + * @description These notification categories cannot be opt-out by the user. + * + * The user will always receive notifications from these categories. + * @constant + * @enum {string} + */ + MandatoryNotificationCategory: "broadcast"; + /** MaterializeDatasetInstanceAPIRequest */ + MaterializeDatasetInstanceAPIRequest: { /** - * ID - * @description The encoded database ID of the export request. + * Content + * @description Depending on the `source` it can be: + * - The encoded id of the source library dataset + * - The encoded id of the HDA + * * @example 0123456789ABCDEF */ - id: string; + content: string; /** - * Preparing - * @description Whether the archive is currently being built or in preparation. + * Source + * @description The source of the content. Can be other history element to be copied or library elements. */ - preparing: boolean; + source: components["schemas"]["DatasetSourceType"]; + }; + /** MessageExceptionModel */ + MessageExceptionModel: { + /** Err Code */ + err_code: number; + /** Err Msg */ + err_msg: string; + }; + /** MessageNotificationContent */ + MessageNotificationContent: { /** - * Ready - * @description Whether the export has completed successfully and the archive is ready + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - ready: boolean; + category: "message"; /** - * Task ID - * Format: uuid4 - * @description The identifier of the task processing the export. + * Message + * @description The message of the notification (supports Markdown). */ - task_uuid: string; + message: string; /** - * Up to Date - * @description False, if a new export archive should be generated. + * Subject + * @description The subject of the notification. */ - up_to_date: boolean; + subject: string; }; - /** ObjectStoreTemplateSummaries */ - ObjectStoreTemplateSummaries: components["schemas"]["ObjectStoreTemplateSummary"][]; - /** ObjectStoreTemplateSummary */ - ObjectStoreTemplateSummary: { - /** Badges */ - badges: components["schemas"]["BadgeDict"][]; - /** Description */ - description: string | null; - /** - * Hidden - * @default false - */ - hidden?: boolean; - /** Id */ - id: string; - /** Name */ - name: string | null; - /** Secrets */ - secrets?: components["schemas"]["TemplateSecret"][] | null; + /** + * MetadataFile + * @description Metadata file associated with a dataset. + */ + MetadataFile: { /** - * Type - * @enum {string} + * Download URL + * @description The URL to download this item from the server. */ - type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; - /** Variables */ - variables?: - | ( - | components["schemas"]["TemplateVariableString"] - | components["schemas"]["TemplateVariableInteger"] - | components["schemas"]["TemplateVariablePathComponent"] - | components["schemas"]["TemplateVariableBoolean"] - )[] - | null; + download_url: string; /** - * Version - * @default 0 + * File Type + * @description TODO */ - version?: number; + file_type: string; }; - /** OutputReferenceByLabel */ - OutputReferenceByLabel: { + /** Metric */ + Metric: { /** - * Label - * @description The unique label of the step being referenced. + * Arguments + * @description A JSON string containing an array of extra data. */ - label: string; + args: string; /** - * Output Name - * @description The output name as defined by the workflow module corresponding to the step being referenced. The default is 'output', corresponding to the output defined by input step types. - * @default output + * Level + * @description An integer representing the metric's log level. */ - output_name?: string | null; - }; - /** OutputReferenceByOrderIndex */ - OutputReferenceByOrderIndex: { + level: number; /** - * Order Index - * @description The order_index of the step being referenced. The order indices of a workflow start at 0. + * Namespace + * @description Label indicating the source of the metric. */ - order_index: number; + namespace: string; /** - * Output Name - * @description The output name as defined by the workflow module corresponding to the step being referenced. The default is 'output', corresponding to the output defined by input step types. - * @default output + * Timestamp + * @description The timestamp in ISO format. */ - output_name?: string | null; + time: string; }; /** - * PageContentFormat + * ModelStoreFormat + * @description Available types of model stores for export. * @enum {string} */ - PageContentFormat: "markdown" | "html"; - /** PageDetails */ - PageDetails: { + ModelStoreFormat: "tgz" | "tar" | "tar.gz" | "bag.zip" | "bag.tar" | "bag.tgz" | "rocrate.zip" | "bco.json"; + /** NestedElement */ + NestedElement: { + /** Md5 */ + MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** - * Content - * @description Raw text contents of the last page revision (type dependent on content_format). - * @default + * Auto Decompress + * @description Decompress compressed data before sniffing? + * @default false */ - content?: string | null; + auto_decompress: boolean; + /** Collection Type */ + collection_type?: string | null; + /** Created From Basename */ + created_from_basename?: string | null; /** - * Content format - * @description Either `markdown` or `html`. - * @default html + * Dbkey + * @default ? */ - content_format?: components["schemas"]["PageContentFormat"]; + dbkey: string; /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * Deferred + * @default false */ - create_time: string; + deferred: boolean; + /** Description */ + description?: string | null; + /** Elements */ + elements: ( + | ( + | components["schemas"]["FileDataElement"] + | components["schemas"]["PastedDataElement"] + | components["schemas"]["UrlDataElement"] + | components["schemas"]["PathDataElement"] + | components["schemas"]["ServerDirElement"] + | components["schemas"]["FtpImportElement"] + | components["schemas"]["CompositeDataElement"] + ) + | components["schemas"]["NestedElement"] + )[]; + elements_from?: components["schemas"]["ElementsFromType"] | null; /** - * Deleted - * @description Whether this Page has been deleted. + * Ext + * @default auto */ - deleted: boolean; + ext: string; + extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; + /** Info */ + info?: string | null; + /** Name */ + name?: string | number | boolean | null; /** - * Encoded email - * @description The encoded email of the user. + * Space To Tab + * @default false */ - email_hash: string; + space_to_tab: boolean; + /** Tags */ + tags?: string[] | null; /** - * Galaxy Version - * @description The version of Galaxy this object was generated with. + * To Posix Lines + * @default false */ - generate_time?: string | null; - /** - * Galaxy Version - * @description The version of Galaxy this object was generated with. - */ - generate_version?: string | null; - /** - * ID - * @description Encoded ID of the Page. - * @example 0123456789ABCDEF - */ - id: string; + to_posix_lines: boolean; + }; + /** NewSharedItemNotificationContent */ + NewSharedItemNotificationContent: { /** - * Importable - * @description Whether this Page can be imported. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - importable: boolean; + category: "new_shared_item"; /** - * Latest revision ID - * @description The encoded ID of the last revision of this Page. - * @example 0123456789ABCDEF + * Item name + * @description The name of the shared item. */ - latest_revision_id: string; + item_name: string; /** - * Model class - * @description The name of the database model class. - * @constant + * Item type + * @description The type of the shared item. * @enum {string} */ - model_class: "Page"; + item_type: "history" | "workflow" | "visualization" | "page"; /** - * Published - * @description Whether this Page has been published. + * Owner name + * @description The name of the owner of the shared item. */ - published: boolean; + owner_name: string; /** - * List of revisions - * @description The history with the encoded ID of each revision of the Page. + * Slug + * @description The slug of the shared item. Used for the link to the item. */ - revision_ids: string[]; + slug: string; + }; + /** + * NotificationBroadcastUpdateRequest + * @description A notification update request specific for broadcasting. + */ + NotificationBroadcastUpdateRequest: { /** - * Identifier - * @description The title slug for the page URL, must be unique. + * Content + * @description The content of the broadcast notification. Broadcast notifications are displayed prominently to all users and can contain action links to redirect the user to a specific page. */ - slug: string; - tags: components["schemas"]["TagCollection"]; + content?: components["schemas"]["BroadcastNotificationContent"] | null; /** - * Title - * @description The name of the page. + * Expiration time + * @description The time when the notification should expire. By default it will expire after 6 months. Expired notifications will be permanently deleted. */ - title: string; + expiration_time?: string | null; /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. + * Publication time + * @description The time when the notification should be published. Notifications can be created and then scheduled to be published at a later time. */ - update_time: string; + publication_time?: string | null; /** - * Username - * @description The name of the user owning this Page. + * Source + * @description The source of the notification. Represents the agent that created the notification. */ - username: string; - [key: string]: unknown; - }; - /** PageSummary */ - PageSummary: { + source?: string | null; /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * Variant + * @description The variant of the notification. Used to express the importance of the notification. */ - create_time: string; + variant?: components["schemas"]["NotificationVariant"] | null; + }; + /** + * NotificationCategorySettings + * @description The settings for a notification category. + */ + NotificationCategorySettings: { /** - * Deleted - * @description Whether this Page has been deleted. + * Channels + * @description The channels that the user wants to receive notifications from for this category. + * @default { + * "email": true, + * "push": true + * } */ - deleted: boolean; + channels: components["schemas"]["NotificationChannelSettings"]; /** - * Encoded email - * @description The encoded email of the user. + * Enabled + * @description Whether the user wants to receive notifications for this category. + * @default true */ - email_hash: string; + enabled: boolean; + }; + /** + * NotificationChannelSettings + * @description The settings for each channel of a notification category. + */ + NotificationChannelSettings: { /** - * ID - * @description Encoded ID of the Page. - * @example 0123456789ABCDEF + * Email + * @description Whether the user wants to receive email notifications for this category. This setting will be ignored unless the server supports asynchronous tasks. + * @default true */ - id: string; + email: boolean; /** - * Importable - * @description Whether this Page can be imported. + * Push + * @description Whether the user wants to receive push notifications in the browser for this category. + * @default true */ - importable: boolean; + push: boolean; + }; + /** + * NotificationCreateData + * @description Basic common fields for all notification create requests. + */ + NotificationCreateData: { /** - * Latest revision ID - * @description The encoded ID of the last revision of this Page. - * @example 0123456789ABCDEF + * Category + * @description The category of the notification. Represents the type of the notification. E.g. 'message' or 'new_shared_item'. */ - latest_revision_id: string; + category: + | components["schemas"]["MandatoryNotificationCategory"] + | components["schemas"]["PersonalNotificationCategory"]; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Content + * @description The content of the notification. The structure depends on the category. */ - model_class: "Page"; + content: + | components["schemas"]["MessageNotificationContent"] + | components["schemas"]["NewSharedItemNotificationContent"] + | components["schemas"]["BroadcastNotificationContent"]; /** - * Published - * @description Whether this Page has been published. + * Expiration time + * @description The time when the notification should expire. By default it will expire after 6 months. Expired notifications will be permanently deleted. */ - published: boolean; + expiration_time?: string | null; /** - * List of revisions - * @description The history with the encoded ID of each revision of the Page. + * Publication time + * @description The time when the notification should be published. Notifications can be created and then scheduled to be published at a later time. */ - revision_ids: string[]; + publication_time?: string | null; /** - * Identifier - * @description The title slug for the page URL, must be unique. + * Source + * @description The source of the notification. Represents the agent that created the notification. E.g. 'galaxy' or 'admin'. */ - slug: string; - tags: components["schemas"]["TagCollection"]; + source: string; /** - * Title - * @description The name of the page. + * Variant + * @description The variant of the notification. Represents the intent or relevance of the notification. E.g. 'info' or 'urgent'. */ - title: string; + variant: components["schemas"]["NotificationVariant"]; + }; + /** NotificationCreateRequest */ + NotificationCreateRequest: { /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. + * Notification + * @description The notification to create. The structure depends on the category. */ - update_time: string; + notification: components["schemas"]["NotificationCreateData"]; /** - * Username - * @description The name of the user owning this Page. + * Recipients + * @description The recipients of the notification. Can be a combination of users, groups and roles. */ - username: string; + recipients: components["schemas"]["NotificationRecipientsRequest"]; }; - /** - * PageSummaryList - * @default [] - */ - PageSummaryList: components["schemas"]["PageSummary"][]; - /** PastedDataElement */ - PastedDataElement: { - /** Md5 */ - MD5?: string | null; + /** NotificationCreatedResponse */ + NotificationCreatedResponse: { /** - * Auto Decompress - * @description Decompress compressed data before sniffing? - * @default false + * Notification + * @description The notification that was created. The structure depends on the category. */ - auto_decompress?: boolean; - /** Collection Type */ - collection_type?: string | null; - /** Created From Basename */ - created_from_basename?: string | null; + notification: components["schemas"]["NotificationResponse"]; /** - * Dbkey - * @default ? + * Total notifications sent + * @description The total number of notifications that were sent to the recipients. */ - dbkey?: string; + total_notifications_sent: number; + }; + /** NotificationRecipientsRequest */ + NotificationRecipientsRequest: { /** - * Deferred - * @default false + * Group IDs + * @description The list of encoded group IDs of the groups that should receive the notification. + * @default [] */ - deferred?: boolean; - /** Description */ - description?: string | null; - elements_from?: components["schemas"]["ElementsFromType"] | null; + group_ids: string[]; /** - * Ext - * @default auto + * Role IDs + * @description The list of encoded role IDs of the roles that should receive the notification. + * @default [] */ - ext?: string; - extra_files?: components["schemas"]["ExtraFiles"] | null; - /** Info */ - info?: string | null; - /** Name */ - name?: string | number | boolean | null; + role_ids: string[]; /** - * Paste Content - * @description Content to upload + * User IDs + * @description The list of encoded user IDs of the users that should receive the notification. + * @default [] */ - paste_content: string | number | boolean; + user_ids: string[]; + }; + /** + * NotificationResponse + * @description Basic common fields for all notification responses. + */ + NotificationResponse: { /** - * Space To Tab - * @default false + * Category + * @description The category of the notification. Represents the type of the notification. E.g. 'message' or 'new_shared_item'. */ - space_to_tab?: boolean; - /** - * Src - * @constant - * @enum {string} - */ - src: "pasted"; - /** Tags */ - tags?: string[] | null; + category: + | components["schemas"]["MandatoryNotificationCategory"] + | components["schemas"]["PersonalNotificationCategory"]; /** - * To Posix Lines - * @default false + * Content + * @description The content of the notification. The structure depends on the category. */ - to_posix_lines?: boolean; - }; - /** PathDataElement */ - PathDataElement: { - /** Md5 */ - MD5?: string | null; + content: + | components["schemas"]["MessageNotificationContent"] + | components["schemas"]["NewSharedItemNotificationContent"] + | components["schemas"]["BroadcastNotificationContent"]; /** - * Auto Decompress - * @description Decompress compressed data before sniffing? - * @default false + * Create time + * Format: date-time + * @description The time when the notification was created. */ - auto_decompress?: boolean; - /** Collection Type */ - collection_type?: string | null; - /** Created From Basename */ - created_from_basename?: string | null; + create_time: string; /** - * Dbkey - * @default ? + * Expiration time + * @description The time when the notification will expire. If not set, the notification will never expire. Expired notifications will be permanently deleted. */ - dbkey?: string; + expiration_time?: string | null; /** - * Deferred - * @default false + * ID + * @description The encoded ID of the notification. + * @example 0123456789ABCDEF */ - deferred?: boolean; - /** Description */ - description?: string | null; - elements_from?: components["schemas"]["ElementsFromType"] | null; + id: string; /** - * Ext - * @default auto + * Publication time + * Format: date-time + * @description The time when the notification was published. Notifications can be created and then published at a later time. */ - ext?: string; - extra_files?: components["schemas"]["ExtraFiles"] | null; - /** Info */ - info?: string | null; - /** Link Data Only */ - link_data_only?: boolean | null; - /** Name */ - name?: string | number | boolean | null; - /** Path */ - path: string; + publication_time: string; /** - * Space To Tab - * @default false + * Source + * @description The source of the notification. Represents the agent that created the notification. E.g. 'galaxy' or 'admin'. */ - space_to_tab?: boolean; + source: string; /** - * Src - * @constant - * @enum {string} + * Update time + * Format: date-time + * @description The time when the notification was last updated. */ - src: "path"; - /** Tags */ - tags?: string[] | null; + update_time: string; /** - * To Posix Lines - * @default false + * Variant + * @description The variant of the notification. Represents the intent or relevance of the notification. E.g. 'info' or 'urgent'. */ - to_posix_lines?: boolean; + variant: components["schemas"]["NotificationVariant"]; }; - /** PauseStep */ - PauseStep: { + /** + * NotificationStatusSummary + * @description A summary of the notification status for a user. Contains only updates since a particular timestamp. + */ + NotificationStatusSummary: { /** - * Annotation - * @description An annotation to provide details or to help understand the purpose and usage of this item. + * Broadcasts + * @description The list of updated broadcasts. */ - annotation: string | null; + broadcasts: components["schemas"]["BroadcastNotificationResponse"][]; /** - * ID - * @description The identifier of the step. It matches the index order of the step inside the workflow. + * Notifications + * @description The list of updated notifications for the user. */ - id: number; + notifications: components["schemas"]["UserNotificationResponse"][]; /** - * Input Steps - * @description A dictionary containing information about the inputs connected to this workflow step. + * Total unread count + * @description The total number of unread notifications for the user. */ - input_steps: { - [key: string]: components["schemas"]["InputStep"]; - }; + total_unread_count: number; + }; + /** + * NotificationVariant + * @description The notification variant communicates the intent or relevance of the notification. + * @enum {string} + */ + NotificationVariant: "info" | "warning" | "urgent"; + /** NotificationsBatchRequest */ + NotificationsBatchRequest: { /** - * Tool ID - * @description The unique name of the tool associated with this step. + * Notification IDs + * @description The list of encoded notification IDs of the notifications that should be updated. */ - tool_id?: string | null; + notification_ids: string[]; + }; + /** + * NotificationsBatchUpdateResponse + * @description The response of a batch update request. + */ + NotificationsBatchUpdateResponse: { /** - * Tool Inputs - * @description TODO + * Updated count + * @description The number of notifications that were updated. */ - tool_inputs?: unknown; + updated_count: number; + }; + /** OAuth2Info */ + OAuth2Info: { + /** Authorize Url */ + authorize_url: string; + }; + /** ObjectExportTaskResponse */ + ObjectExportTaskResponse: { /** - * Tool Version - * @description The version of the tool associated with this step. + * Create Time + * Format: date-time + * @description The time and date this item was created. */ - tool_version?: string | null; + create_time: string; + export_metadata?: components["schemas"]["ExportObjectMetadata"] | null; /** - * Type - * @constant - * @enum {string} + * ID + * @description The encoded database ID of the export request. + * @example 0123456789ABCDEF */ - type: "pause"; - /** When */ - when: string | null; - }; - /** Person */ - Person: { - /** Address */ - address?: string | null; - /** Alternate Name */ - alternateName?: string | null; + id: string; /** - * Class - * @default Person + * Preparing + * @description Whether the archive is currently being built or in preparation. */ - class?: string; - /** Email */ - email?: string | null; - /** Family Name */ - familyName?: string | null; - /** Fax Number */ - faxNumber?: string | null; - /** Given Name */ - givenName?: string | null; + preparing: boolean; /** - * Honorific Prefix - * @description Honorific Prefix (e.g. Dr/Mrs/Mr) + * Ready + * @description Whether the export has completed successfully and the archive is ready */ - honorificPrefix?: string | null; + ready: boolean; /** - * Honorific Suffix - * @description Honorific Suffix (e.g. M.D.) + * Task ID + * Format: uuid4 + * @description The identifier of the task processing the export. */ - honorificSuffix?: string | null; + task_uuid: string; /** - * Identifier - * @description Identifier (typically an orcid.org ID) + * Up to Date + * @description False, if a new export archive should be generated. */ - identifier?: string | null; - /** Image URL */ - image?: string | null; - /** Job Title */ - jobTitle?: string | null; + up_to_date: boolean; + }; + /** ObjectStoreTemplateSummaries */ + ObjectStoreTemplateSummaries: components["schemas"]["ObjectStoreTemplateSummary"][]; + /** ObjectStoreTemplateSummary */ + ObjectStoreTemplateSummary: { + /** Badges */ + badges: components["schemas"]["BadgeDict"][]; + /** Description */ + description: string | null; /** - * Name - * @description The name of the creator. + * Hidden + * @default false */ - name?: string | null; - /** Telephone */ - telephone?: string | null; - /** URL */ - url?: string | null; - }; - /** - * PersonalNotificationCategory - * @description These notification categories can be opt-out by the user and will be - * displayed in the notification preferences. - * @enum {string} - */ - PersonalNotificationCategory: "message" | "new_shared_item"; - /** PluginAspectStatus */ - PluginAspectStatus: { - /** Message */ - message: string; + hidden: boolean; + /** Id */ + id: string; + /** Name */ + name: string | null; + /** Secrets */ + secrets?: components["schemas"]["TemplateSecret"][] | null; /** - * State + * Type * @enum {string} */ - state: "ok" | "not_ok" | "unknown"; + type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3" | "onedata"; + /** Variables */ + variables?: + | ( + | components["schemas"]["TemplateVariableString"] + | components["schemas"]["TemplateVariableInteger"] + | components["schemas"]["TemplateVariablePathComponent"] + | components["schemas"]["TemplateVariableBoolean"] + )[] + | null; + /** + * Version + * @default 0 + */ + version: number; }; - /** - * PluginKind - * @description Enum to distinguish between different kinds or categories of plugins. - * @enum {string} - */ - PluginKind: "rfs" | "drs" | "rdm" | "stock"; - /** PluginStatus */ - PluginStatus: { - connection?: components["schemas"]["PluginAspectStatus"] | null; - template_definition: components["schemas"]["PluginAspectStatus"]; - template_settings?: components["schemas"]["PluginAspectStatus"] | null; - }; - /** Position */ - Position: { - /** Left */ - left: number; - /** Top */ - top: number; - }; - /** PrepareStoreDownloadPayload */ - PrepareStoreDownloadPayload: { - /** - * Bco Merge History Metadata - * @description When reading tags/annotations to generate BCO object include history metadata. - * @default false - */ - bco_merge_history_metadata?: boolean; + /** OutputReferenceByLabel */ + OutputReferenceByLabel: { /** - * Bco Override Algorithmic Error - * @description Override algorithmic error for 'error domain' when generating BioCompute object. + * Label + * @description The unique label of the step being referenced. */ - bco_override_algorithmic_error?: { - [key: string]: string; - } | null; + label: string; /** - * Bco Override Empirical Error - * @description Override empirical error for 'error domain' when generating BioCompute object. + * Output Name + * @description The output name as defined by the workflow module corresponding to the step being referenced. The default is 'output', corresponding to the output defined by input step types. + * @default output */ - bco_override_empirical_error?: { - [key: string]: string; - } | null; + output_name: string | null; + }; + /** OutputReferenceByOrderIndex */ + OutputReferenceByOrderIndex: { /** - * Bco Override Environment Variables - * @description Override environment variables for 'execution_domain' when generating BioCompute object. + * Order Index + * @description The order_index of the step being referenced. The order indices of a workflow start at 0. */ - bco_override_environment_variables?: { - [key: string]: string; - } | null; + order_index: number; /** - * Bco Override Xref - * @description Override xref for 'description domain' when generating BioCompute object. + * Output Name + * @description The output name as defined by the workflow module corresponding to the step being referenced. The default is 'output', corresponding to the output defined by input step types. + * @default output */ - bco_override_xref?: components["schemas"]["XrefItem"][] | null; + output_name: string | null; + }; + /** + * PageContentFormat + * @enum {string} + */ + PageContentFormat: "markdown" | "html"; + /** PageDetails */ + PageDetails: { /** - * Include deleted - * @description Include file contents for deleted datasets (if include_files is True). - * @default false + * Content + * @description Raw text contents of the last page revision (type dependent on content_format). + * @default */ - include_deleted?: boolean; + content: string | null; /** - * Include Files - * @description include materialized files in export when available - * @default true + * Content format + * @description Either `markdown` or `html`. + * @default html */ - include_files?: boolean; + content_format: components["schemas"]["PageContentFormat"]; /** - * Include hidden - * @description Include file contents for hidden datasets (if include_files is True). - * @default false + * Create Time + * Format: date-time + * @description The time and date this item was created. */ - include_hidden?: boolean; + create_time: string; /** - * @description format of model store to export - * @default tar.gz + * Deleted + * @description Whether this Page has been deleted. */ - model_store_format?: components["schemas"]["ModelStoreFormat"]; - }; - /** QuotaDetails */ - QuotaDetails: { + deleted: boolean; /** - * Bytes - * @description The amount, expressed in bytes, of this Quota. + * Encoded email + * @description The encoded email of the user. */ - bytes: number; + email_hash: string; /** - * Default - * @description A list indicating which types of default user quotas, if any, are associated with this quota. - * @default [] + * Galaxy Version + * @description The version of Galaxy this object was generated with. */ - default?: components["schemas"]["DefaultQuota"][]; + generate_time?: string | null; /** - * Description - * @description Detailed text description for this Quota. + * Galaxy Version + * @description The version of Galaxy this object was generated with. */ - description: string; + generate_version?: string | null; /** - * Display Amount - * @description Human-readable representation of the `amount` field. + * ID + * @description Encoded ID of the Page. + * @example 0123456789ABCDEF */ - display_amount: string; + id: string; /** - * Groups - * @description A list of specific groups of users associated with this quota. - * @default [] + * Importable + * @description Whether this Page can be imported. */ - groups?: components["schemas"]["GroupQuota"][]; + importable: boolean; /** - * ID - * @description The `encoded identifier` of the quota. + * Latest revision ID + * @description The encoded ID of the last revision of this Page. * @example 0123456789ABCDEF */ - id: string; + latest_revision_id: string; /** * Model class * @description The name of the database model class. * @constant * @enum {string} */ - model_class: "Quota"; + model_class: "Page"; /** - * Name - * @description The name of the quota. This must be unique within a Galaxy instance. + * Published + * @description Whether this Page has been published. */ - name: string; + published: boolean; /** - * Operation - * @description Quotas can have one of three `operations`:- `=` : The quota is exactly the amount specified- `+` : The amount specified will be added to the amounts of the user's other associated quota definitions- `-` : The amount specified will be subtracted from the amounts of the user's other associated quota definitions - * @default = + * List of revisions + * @description The history with the encoded ID of each revision of the Page. */ - operation?: components["schemas"]["QuotaOperation"]; + revision_ids: string[]; /** - * Quota Source Label - * @description Quota source label + * Identifier + * @description The title slug for the page URL, must be unique. */ - quota_source_label?: string | null; + slug: string; + tags: components["schemas"]["TagCollection"]; /** - * Users - * @description A list of specific users associated with this quota. - * @default [] + * Title + * @description The name of the page. */ - users?: components["schemas"]["UserQuota"][]; - }; - /** QuotaModel */ - QuotaModel: { - /** Enabled */ - enabled: boolean; - /** Source */ - source?: string | null; + title: string; + /** + * Update Time + * Format: date-time + * @description The last time and date this item was updated. + */ + update_time: string; + /** + * Username + * @description The name of the user owning this Page. + */ + username: string; + } & { + [key: string]: unknown; }; - /** - * QuotaOperation - * @enum {string} - */ - QuotaOperation: "=" | "+" | "-"; - /** - * QuotaSummary - * @description Contains basic information about a Quota - */ - QuotaSummary: { + /** PageSummary */ + PageSummary: { + /** + * Create Time + * Format: date-time + * @description The time and date this item was created. + */ + create_time: string; + /** + * Deleted + * @description Whether this Page has been deleted. + */ + deleted: boolean; + /** + * Encoded email + * @description The encoded email of the user. + */ + email_hash: string; /** * ID - * @description The `encoded identifier` of the quota. + * @description Encoded ID of the Page. * @example 0123456789ABCDEF */ id: string; + /** + * Importable + * @description Whether this Page can be imported. + */ + importable: boolean; + /** + * Latest revision ID + * @description The encoded ID of the last revision of this Page. + * @example 0123456789ABCDEF + */ + latest_revision_id: string; /** * Model class * @description The name of the database model class. * @constant * @enum {string} */ - model_class: "Quota"; + model_class: "Page"; /** - * Name - * @description The name of the quota. This must be unique within a Galaxy instance. + * Published + * @description Whether this Page has been published. */ - name: string; + published: boolean; /** - * Quota Source Label - * @description Quota source label + * List of revisions + * @description The history with the encoded ID of each revision of the Page. */ - quota_source_label?: string | null; + revision_ids: string[]; /** - * URL - * @deprecated - * @description The relative URL to get this particular Quota details from the rest API. + * Identifier + * @description The title slug for the page URL, must be unique. */ - url: string; - }; - /** - * QuotaSummaryList - * @default [] - */ - QuotaSummaryList: components["schemas"]["QuotaSummary"][]; - /** RefactorActionExecution */ - RefactorActionExecution: { - /** Action */ - action: - | components["schemas"]["AddInputAction"] - | components["schemas"]["AddStepAction"] - | components["schemas"]["ConnectAction"] - | components["schemas"]["DisconnectAction"] - | components["schemas"]["ExtractInputAction"] - | components["schemas"]["ExtractUntypedParameter"] - | components["schemas"]["FileDefaultsAction"] - | components["schemas"]["FillStepDefaultsAction"] - | components["schemas"]["UpdateAnnotationAction"] - | components["schemas"]["UpdateCreatorAction"] - | components["schemas"]["UpdateNameAction"] - | components["schemas"]["UpdateLicenseAction"] - | components["schemas"]["UpdateOutputLabelAction"] - | components["schemas"]["UpdateReportAction"] - | components["schemas"]["UpdateStepLabelAction"] - | components["schemas"]["UpdateStepPositionAction"] - | components["schemas"]["UpgradeSubworkflowAction"] - | components["schemas"]["UpgradeToolAction"] - | components["schemas"]["UpgradeAllStepsAction"] - | components["schemas"]["RemoveUnlabeledWorkflowOutputs"]; - /** Messages */ - messages: components["schemas"]["RefactorActionExecutionMessage"][]; - }; - /** RefactorActionExecutionMessage */ - RefactorActionExecutionMessage: { + slug: string; + tags: components["schemas"]["TagCollection"]; /** - * From Order Index - * @description For dropped connections these optional attributes refer to the output - * side of the connection that was dropped. + * Title + * @description The name of the page. */ - from_order_index?: number | null; + title: string; /** - * From Step Label - * @description For dropped connections these optional attributes refer to the output - * side of the connection that was dropped. + * Update Time + * Format: date-time + * @description The last time and date this item was updated. */ - from_step_label?: string | null; + update_time: string; /** - * Input Name - * @description If this message is about an input to a step, - * this field describes the target input name. $The input name as defined by the workflow module corresponding to the step being referenced. For Galaxy tool steps these inputs should be normalized using '|' (e.g. 'cond|repeat_0|input'). + * Username + * @description The name of the user owning this Page. */ - input_name?: string | null; - /** Message */ - message: string; - message_type: components["schemas"]["RefactorActionExecutionMessageTypeEnum"]; + username: string; + }; + /** + * PageSummaryList + * @default [] + */ + PageSummaryList: components["schemas"]["PageSummary"][]; + /** PastedDataElement */ + PastedDataElement: { + /** Md5 */ + MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** - * Order Index - * @description Reference to the step the message refers to. $ - * - * Messages don't have to be bound to a step, but if they are they will - * have a step_label and order_index included in the execution message. - * These are the label and order_index before applying the refactoring, - * the result of applying the action may change one or both of these. - * If connections are dropped this step reference will refer to the - * step with the previously connected input. + * Auto Decompress + * @description Decompress compressed data before sniffing? + * @default false */ - order_index?: number | null; + auto_decompress: boolean; + /** Collection Type */ + collection_type?: string | null; + /** Created From Basename */ + created_from_basename?: string | null; /** - * Output Label - * @description If the message_type is workflow_output_drop_forced, this is the output label dropped. + * Dbkey + * @default ? */ - output_label?: string | null; + dbkey: string; /** - * Output Name - * @description If this message is about an output to a step, - * this field describes the target output name. The output name as defined by the workflow module corresponding to the step being referenced. + * Deferred + * @default false */ - output_name?: string | null; + deferred: boolean; + /** Description */ + description?: string | null; + elements_from?: components["schemas"]["ElementsFromType"] | null; /** - * Step Label - * @description Reference to the step the message refers to. $ - * - * Messages don't have to be bound to a step, but if they are they will - * have a step_label and order_index included in the execution message. - * These are the label and order_index before applying the refactoring, - * the result of applying the action may change one or both of these. - * If connections are dropped this step reference will refer to the - * step with the previously connected input. + * Ext + * @default auto */ - step_label?: string | null; - }; - /** - * RefactorActionExecutionMessageTypeEnum - * @enum {string} - */ - RefactorActionExecutionMessageTypeEnum: - | "tool_version_change" - | "tool_state_adjustment" - | "connection_drop_forced" - | "workflow_output_drop_forced"; - /** RefactorRequest */ - RefactorRequest: { - /** Actions */ - actions: ( - | components["schemas"]["AddInputAction"] - | components["schemas"]["AddStepAction"] - | components["schemas"]["ConnectAction"] - | components["schemas"]["DisconnectAction"] - | components["schemas"]["ExtractInputAction"] - | components["schemas"]["ExtractUntypedParameter"] - | components["schemas"]["FileDefaultsAction"] - | components["schemas"]["FillStepDefaultsAction"] - | components["schemas"]["UpdateAnnotationAction"] - | components["schemas"]["UpdateCreatorAction"] - | components["schemas"]["UpdateNameAction"] - | components["schemas"]["UpdateLicenseAction"] - | components["schemas"]["UpdateOutputLabelAction"] - | components["schemas"]["UpdateReportAction"] - | components["schemas"]["UpdateStepLabelAction"] - | components["schemas"]["UpdateStepPositionAction"] - | components["schemas"]["UpgradeSubworkflowAction"] - | components["schemas"]["UpgradeToolAction"] - | components["schemas"]["UpgradeAllStepsAction"] - | components["schemas"]["RemoveUnlabeledWorkflowOutputs"] - )[]; + ext: string; + extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; + /** Info */ + info?: string | null; + /** Name */ + name?: string | number | boolean | null; /** - * Dry Run + * Paste Content + * @description Content to upload + */ + paste_content: string | number | boolean; + /** + * Space To Tab * @default false */ - dry_run?: boolean; + space_to_tab: boolean; /** - * Style - * @default export + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - style?: string; - }; - /** RefactorResponse */ - RefactorResponse: { - /** Action Executions */ - action_executions: components["schemas"]["RefactorActionExecution"][]; - /** Dry Run */ - dry_run: boolean; - /** Workflow */ - workflow: string; - }; - /** ReloadFeedback */ - ReloadFeedback: { - /** Failed */ - failed: (string | null)[]; - /** Message */ - message: string; - /** Reloaded */ - reloaded: (string | null)[]; + src: "pasted"; + /** Tags */ + tags?: string[] | null; + /** + * To Posix Lines + * @default false + */ + to_posix_lines: boolean; }; - /** RemoteDirectory */ - RemoteDirectory: { + /** PathDataElement */ + PathDataElement: { + /** Md5 */ + MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** - * Class - * @constant - * @enum {string} + * Auto Decompress + * @description Decompress compressed data before sniffing? + * @default false */ - class: "Directory"; + auto_decompress: boolean; + /** Collection Type */ + collection_type?: string | null; + /** Created From Basename */ + created_from_basename?: string | null; /** - * Name - * @description The name of the entry. + * Dbkey + * @default ? */ - name: string; + dbkey: string; /** - * Path - * @description The path of the entry. + * Deferred + * @default false + */ + deferred: boolean; + /** Description */ + description?: string | null; + elements_from?: components["schemas"]["ElementsFromType"] | null; + /** + * Ext + * @default auto */ + ext: string; + extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; + /** Info */ + info?: string | null; + /** Link Data Only */ + link_data_only?: boolean | null; + /** Name */ + name?: string | number | boolean | null; + /** Path */ path: string; /** - * URI - * @description The URI of the entry. + * Space To Tab + * @default false */ - uri: string; - }; - /** RemoteFile */ - RemoteFile: { + space_to_tab: boolean; /** - * Class - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ - class: "File"; + src: "path"; + /** Tags */ + tags?: string[] | null; /** - * Creation time - * @description The creation time of the file. + * To Posix Lines + * @default false */ - ctime: string; + to_posix_lines: boolean; + }; + /** PauseStep */ + PauseStep: { /** - * Name - * @description The name of the entry. + * Annotation + * @description An annotation to provide details or to help understand the purpose and usage of this item. */ - name: string; + annotation: string | null; /** - * Path - * @description The path of the entry. + * ID + * @description The identifier of the step. It matches the index order of the step inside the workflow. */ - path: string; + id: number; /** - * Size - * @description The size of the file in bytes. + * Input Steps + * @description A dictionary containing information about the inputs connected to this workflow step. */ - size: number; + input_steps: { + [key: string]: components["schemas"]["InputStep"]; + }; /** - * URI - * @description The URI of the entry. + * Tool ID + * @description The unique name of the tool associated with this step. */ - uri: string; - }; - /** - * RemoteFilesDisableMode - * @enum {string} - */ - RemoteFilesDisableMode: "folders" | "files"; - /** - * RemoteFilesFormat - * @enum {string} - */ - RemoteFilesFormat: "flat" | "jstree" | "uri"; - /** RemoteUserCreationPayload */ - RemoteUserCreationPayload: { + tool_id?: string | null; /** - * Email - * @description Email of the user + * Tool Inputs + * @description TODO */ - remote_user_email: string; - }; - /** RemoveUnlabeledWorkflowOutputs */ - RemoveUnlabeledWorkflowOutputs: { + tool_inputs?: unknown; /** - * Action Type - * @constant + * Tool Version + * @description The version of the tool associated with this step. + */ + tool_version?: string | null; + /** + * @description discriminator enum property added by openapi-typescript * @enum {string} */ - action_type: "remove_unlabeled_workflow_outputs"; - }; - /** Report */ - Report: { - /** Markdown */ - markdown: string; + type: "pause"; + /** When */ + when: string | null; }; - /** ReportJobErrorPayload */ - ReportJobErrorPayload: { + /** Person */ + Person: { + /** Address */ + address?: string | null; + /** Alternate Name */ + alternateName?: string | null; /** - * History Dataset Association ID - * @description The History Dataset Association ID related to the error. - * @example 0123456789ABCDEF + * Class + * @default Person */ - dataset_id: string; + class: string; + /** Email */ + email?: string | null; + /** Family Name */ + familyName?: string | null; + /** Fax Number */ + faxNumber?: string | null; + /** Given Name */ + givenName?: string | null; /** - * Email - * @description Email address for communication with the user. Only required for anonymous users. + * Honorific Prefix + * @description Honorific Prefix (e.g. Dr/Mrs/Mr) */ - email?: string | null; + honorificPrefix?: string | null; /** - * Message - * @description The optional message sent with the error report. + * Honorific Suffix + * @description Honorific Suffix (e.g. M.D.) */ - message?: string | null; + honorificSuffix?: string | null; + /** + * Identifier + * @description Identifier (typically an orcid.org ID) + */ + identifier?: string | null; + /** Image URL */ + image?: string | null; + /** Job Title */ + jobTitle?: string | null; + /** + * Name + * @description The name of the creator. + */ + name?: string | null; + /** Telephone */ + telephone?: string | null; + /** URL */ + url?: string | null; }; /** - * RequestDataType - * @description Particular pieces of information that can be requested for a dataset. + * PersonalNotificationCategory + * @description These notification categories can be opt-out by the user and will be + * displayed in the notification preferences. * @enum {string} */ - RequestDataType: - | "state" - | "converted_datasets_state" - | "data" - | "features" - | "raw_data" - | "track_config" - | "genome_data" - | "in_use_state"; + PersonalNotificationCategory: "message" | "new_shared_item"; + /** PluginAspectStatus */ + PluginAspectStatus: { + /** Message */ + message: string; + /** + * State + * @enum {string} + */ + state: "ok" | "not_ok" | "unknown"; + }; /** - * Requirement - * @description Available types of job sources (model classes) that produce dataset collections. + * PluginKind + * @description Enum to distinguish between different kinds or categories of plugins. * @enum {string} */ - Requirement: "logged_in" | "new_history" | "admin"; - /** RoleDefinitionModel */ - RoleDefinitionModel: { + PluginKind: "rfs" | "drs" | "rdm" | "stock"; + /** PluginStatus */ + PluginStatus: { + connection?: components["schemas"]["PluginAspectStatus"] | null; + oauth2_access_token_generation?: components["schemas"]["PluginAspectStatus"] | null; + template_definition: components["schemas"]["PluginAspectStatus"]; + template_settings?: components["schemas"]["PluginAspectStatus"] | null; + }; + /** Position */ + Position: { + /** Left */ + left: number; + /** Top */ + top: number; + }; + /** PrepareStoreDownloadPayload */ + PrepareStoreDownloadPayload: { /** - * Description - * @description Description of the role + * Bco Merge History Metadata + * @description When reading tags/annotations to generate BCO object include history metadata. + * @default false */ - description: string; + bco_merge_history_metadata: boolean; /** - * Group IDs - * @default [] + * Bco Override Algorithmic Error + * @description Override algorithmic error for 'error domain' when generating BioCompute object. */ - group_ids?: string[] | null; + bco_override_algorithmic_error?: { + [key: string]: string; + } | null; /** - * Name - * @description Name of the role + * Bco Override Empirical Error + * @description Override empirical error for 'error domain' when generating BioCompute object. */ - name: string; + bco_override_empirical_error?: { + [key: string]: string; + } | null; /** - * User IDs - * @default [] + * Bco Override Environment Variables + * @description Override environment variables for 'execution_domain' when generating BioCompute object. */ - user_ids?: string[] | null; - }; - /** RoleListResponse */ - RoleListResponse: components["schemas"]["RoleModelResponse"][]; - /** RoleModelResponse */ - RoleModelResponse: { - /** Description */ - description: string | null; + bco_override_environment_variables?: { + [key: string]: string; + } | null; /** - * ID - * @description Encoded ID of the role - * @example 0123456789ABCDEF + * Bco Override Xref + * @description Override xref for 'description domain' when generating BioCompute object. */ - id: string; + bco_override_xref?: components["schemas"]["XrefItem"][] | null; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Include deleted + * @description Include file contents for deleted datasets (if include_files is True). + * @default false */ - model_class: "Role"; + include_deleted: boolean; /** - * Name - * @description Name of the role + * Include Files + * @description include materialized files in export when available + * @default true */ - name: string; + include_files: boolean; /** - * Type - * @description Type or category of the role + * Include hidden + * @description Include file contents for hidden datasets (if include_files is True). + * @default false */ - type: string; + include_hidden: boolean; /** - * URL - * @deprecated - * @description The relative URL to access this item. + * @description format of model store to export + * @default tar.gz */ - url: string; - }; - /** RootModel[Dict[str, int]] */ - RootModel_Dict_str__int__: { - [key: string]: number; + model_store_format: components["schemas"]["ModelStoreFormat"]; }; - /** SearchJobsPayload */ - SearchJobsPayload: { + /** QuotaDetails */ + QuotaDetails: { /** - * Inputs - * @description The inputs of the job. + * Bytes + * @description The amount, expressed in bytes, of this Quota. */ - inputs: Record; + bytes: number; /** - * State - * @description Current state of the job. + * Default + * @description A list indicating which types of default user quotas, if any, are associated with this quota. + * @default [] */ - state?: components["schemas"]["JobState"] | null; + default: components["schemas"]["DefaultQuota"][]; /** - * Tool ID - * @description The tool ID related to the job. + * Description + * @description Detailed text description for this Quota. */ - tool_id: string; - [key: string]: unknown; - }; - /** ServerDirElement */ - ServerDirElement: { - /** Md5 */ - MD5?: string | null; + description: string; /** - * Auto Decompress - * @description Decompress compressed data before sniffing? - * @default false + * Display Amount + * @description Human-readable representation of the `amount` field. */ - auto_decompress?: boolean; - /** Collection Type */ - collection_type?: string | null; - /** Created From Basename */ - created_from_basename?: string | null; + display_amount: string; /** - * Dbkey - * @default ? + * Groups + * @description A list of specific groups of users associated with this quota. + * @default [] */ - dbkey?: string; + groups: components["schemas"]["GroupQuota"][]; /** - * Deferred - * @default false + * ID + * @description The `encoded identifier` of the quota. + * @example 0123456789ABCDEF */ - deferred?: boolean; - /** Description */ - description?: string | null; - elements_from?: components["schemas"]["ElementsFromType"] | null; - /** - * Ext - * @default auto - */ - ext?: string; - extra_files?: components["schemas"]["ExtraFiles"] | null; - /** Info */ - info?: string | null; - /** Link Data Only */ - link_data_only?: boolean | null; - /** Name */ - name?: string | number | boolean | null; - /** Server Dir */ - server_dir: string; - /** - * Space To Tab - * @default false - */ - space_to_tab?: boolean; + id: string; /** - * Src + * Model class + * @description The name of the database model class. * @constant * @enum {string} */ - src: "server_dir"; - /** Tags */ - tags?: string[] | null; - /** - * To Posix Lines - * @default false - */ - to_posix_lines?: boolean; - }; - /** Service */ - Service: { + model_class: "Quota"; /** - * Contacturl - * @description URL of the contact for the provider of this service, e.g. a link to a contact form (RFC 3986 format), or an email (RFC 2368 format). + * Name + * @description The name of the quota. This must be unique within a Galaxy instance. */ - contactUrl?: string | null; + name: string; /** - * Createdat - * @description Timestamp describing when the service was first deployed and available (RFC 3339 format) + * Operation + * @description Quotas can have one of three `operations`:- `=` : The quota is exactly the amount specified- `+` : The amount specified will be added to the amounts of the user's other associated quota definitions- `-` : The amount specified will be subtracted from the amounts of the user's other associated quota definitions + * @default = */ - createdAt?: string | null; + operation: components["schemas"]["QuotaOperation"]; /** - * Description - * @description Description of the service. Should be human readable and provide information about the service. + * Quota Source Label + * @description Quota source label */ - description?: string | null; + quota_source_label?: string | null; /** - * Documentationurl - * @description URL of the documentation of this service (RFC 3986 format). This should help someone learn how to use your service, including any specifics required to access data, e.g. authentication. + * Users + * @description A list of specific users associated with this quota. + * @default [] */ - documentationUrl?: string | null; + users: components["schemas"]["UserQuota"][]; + }; + /** QuotaModel */ + QuotaModel: { + /** Enabled */ + enabled: boolean; + /** Source */ + source?: string | null; + }; + /** + * QuotaOperation + * @enum {string} + */ + QuotaOperation: "=" | "+" | "-"; + /** + * QuotaSummary + * @description Contains basic information about a Quota + */ + QuotaSummary: { /** - * Environment - * @description Environment the service is running in. Use this to distinguish between production, development and testing/staging deployments. Suggested values are prod, test, dev, staging. However this is advised and not enforced. + * ID + * @description The `encoded identifier` of the quota. + * @example 0123456789ABCDEF */ - environment?: string | null; + id: string; /** - * Id - * @description Unique ID of this service. Reverse domain name notation is recommended, though not required. The identifier should attempt to be globally unique so it can be used in downstream aggregator services e.g. Service Registry. + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - id: string; + model_class: "Quota"; /** * Name - * @description Name of this service. Should be human readable. + * @description The name of the quota. This must be unique within a Galaxy instance. */ name: string; - /** @description Organization providing the service */ - organization: components["schemas"]["galaxy__schema__drs__Organization"]; - type: components["schemas"]["ServiceType"]; /** - * Updatedat - * @description Timestamp describing when the service was last updated (RFC 3339 format) + * Quota Source Label + * @description Quota source label */ - updatedAt?: string | null; + quota_source_label?: string | null; /** - * Version - * @description Version of the service being described. Semantic versioning is recommended, but other identifiers, such as dates or commit hashes, are also allowed. The version should be changed whenever the service is updated. + * URL + * @deprecated + * @description The relative URL to get this particular Quota details from the rest API. */ - version: string; + url: string; }; - /** ServiceType */ - ServiceType: { - /** - * Artifact - * @description Name of the API or GA4GH specification implemented. Official GA4GH types should be assigned as part of standards approval process. Custom artifacts are supported. - */ - artifact: string; + /** + * QuotaSummaryList + * @default [] + */ + QuotaSummaryList: components["schemas"]["QuotaSummary"][]; + /** RefactorActionExecution */ + RefactorActionExecution: { + /** Action */ + action: + | components["schemas"]["AddInputAction"] + | components["schemas"]["AddStepAction"] + | components["schemas"]["ConnectAction"] + | components["schemas"]["DisconnectAction"] + | components["schemas"]["ExtractInputAction"] + | components["schemas"]["ExtractUntypedParameter"] + | components["schemas"]["FileDefaultsAction"] + | components["schemas"]["FillStepDefaultsAction"] + | components["schemas"]["UpdateAnnotationAction"] + | components["schemas"]["UpdateCreatorAction"] + | components["schemas"]["UpdateNameAction"] + | components["schemas"]["UpdateLicenseAction"] + | components["schemas"]["UpdateOutputLabelAction"] + | components["schemas"]["UpdateReportAction"] + | components["schemas"]["UpdateStepLabelAction"] + | components["schemas"]["UpdateStepPositionAction"] + | components["schemas"]["UpgradeSubworkflowAction"] + | components["schemas"]["UpgradeToolAction"] + | components["schemas"]["UpgradeAllStepsAction"] + | components["schemas"]["RemoveUnlabeledWorkflowOutputs"]; + /** Messages */ + messages: components["schemas"]["RefactorActionExecutionMessage"][]; + }; + /** RefactorActionExecutionMessage */ + RefactorActionExecutionMessage: { /** - * Group - * @description Namespace in reverse domain name format. Use `org.ga4gh` for implementations compliant with official GA4GH specifications. For services with custom APIs not standardized by GA4GH, or implementations diverging from official GA4GH specifications, use a different namespace (e.g. your organization's reverse domain name). + * From Order Index + * @description For dropped connections these optional attributes refer to the output + * side of the connection that was dropped. */ - group: string; + from_order_index?: number | null; /** - * Version - * @description Version of the API or specification. GA4GH specifications use semantic versioning. + * From Step Label + * @description For dropped connections these optional attributes refer to the output + * side of the connection that was dropped. */ - version: string; - }; - /** SetSlugPayload */ - SetSlugPayload: { + from_step_label?: string | null; /** - * New Slug - * @description The slug that will be used to access this shared item. + * Input Name + * @description If this message is about an input to a step, + * this field describes the target input name. $The input name as defined by the workflow module corresponding to the step being referenced. For Galaxy tool steps these inputs should be normalized using '|' (e.g. 'cond|repeat_0|input'). */ - new_slug: string; - }; - /** ShareHistoryExtra */ - ShareHistoryExtra: { + input_name?: string | null; + /** Message */ + message: string; + message_type: components["schemas"]["RefactorActionExecutionMessageTypeEnum"]; /** - * Accessible Count - * @description The number of datasets in the history that are public or accessible by all the target users. - * @default 0 + * Order Index + * @description Reference to the step the message refers to. $ + * + * Messages don't have to be bound to a step, but if they are they will + * have a step_label and order_index included in the execution message. + * These are the label and order_index before applying the refactoring, + * the result of applying the action may change one or both of these. + * If connections are dropped this step reference will refer to the + * step with the previously connected input. + * */ - accessible_count?: number; + order_index?: number | null; /** - * Can Change - * @description A collection of datasets that are not accessible by one or more of the target users and that can be made accessible for others by the user sharing the history. - * @default [] + * Output Label + * @description If the message_type is workflow_output_drop_forced, this is the output label dropped. */ - can_change?: components["schemas"]["HDABasicInfo"][]; + output_label?: string | null; /** - * Can Share - * @description Indicates whether the resource can be directly shared or requires further actions. - * @default false + * Output Name + * @description If this message is about an output to a step, + * this field describes the target output name. The output name as defined by the workflow module corresponding to the step being referenced. + * */ - can_share?: boolean; + output_name?: string | null; /** - * Cannot Change - * @description A collection of datasets that are not accessible by one or more of the target users and that cannot be made accessible for others by the user sharing the history. - * @default [] + * Step Label + * @description Reference to the step the message refers to. $ + * + * Messages don't have to be bound to a step, but if they are they will + * have a step_label and order_index included in the execution message. + * These are the label and order_index before applying the refactoring, + * the result of applying the action may change one or both of these. + * If connections are dropped this step reference will refer to the + * step with the previously connected input. + * */ - cannot_change?: components["schemas"]["HDABasicInfo"][]; + step_label?: string | null; }; - /** ShareHistoryWithStatus */ - ShareHistoryWithStatus: { - /** - * Encoded Email - * @description Encoded owner email. - */ - email_hash?: string | null; + /** + * RefactorActionExecutionMessageTypeEnum + * @enum {string} + */ + RefactorActionExecutionMessageTypeEnum: + | "tool_version_change" + | "tool_state_adjustment" + | "connection_drop_forced" + | "workflow_output_drop_forced"; + /** RefactorRequest */ + RefactorRequest: { + /** Actions */ + actions: ( + | components["schemas"]["AddInputAction"] + | components["schemas"]["AddStepAction"] + | components["schemas"]["ConnectAction"] + | components["schemas"]["DisconnectAction"] + | components["schemas"]["ExtractInputAction"] + | components["schemas"]["ExtractUntypedParameter"] + | components["schemas"]["FileDefaultsAction"] + | components["schemas"]["FillStepDefaultsAction"] + | components["schemas"]["UpdateAnnotationAction"] + | components["schemas"]["UpdateCreatorAction"] + | components["schemas"]["UpdateNameAction"] + | components["schemas"]["UpdateLicenseAction"] + | components["schemas"]["UpdateOutputLabelAction"] + | components["schemas"]["UpdateReportAction"] + | components["schemas"]["UpdateStepLabelAction"] + | components["schemas"]["UpdateStepPositionAction"] + | components["schemas"]["UpgradeSubworkflowAction"] + | components["schemas"]["UpgradeToolAction"] + | components["schemas"]["UpgradeAllStepsAction"] + | components["schemas"]["RemoveUnlabeledWorkflowOutputs"] + )[]; /** - * Errors - * @description Collection of messages indicating that the resource was not shared with some (or all users) due to an error. - * @default [] + * Dry Run + * @default false */ - errors?: string[]; + dry_run: boolean; /** - * Extra - * @description Optional extra information about this shareable resource that may be of interest. The contents of this field depend on the particular resource. + * Style + * @default export */ - extra: components["schemas"]["ShareHistoryExtra"]; + style: string; + }; + /** RefactorResponse */ + RefactorResponse: { + /** Action Executions */ + action_executions: components["schemas"]["RefactorActionExecution"][]; + /** Dry Run */ + dry_run: boolean; + /** Workflow */ + workflow: string; + }; + /** ReloadFeedback */ + ReloadFeedback: { + /** Failed */ + failed: (string | null)[]; + /** Message */ + message: string; + /** Reloaded */ + reloaded: (string | null)[]; + }; + /** RemoteDirectory */ + RemoteDirectory: { /** - * ID - * @description The encoded ID of the resource to be shared. - * @example 0123456789ABCDEF + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - id: string; + class: "Directory"; /** - * Importable - * @description Whether this resource can be published using a link. + * Name + * @description The name of the entry. */ - importable: boolean; + name: string; /** - * Published - * @description Whether this resource is currently published. + * Path + * @description The path of the entry. */ - published: boolean; + path: string; /** - * Title - * @description The title or name of the resource. + * URI + * @description The URI of the entry. */ - title: string; + uri: string; + }; + /** RemoteFile */ + RemoteFile: { /** - * Username - * @description The owner's username. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - username?: string | null; + class: "File"; /** - * Username and slug - * @description The relative URL in the form of /u/{username}/{resource_single_char}/{slug} + * Creation time + * @description The creation time of the file. */ - username_and_slug?: string | null; + ctime: string; /** - * Users shared with - * @description The list of encoded ids for users the resource has been shared. - * @default [] + * Name + * @description The name of the entry. */ - users_shared_with?: components["schemas"]["UserEmail"][]; - }; - /** ShareWithExtra */ - ShareWithExtra: { + name: string; /** - * Can Share - * @description Indicates whether the resource can be directly shared or requires further actions. - * @default false + * Path + * @description The path of the entry. */ - can_share?: boolean; - }; - /** ShareWithPayload */ - ShareWithPayload: { + path: string; /** - * Share Option - * @description User choice for sharing resources which its contents may be restricted: - * - None: The user did not choose anything yet or no option is needed. - * - make_public: The contents of the resource will be made publicly accessible. - * - make_accessible_to_shared: This will automatically create a new `sharing role` allowing protected contents to be accessed only by the desired users. - * - no_changes: This won't change the current permissions for the contents. The user which this resource will be shared may not be able to access all its contents. + * Size + * @description The size of the file in bytes. */ - share_option?: components["schemas"]["SharingOptions"] | null; + size: number; /** - * User Identifiers - * @description A collection of encoded IDs (or email addresses) of users that this resource will be shared with. + * URI + * @description The URI of the entry. */ - user_ids: string[]; + uri: string; }; - /** ShareWithStatus */ - ShareWithStatus: { - /** - * Encoded Email - * @description Encoded owner email. - */ - email_hash?: string | null; + /** + * RemoteFilesDisableMode + * @enum {string} + */ + RemoteFilesDisableMode: "folders" | "files"; + /** + * RemoteFilesFormat + * @enum {string} + */ + RemoteFilesFormat: "flat" | "jstree" | "uri"; + /** RemoteUserCreationPayload */ + RemoteUserCreationPayload: { /** - * Errors - * @description Collection of messages indicating that the resource was not shared with some (or all users) due to an error. - * @default [] + * Email + * @description Email of the user */ - errors?: string[]; + remote_user_email: string; + }; + /** RemoveUnlabeledWorkflowOutputs */ + RemoveUnlabeledWorkflowOutputs: { /** - * Extra - * @description Optional extra information about this shareable resource that may be of interest. The contents of this field depend on the particular resource. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - extra?: components["schemas"]["ShareWithExtra"] | null; + action_type: "remove_unlabeled_workflow_outputs"; + }; + /** Report */ + Report: { + /** Markdown */ + markdown: string; + }; + /** ReportJobErrorPayload */ + ReportJobErrorPayload: { /** - * ID - * @description The encoded ID of the resource to be shared. + * History Dataset Association ID + * @description The History Dataset Association ID related to the error. * @example 0123456789ABCDEF */ - id: string; + dataset_id: string; /** - * Importable - * @description Whether this resource can be published using a link. + * Email + * @description Email address for communication with the user. Only required for anonymous users. */ - importable: boolean; + email?: string | null; /** - * Published - * @description Whether this resource is currently published. + * Message + * @description The optional message sent with the error report. */ - published: boolean; + message?: string | null; + }; + /** + * RequestDataType + * @description Particular pieces of information that can be requested for a dataset. + * @enum {string} + */ + RequestDataType: + | "state" + | "converted_datasets_state" + | "data" + | "features" + | "raw_data" + | "track_config" + | "genome_data" + | "in_use_state"; + /** + * Requirement + * @description Available types of job sources (model classes) that produce dataset collections. + * @enum {string} + */ + Requirement: "logged_in" | "new_history" | "admin"; + /** RoleDefinitionModel */ + RoleDefinitionModel: { /** - * Title - * @description The title or name of the resource. + * Description + * @description Description of the role */ - title: string; + description: string; /** - * Username - * @description The owner's username. + * Group IDs + * @default [] */ - username?: string | null; + group_ids: string[] | null; /** - * Username and slug - * @description The relative URL in the form of /u/{username}/{resource_single_char}/{slug} + * Name + * @description Name of the role */ - username_and_slug?: string | null; + name: string; /** - * Users shared with - * @description The list of encoded ids for users the resource has been shared. + * User IDs * @default [] */ - users_shared_with?: components["schemas"]["UserEmail"][]; + user_ids: string[] | null; }; - /** - * SharingOptions - * @description Options for sharing resources that may have restricted access to all or part of their contents. - * @enum {string} - */ - SharingOptions: "make_public" | "make_accessible_to_shared" | "no_changes"; - /** SharingStatus */ - SharingStatus: { - /** - * Encoded Email - * @description Encoded owner email. - */ - email_hash?: string | null; + /** RoleListResponse */ + RoleListResponse: components["schemas"]["RoleModelResponse"][]; + /** RoleModelResponse */ + RoleModelResponse: { + /** Description */ + description: string | null; /** * ID - * @description The encoded ID of the resource to be shared. + * @description Encoded ID of the role * @example 0123456789ABCDEF */ id: string; /** - * Importable - * @description Whether this resource can be published using a link. + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - importable: boolean; + model_class: "Role"; /** - * Published - * @description Whether this resource is currently published. + * Name + * @description Name of the role */ - published: boolean; + name: string; /** - * Title - * @description The title or name of the resource. + * Type + * @description Type or category of the role */ - title: string; + type: string; /** - * Username - * @description The owner's username. + * URL + * @deprecated + * @description The relative URL to access this item. */ - username?: string | null; + url: string; + }; + /** RootModel[Dict[str, int]] */ + RootModel_Dict_str__int__: { + [key: string]: number; + }; + /** SearchJobsPayload */ + SearchJobsPayload: { /** - * Username and slug - * @description The relative URL in the form of /u/{username}/{resource_single_char}/{slug} + * Inputs + * @description The inputs of the job. */ - username_and_slug?: string | null; + inputs: Record; /** - * Users shared with - * @description The list of encoded ids for users the resource has been shared. - * @default [] - */ - users_shared_with?: components["schemas"]["UserEmail"][]; + * State + * @description Current state of the job. + */ + state?: components["schemas"]["JobState"] | null; + /** + * Tool ID + * @description The tool ID related to the job. + */ + tool_id: string; + } & { + [key: string]: unknown; }; - /** ShortTermStoreExportPayload */ - ShortTermStoreExportPayload: { - /** Duration */ - duration?: number | null; + /** ServerDirElement */ + ServerDirElement: { + /** Md5 */ + MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** - * Include deleted - * @description Include file contents for deleted datasets (if include_files is True). + * Auto Decompress + * @description Decompress compressed data before sniffing? * @default false */ - include_deleted?: boolean; + auto_decompress: boolean; + /** Collection Type */ + collection_type?: string | null; + /** Created From Basename */ + created_from_basename?: string | null; /** - * Include Files - * @description include materialized files in export when available - * @default true + * Dbkey + * @default ? */ - include_files?: boolean; + dbkey: string; /** - * Include hidden - * @description Include file contents for hidden datasets (if include_files is True). + * Deferred * @default false */ - include_hidden?: boolean; + deferred: boolean; + /** Description */ + description?: string | null; + elements_from?: components["schemas"]["ElementsFromType"] | null; /** - * @description format of model store to export - * @default tar.gz + * Ext + * @default auto */ - model_store_format?: components["schemas"]["ModelStoreFormat"]; + ext: string; + extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; + /** Info */ + info?: string | null; + /** Link Data Only */ + link_data_only?: boolean | null; + /** Name */ + name?: string | number | boolean | null; + /** Server Dir */ + server_dir: string; /** - * Short Term Storage Request Id - * Format: uuid + * Space To Tab + * @default false */ - short_term_storage_request_id: string; - }; - /** ShowFullJobResponse */ - ShowFullJobResponse: { + space_to_tab: boolean; /** - * Command Line - * @description The command line produced by the job. Users can see this value if allowed in the configuration, administrator can always see this value. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - command_line?: string | null; + src: "server_dir"; + /** Tags */ + tags?: string[] | null; /** - * Command Version - * @description Tool version indicated during job execution. + * To Posix Lines + * @default false */ - command_version?: string | null; + to_posix_lines: boolean; + }; + /** Service */ + Service: { /** - * Copied from Job-ID - * @description Reference to cached job if job execution was cached. + * Contacturl + * @description URL of the contact for the provider of this service, e.g. a link to a contact form (RFC 3986 format), or an email (RFC 2368 format). */ - copied_from_job_id?: string | null; + contactUrl?: string | null; /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * Createdat + * @description Timestamp describing when the service was first deployed and available (RFC 3339 format) */ - create_time: string; + createdAt?: string | null; /** - * Job dependencies - * @description The dependencies of the job. + * Description + * @description Description of the service. Should be human readable and provide information about the service. */ - dependencies?: unknown[] | null; + description?: string | null; /** - * Exit Code - * @description The exit code returned by the tool. Can be unset if the job is not completed yet. + * Documentationurl + * @description URL of the documentation of this service (RFC 3986 format). This should help someone learn how to use your service, including any specifics required to access data, e.g. authentication. */ - exit_code?: number | null; + documentationUrl?: string | null; /** - * External ID - * @description The job id used by the external job runner (Condor, Pulsar, etc.). Only administrator can see this value. + * Environment + * @description Environment the service is running in. Use this to distinguish between production, development and testing/staging deployments. Suggested values are prod, test, dev, staging. However this is advised and not enforced. */ - external_id?: string | null; + environment?: string | null; /** - * Galaxy Version - * @description The (major) version of Galaxy used to create this job. + * Id + * @description Unique ID of this service. Reverse domain name notation is recommended, though not required. The identifier should attempt to be globally unique so it can be used in downstream aggregator services e.g. Service Registry. */ - galaxy_version?: string | null; + id: string; /** - * Job Handler - * @description The job handler process assigned to handle this job. Only administrator can see this value. + * Name + * @description Name of this service. Should be human readable. */ - handler?: string | null; + name: string; + /** @description Organization providing the service */ + organization: components["schemas"]["galaxy__schema__drs__Organization"]; + type: components["schemas"]["ServiceType"]; /** - * History ID - * @description The encoded ID of the history associated with this item. + * Updatedat + * @description Timestamp describing when the service was last updated (RFC 3339 format) */ - history_id?: string | null; + updatedAt?: string | null; /** - * Job ID - * @example 0123456789ABCDEF + * Version + * @description Version of the service being described. Semantic versioning is recommended, but other identifiers, such as dates or commit hashes, are also allowed. The version should be changed whenever the service is updated. */ - id: string; + version: string; + }; + /** ServiceType */ + ServiceType: { /** - * Inputs - * @description Dictionary mapping all the tool inputs (by name) to the corresponding data references. - * @default {} + * Artifact + * @description Name of the API or GA4GH specification implemented. Official GA4GH types should be assigned as part of standards approval process. Custom artifacts are supported. */ - inputs?: { - [key: string]: components["schemas"]["EncodedDatasetJobInfo"]; - }; + artifact: string; /** - * Job Messages - * @description List with additional information and possible reasons for a failed job. + * Group + * @description Namespace in reverse domain name format. Use `org.ga4gh` for implementations compliant with official GA4GH specifications. For services with custom APIs not standardized by GA4GH, or implementations diverging from official GA4GH specifications, use a different namespace (e.g. your organization's reverse domain name). */ - job_messages?: unknown[] | null; + group: string; /** - * Job Metrics - * @description Collections of metrics provided by `JobInstrumenter` plugins on a particular job. Only administrators can see these metrics. + * Version + * @description Version of the API or specification. GA4GH specifications use semantic versioning. */ - job_metrics?: components["schemas"]["JobMetricCollection"] | null; + version: string; + }; + /** SetSlugPayload */ + SetSlugPayload: { /** - * Job Runner Name - * @description Name of the job runner plugin that handles this job. Only administrator can see this value. + * New Slug + * @description The slug that will be used to access this shared item. */ - job_runner_name?: string | null; + new_slug: string; + }; + /** ShareHistoryExtra */ + ShareHistoryExtra: { /** - * Job Standard Error - * @description The captured standard error of the job execution. + * Accessible Count + * @description The number of datasets in the history that are public or accessible by all the target users. + * @default 0 */ - job_stderr?: string | null; + accessible_count: number; /** - * Job Standard Output - * @description The captured standard output of the job execution. + * Can Change + * @description A collection of datasets that are not accessible by one or more of the target users and that can be made accessible for others by the user sharing the history. + * @default [] */ - job_stdout?: string | null; + can_change: components["schemas"]["HDABasicInfo"][]; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Can Share + * @description Indicates whether the resource can be directly shared or requires further actions. + * @default false */ - model_class: "Job"; + can_share: boolean; /** - * Output collections - * @default {} + * Cannot Change + * @description A collection of datasets that are not accessible by one or more of the target users and that cannot be made accessible for others by the user sharing the history. + * @default [] */ - output_collections?: { - [key: string]: components["schemas"]["EncodedHdcaSourceId"]; - }; + cannot_change: components["schemas"]["HDABasicInfo"][]; + }; + /** ShareHistoryWithStatus */ + ShareHistoryWithStatus: { /** - * Outputs - * @description Dictionary mapping all the tool outputs (by name) to the corresponding data references. - * @default {} + * Encoded Email + * @description Encoded owner email. */ - outputs?: { - [key: string]: components["schemas"]["EncodedDatasetJobInfo"]; - }; + email_hash?: string | null; /** - * Parameters - * @description Object containing all the parameters of the tool associated with this job. The specific parameters depend on the tool itself. + * Errors + * @description Collection of messages indicating that the resource was not shared with some (or all users) due to an error. + * @default [] */ - params: unknown; + errors: string[]; /** - * State - * @description Current state of the job. + * Extra + * @description Optional extra information about this shareable resource that may be of interest. The contents of this field depend on the particular resource. */ - state: components["schemas"]["JobState"]; + extra: components["schemas"]["ShareHistoryExtra"]; /** - * Standard Error - * @description Combined tool and job standard error streams. + * ID + * @description The encoded ID of the resource to be shared. + * @example 0123456789ABCDEF */ - stderr?: string | null; + id: string; /** - * Standard Output - * @description Combined tool and job standard output streams. + * Importable + * @description Whether this resource can be published using a link. */ - stdout?: string | null; + importable: boolean; /** - * Tool ID - * @description Identifier of the tool that generated this job. + * Published + * @description Whether this resource is currently published. */ - tool_id: string; + published: boolean; /** - * Tool Standard Error - * @description The captured standard error of the tool executed by the job. + * Title + * @description The title or name of the resource. */ - tool_stderr?: string | null; + title: string; /** - * Tool Standard Output - * @description The captured standard output of the tool executed by the job. + * Username + * @description The owner's username. */ - tool_stdout?: string | null; + username?: string | null; /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. + * Username and slug + * @description The relative URL in the form of /u/{username}/{resource_single_char}/{slug} */ - update_time: string; + username_and_slug?: string | null; /** - * User Email - * @description The email of the user that owns this job. Only the owner of the job and administrators can see this value. + * Users shared with + * @description The list of encoded ids for users the resource has been shared. + * @default [] */ - user_email?: string | null; + users_shared_with: components["schemas"]["UserEmail"][]; }; - /** - * Src - * @enum {string} - */ - Src: "url" | "pasted" | "files" | "path" | "composite" | "ftp_import" | "server_dir"; - /** StepReferenceByLabel */ - StepReferenceByLabel: { + /** ShareWithExtra */ + ShareWithExtra: { /** - * Label - * @description The unique label of the step being referenced. + * Can Share + * @description Indicates whether the resource can be directly shared or requires further actions. + * @default false */ - label: string; + can_share: boolean; }; - /** StepReferenceByOrderIndex */ - StepReferenceByOrderIndex: { + /** ShareWithPayload */ + ShareWithPayload: { /** - * Order Index - * @description The order_index of the step being referenced. The order indices of a workflow start at 0. + * Share Option + * @description User choice for sharing resources which its contents may be restricted: + * - None: The user did not choose anything yet or no option is needed. + * - make_public: The contents of the resource will be made publicly accessible. + * - make_accessible_to_shared: This will automatically create a new `sharing role` allowing protected contents to be accessed only by the desired users. + * - no_changes: This won't change the current permissions for the contents. The user which this resource will be shared may not be able to access all its contents. + * */ - order_index: number; - }; - /** StorageItemCleanupError */ - StorageItemCleanupError: { - /** Error */ - error: string; + share_option?: components["schemas"]["SharingOptions"] | null; /** - * Item Id - * @example 0123456789ABCDEF + * User Identifiers + * @description A collection of encoded IDs (or email addresses) of users that this resource will be shared with. */ - item_id: string; - }; - /** StorageItemsCleanupResult */ - StorageItemsCleanupResult: { - /** Errors */ - errors: components["schemas"]["StorageItemCleanupError"][]; - /** Success Item Count */ - success_item_count: number; - /** Total Free Bytes */ - total_free_bytes: number; - /** Total Item Count */ - total_item_count: number; + user_ids: string[]; }; - /** StoreExportPayload */ - StoreExportPayload: { - /** - * Include deleted - * @description Include file contents for deleted datasets (if include_files is True). - * @default false - */ - include_deleted?: boolean; + /** ShareWithStatus */ + ShareWithStatus: { /** - * Include Files - * @description include materialized files in export when available - * @default true + * Encoded Email + * @description Encoded owner email. */ - include_files?: boolean; + email_hash?: string | null; /** - * Include hidden - * @description Include file contents for hidden datasets (if include_files is True). - * @default false + * Errors + * @description Collection of messages indicating that the resource was not shared with some (or all users) due to an error. + * @default [] */ - include_hidden?: boolean; + errors: string[]; /** - * @description format of model store to export - * @default tar.gz + * Extra + * @description Optional extra information about this shareable resource that may be of interest. The contents of this field depend on the particular resource. */ - model_store_format?: components["schemas"]["ModelStoreFormat"]; - }; - /** StoredItem */ - StoredItem: { + extra?: components["schemas"]["ShareWithExtra"] | null; /** - * Id + * ID + * @description The encoded ID of the resource to be shared. * @example 0123456789ABCDEF */ id: string; - /** Name */ - name: string; - /** Size */ - size: number; - /** Type */ - type: "history" | "dataset"; - /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. - */ - update_time: string; - }; - /** - * StoredItemOrderBy - * @description Available options for sorting Stored Items results. - * @enum {string} - */ - StoredItemOrderBy: "name-asc" | "name-dsc" | "size-asc" | "size-dsc" | "update_time-asc" | "update_time-dsc"; - /** StoredWorkflowDetailed */ - StoredWorkflowDetailed: { /** - * Annotation - * @description An annotation to provide details or to help understand the purpose and usage of this item. + * Importable + * @description Whether this resource can be published using a link. */ - annotation: string | null; + importable: boolean; /** - * Annotations - * @description An list of annotations to provide details or to help understand the purpose and usage of this workflow. + * Published + * @description Whether this resource is currently published. */ - annotations?: string[] | null; + published: boolean; /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * Title + * @description The title or name of the resource. */ - create_time: string; + title: string; /** - * Creator - * @description Additional information about the creator (or multiple creators) of this workflow. + * Username + * @description The owner's username. */ - creator?: - | (components["schemas"]["Person"] | components["schemas"]["galaxy__schema__schema__Organization"])[] - | null; + username?: string | null; /** - * Deleted - * @description Whether this item is marked as deleted. + * Username and slug + * @description The relative URL in the form of /u/{username}/{resource_single_char}/{slug} */ - deleted: boolean; + username_and_slug?: string | null; /** - * Email Hash - * @description The hash of the email of the creator of this workflow + * Users shared with + * @description The list of encoded ids for users the resource has been shared. + * @default [] */ - email_hash: string | null; + users_shared_with: components["schemas"]["UserEmail"][]; + }; + /** + * SharingOptions + * @description Options for sharing resources that may have restricted access to all or part of their contents. + * @enum {string} + */ + SharingOptions: "make_public" | "make_accessible_to_shared" | "no_changes"; + /** SharingStatus */ + SharingStatus: { /** - * Hidden - * @description TODO + * Encoded Email + * @description Encoded owner email. */ - hidden: boolean; + email_hash?: string | null; /** - * Id + * ID + * @description The encoded ID of the resource to be shared. * @example 0123456789ABCDEF */ id: string; /** * Importable - * @description Indicates if the workflow is importable by the current user. + * @description Whether this resource can be published using a link. */ - importable: boolean | null; + importable: boolean; /** - * Inputs - * @description A dictionary containing information about all the inputs of the workflow. - * @default {} + * Published + * @description Whether this resource is currently published. */ - inputs?: { - [key: string]: components["schemas"]["WorkflowInput"]; - }; + published: boolean; /** - * Latest workflow UUID - * @description TODO + * Title + * @description The title or name of the resource. */ - latest_workflow_uuid?: string | null; + title: string; /** - * License - * @description SPDX Identifier of the license associated with this workflow. + * Username + * @description The owner's username. */ - license?: string | null; + username?: string | null; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Username and slug + * @description The relative URL in the form of /u/{username}/{resource_single_char}/{slug} */ - model_class: "StoredWorkflow"; + username_and_slug?: string | null; /** - * Name - * @description The name of the history. + * Users shared with + * @description The list of encoded ids for users the resource has been shared. + * @default [] */ - name: string; + users_shared_with: components["schemas"]["UserEmail"][]; + }; + /** ShortTermStoreExportPayload */ + ShortTermStoreExportPayload: { + /** Duration */ + duration?: number | null; /** - * Number of Steps - * @description The number of steps that make up this workflow. + * Include deleted + * @description Include file contents for deleted datasets (if include_files is True). + * @default false */ - number_of_steps?: number | null; + include_deleted: boolean; /** - * Owner - * @description The name of the user who owns this workflow. + * Include Files + * @description include materialized files in export when available + * @default true */ - owner: string; + include_files: boolean; /** - * Published - * @description Whether this workflow is currently publicly available to all users. + * Include hidden + * @description Include file contents for hidden datasets (if include_files is True). + * @default false */ - published: boolean; + include_hidden: boolean; /** - * Show in Tool Panel - * @description Whether to display this workflow in the Tools Panel. + * @description format of model store to export + * @default tar.gz */ - show_in_tool_panel?: boolean | null; + model_store_format: components["schemas"]["ModelStoreFormat"]; /** - * Slug - * @description The slug of the workflow. + * Short Term Storage Request Id + * Format: uuid */ - slug: string | null; + short_term_storage_request_id: string; + }; + /** ShowFullJobResponse */ + ShowFullJobResponse: { /** - * Source Metadata - * @description The source metadata of the workflow. + * Command Line + * @description The command line produced by the job. Users can see this value if allowed in the configuration, administrator can always see this value. */ - source_metadata: Record | null; + command_line?: string | null; /** - * Steps - * @description A dictionary with information about all the steps of the workflow. - * @default {} + * Command Version + * @description Tool version indicated during job execution. */ - steps?: { - [key: string]: - | components["schemas"]["InputDataStep"] - | components["schemas"]["InputDataCollectionStep"] - | components["schemas"]["InputParameterStep"] - | components["schemas"]["PauseStep"] - | components["schemas"]["ToolStep"] - | components["schemas"]["SubworkflowStep"]; - }; - tags: components["schemas"]["TagCollection"]; - /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. - */ - update_time: string; + command_version?: string | null; /** - * URL - * @deprecated - * @description The relative URL to access this item. + * Copied from Job-ID + * @description Reference to cached job if job execution was cached. */ - url: string; + copied_from_job_id?: string | null; /** - * Version - * @description The version of the workflow represented by an incremental number. + * Create Time + * Format: date-time + * @description The time and date this item was created. */ - version: number; - }; - /** SubworkflowStep */ - SubworkflowStep: { + create_time: string; /** - * Annotation - * @description An annotation to provide details or to help understand the purpose and usage of this item. + * Job dependencies + * @description The dependencies of the job. */ - annotation: string | null; + dependencies?: unknown[] | null; /** - * ID - * @description The identifier of the step. It matches the index order of the step inside the workflow. + * Exit Code + * @description The exit code returned by the tool. Can be unset if the job is not completed yet. */ - id: number; + exit_code?: number | null; /** - * Input Steps - * @description A dictionary containing information about the inputs connected to this workflow step. + * External ID + * @description The job id used by the external job runner (Condor, Pulsar, etc.). Only administrator can see this value. */ - input_steps: { - [key: string]: components["schemas"]["InputStep"]; - }; + external_id?: string | null; /** - * Tool ID - * @description The unique name of the tool associated with this step. + * Galaxy Version + * @description The (major) version of Galaxy used to create this job. */ - tool_id?: string | null; + galaxy_version?: string | null; /** - * Tool Inputs - * @description TODO + * Job Handler + * @description The job handler process assigned to handle this job. Only administrator can see this value. */ - tool_inputs?: unknown; + handler?: string | null; /** - * Tool Version - * @description The version of the tool associated with this step. + * History ID + * @description The encoded ID of the history associated with this item. */ - tool_version?: string | null; + history_id?: string | null; /** - * Type - * @constant - * @enum {string} + * Job ID + * @example 0123456789ABCDEF */ - type: "subworkflow"; - /** When */ - when: string | null; + id: string; /** - * Workflow ID - * @description The encoded ID of the workflow that will be run on this step. - * @example 0123456789ABCDEF + * Inputs + * @description Dictionary mapping all the tool inputs (by name) to the corresponding data references. + * @default {} */ - workflow_id: string; - }; - /** SuitableConverter */ - SuitableConverter: { + inputs: { + [key: string]: components["schemas"]["EncodedDatasetJobInfo"]; + }; /** - * Name - * @description The name of the converter. + * Job Messages + * @description List with additional information and possible reasons for a failed job. */ - name: string; + job_messages?: unknown[] | null; /** - * Original Type - * @description The type to convert from. + * Job Metrics + * @description Collections of metrics provided by `JobInstrumenter` plugins on a particular job. Only administrators can see these metrics. */ - original_type: string; + job_metrics?: components["schemas"]["JobMetricCollection"] | null; /** - * Target Type - * @description The type to convert to. + * Job Runner Name + * @description Name of the job runner plugin that handles this job. Only administrator can see this value. */ - target_type: string; + job_runner_name?: string | null; /** - * Tool Id - * @description The ID of the tool that can perform the type conversion. + * Job Standard Error + * @description The captured standard error of the job execution. */ - tool_id: string; - }; - /** - * SuitableConverters - * @description Collection of converters that can be used on a particular dataset collection. - */ - SuitableConverters: components["schemas"]["SuitableConverter"][]; - /** - * SupportedType - * @enum {string} - */ - SupportedType: "None" | "BasicAuth" | "BearerAuth" | "PassportAuth"; - /** - * TagCollection - * @description Represents the collection of tags associated with an item. - */ - TagCollection: string[]; - /** TagOperationParams */ - TagOperationParams: { - /** Tags */ - tags: string[]; - /** Type */ - type: "add_tags" | "remove_tags"; - }; - /** - * TaggableItemClass - * @enum {string} - */ - TaggableItemClass: - | "History" - | "HistoryDatasetAssociation" - | "HistoryDatasetCollectionAssociation" - | "LibraryDatasetDatasetAssociation" - | "Page" - | "StoredWorkflow" - | "Visualization"; - /** - * TaskState - * @description Enum representing the possible states of a task. - * @enum {string} - */ - TaskState: "PENDING" | "STARTED" | "RETRY" | "FAILURE" | "SUCCESS"; - /** TemplateSecret */ - TemplateSecret: { - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; - }; - /** TemplateVariableBoolean */ - TemplateVariableBoolean: { + job_stderr?: string | null; /** - * Default - * @default false + * Job Standard Output + * @description The captured standard output of the job execution. */ - default?: boolean; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; + job_stdout?: string | null; /** - * Type + * Model class + * @description The name of the database model class. * @constant * @enum {string} */ - type: "boolean"; - }; - /** TemplateVariableInteger */ - TemplateVariableInteger: { + model_class: "Job"; /** - * Default - * @default 0 + * Output collections + * @default {} */ - default?: number; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; + output_collections: { + [key: string]: components["schemas"]["EncodedHdcaSourceId"]; + }; /** - * Type - * @constant - * @enum {string} + * Outputs + * @description Dictionary mapping all the tool outputs (by name) to the corresponding data references. + * @default {} */ - type: "integer"; - }; - /** TemplateVariablePathComponent */ - TemplateVariablePathComponent: { - /** Default */ - default?: string | null; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; + outputs: { + [key: string]: components["schemas"]["EncodedDatasetJobInfo"]; + }; /** - * Type - * @constant - * @enum {string} + * Parameters + * @description Object containing all the parameters of the tool associated with this job. The specific parameters depend on the tool itself. */ - type: "path_component"; - }; - /** TemplateVariableString */ - TemplateVariableString: { + params: unknown; /** - * Default - * @default + * State + * @description Current state of the job. */ - default?: string; - /** Help */ - help: string | null; - /** Label */ - label?: string | null; - /** Name */ - name: string; + state: components["schemas"]["JobState"]; /** - * Type - * @constant - * @enum {string} + * Standard Error + * @description Combined tool and job standard error streams. */ - type: "string"; - }; - /** ToolDataDetails */ - ToolDataDetails: { + stderr?: string | null; /** - * Columns - * @description A list of column names + * Standard Output + * @description Combined tool and job standard output streams. */ - columns: string[]; + stdout?: string | null; /** - * Fields - * @default [] + * Tool ID + * @description Identifier of the tool that generated this job. */ - fields?: string[][]; + tool_id: string; /** - * Model class - * @description The name of class modelling this tool data + * Tool Standard Error + * @description The captured standard error of the tool executed by the job. */ - model_class: string; + tool_stderr?: string | null; /** - * Name - * @description The name of this tool data entry + * Tool Standard Output + * @description The captured standard output of the tool executed by the job. */ - name: string; + tool_stdout?: string | null; + /** + * Update Time + * Format: date-time + * @description The last time and date this item was updated. + */ + update_time: string; + /** + * User Email + * @description The email of the user that owns this job. Only the owner of the job and administrators can see this value. + */ + user_email?: string | null; + /** + * User Id + * @description User ID of user that ran this job + */ + user_id?: string | null; }; - /** ToolDataEntry */ - ToolDataEntry: { + /** + * Src + * @enum {string} + */ + Src: "url" | "pasted" | "files" | "path" | "composite" | "ftp_import" | "server_dir"; + /** StepReferenceByLabel */ + StepReferenceByLabel: { /** - * Model class - * @description The name of class modelling this tool data + * Label + * @description The unique label of the step being referenced. */ - model_class: string; + label: string; + }; + /** StepReferenceByOrderIndex */ + StepReferenceByOrderIndex: { /** - * Name - * @description The name of this tool data entry + * Order Index + * @description The order_index of the step being referenced. The order indices of a workflow start at 0. */ - name: string; + order_index: number; }; - /** ToolDataEntryList */ - ToolDataEntryList: components["schemas"]["ToolDataEntry"][]; - /** ToolDataField */ - ToolDataField: { + /** StorageItemCleanupError */ + StorageItemCleanupError: { + /** Error */ + error: string; /** - * Base directories - * @description A list of directories where the data files are stored + * Item Id + * @example 0123456789ABCDEF */ - base_dir: string[]; - /** Fields */ - fields: { - [key: string]: string; - }; + item_id: string; + }; + /** StorageItemsCleanupResult */ + StorageItemsCleanupResult: { + /** Errors */ + errors: components["schemas"]["StorageItemCleanupError"][]; + /** Success Item Count */ + success_item_count: number; + /** Total Free Bytes */ + total_free_bytes: number; + /** Total Item Count */ + total_item_count: number; + }; + /** StoreExportPayload */ + StoreExportPayload: { /** - * Files - * @description A dictionary of file names and their size in bytes + * Include deleted + * @description Include file contents for deleted datasets (if include_files is True). + * @default false */ - files: { - [key: string]: number; - }; + include_deleted: boolean; /** - * Fingerprint - * @description SHA1 Hash + * Include Files + * @description include materialized files in export when available + * @default true */ - fingerprint: string; + include_files: boolean; /** - * Model class - * @description The name of class modelling this tool data field + * Include hidden + * @description Include file contents for hidden datasets (if include_files is True). + * @default false */ - model_class: string; + include_hidden: boolean; /** - * Name - * @description The name of the field + * @description format of model store to export + * @default tar.gz */ - name: string; + model_store_format: components["schemas"]["ModelStoreFormat"]; }; - /** ToolDataItem */ - ToolDataItem: { + /** StoredItem */ + StoredItem: { /** - * Values - * @description A `\t` (TAB) separated list of column __contents__. You must specify a value for each of the columns of the data table. + * Id + * @example 0123456789ABCDEF */ - values: string; + id: string; + /** Name */ + name: string; + /** Size */ + size: number; + /** Type */ + type: "history" | "dataset"; + /** + * Update Time + * Format: date-time + * @description The last time and date this item was updated. + */ + update_time: string; }; - /** ToolStep */ - ToolStep: { + /** + * StoredItemOrderBy + * @description Available options for sorting Stored Items results. + * @enum {string} + */ + StoredItemOrderBy: "name-asc" | "name-dsc" | "size-asc" | "size-dsc" | "update_time-asc" | "update_time-dsc"; + /** StoredWorkflowDetailed */ + StoredWorkflowDetailed: { /** * Annotation * @description An annotation to provide details or to help understand the purpose and usage of this item. */ annotation: string | null; /** - * ID - * @description The identifier of the step. It matches the index order of the step inside the workflow. + * Annotations + * @description An list of annotations to provide details or to help understand the purpose and usage of this workflow. */ - id: number; + annotations?: string[] | null; /** - * Input Steps - * @description A dictionary containing information about the inputs connected to this workflow step. + * Create Time + * Format: date-time + * @description The time and date this item was created. */ - input_steps: { - [key: string]: components["schemas"]["InputStep"]; - }; + create_time: string; /** - * Tool ID - * @description The unique name of the tool associated with this step. + * Creator + * @description Additional information about the creator (or multiple creators) of this workflow. */ - tool_id?: string | null; + creator?: + | (components["schemas"]["Person"] | components["schemas"]["galaxy__schema__schema__Organization"])[] + | null; /** - * Tool Inputs - * @description TODO + * Deleted + * @description Whether this item is marked as deleted. */ - tool_inputs?: unknown; + deleted: boolean; /** - * Tool Version - * @description The version of the tool associated with this step. + * Email Hash + * @description The hash of the email of the creator of this workflow */ - tool_version?: string | null; + email_hash: string | null; /** - * Type - * @constant - * @enum {string} + * Hidden + * @description TODO */ - type: "tool"; - /** When */ - when: string | null; - }; - /** Tour */ - Tour: { + hidden: boolean; /** - * Description - * @description Tour description + * Id + * @example 0123456789ABCDEF */ - description: string; + id: string; /** - * Identifier - * @description Tour identifier + * Importable + * @description Indicates if the workflow is importable by the current user. */ - id: string; + importable: boolean | null; /** - * Name - * @description Name of tour + * Inputs + * @description A dictionary containing information about all the inputs of the workflow. + * @default {} */ - name: string; + inputs: { + [key: string]: components["schemas"]["WorkflowInput"]; + }; /** - * Requirements - * @description Requirements to run the tour. + * Latest workflow UUID + * @description TODO */ - requirements: components["schemas"]["Requirement"][]; + latest_workflow_uuid?: string | null; /** - * Tags - * @description Topic topic tags + * License + * @description SPDX Identifier of the license associated with this workflow. */ - tags: string[]; - }; - /** TourDetails */ - TourDetails: { + license?: string | null; /** - * Description - * @description Tour description + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - description: string; + model_class: "StoredWorkflow"; /** * Name - * @description Name of tour + * @description The name of the history. */ name: string; /** - * Requirements - * @description Requirements to run the tour. + * Number of Steps + * @description The number of steps that make up this workflow. */ - requirements: components["schemas"]["Requirement"][]; + number_of_steps?: number | null; /** - * Steps - * @description Tour steps + * Owner + * @description The name of the user who owns this workflow. */ - steps: components["schemas"]["TourStep"][]; + owner: string; /** - * Tags - * @description Topic topic tags + * Published + * @description Whether this workflow is currently publicly available to all users. */ - tags: string[]; + published: boolean; /** - * Default title - * @description Default title for each step - */ - title_default?: string | null; - }; - /** - * TourList - * @default [] - */ - TourList: components["schemas"]["Tour"][]; - /** TourStep */ - TourStep: { - /** - * Content - * @description Text shown to the user - */ - content?: string | null; - /** - * Element - * @description CSS selector for the element to be described/clicked - */ - element?: string | null; - /** - * Placement - * @description Placement of the text box relative to the selected element - */ - placement?: string | null; - /** - * Post-click - * @description Elements that receive a click() event after the step is shown + * Show in Tool Panel + * @description Whether to display this workflow in the Tools Panel. */ - postclick?: boolean | string[] | null; + show_in_tool_panel?: boolean | null; /** - * Pre-click - * @description Elements that receive a click() event before the step is shown + * Slug + * @description The slug of the workflow. */ - preclick?: boolean | string[] | null; + slug: string | null; /** - * Text-insert - * @description Text to insert if element is a text box (e.g. tool search or upload) + * Source Metadata + * @description The source metadata of the workflow. */ - textinsert?: string | null; + source_metadata: Record | null; /** - * Title - * @description Title displayed in the header of the step container + * Steps + * @description A dictionary with information about all the steps of the workflow. + * @default {} */ - title?: string | null; - }; - /** UndeleteHistoriesPayload */ - UndeleteHistoriesPayload: { + steps: { + [key: string]: + | components["schemas"]["InputDataStep"] + | components["schemas"]["InputDataCollectionStep"] + | components["schemas"]["InputParameterStep"] + | components["schemas"]["PauseStep"] + | components["schemas"]["ToolStep"] + | components["schemas"]["SubworkflowStep"]; + }; + tags: components["schemas"]["TagCollection"]; /** - * IDs - * @description List of history IDs to be undeleted. + * Update Time + * Format: date-time + * @description The last time and date this item was updated. */ - ids: string[]; - }; - /** UpdateAnnotationAction */ - UpdateAnnotationAction: { + update_time: string; /** - * Action Type - * @constant - * @enum {string} + * URL + * @deprecated + * @description The relative URL to access this item. */ - action_type: "update_annotation"; - /** Annotation */ - annotation: string; - }; - /** - * UpdateCollectionAttributePayload - * @description Contains attributes that can be updated for all elements in a dataset collection. - */ - UpdateCollectionAttributePayload: { + url: string; /** - * Dbkey - * @description TODO + * Version + * @description The version of the workflow represented by an incremental number. */ - dbkey: string; + version: number; }; - /** - * UpdateContentItem - * @description Used for updating a particular history item. All fields are optional. - */ - UpdateContentItem: { + /** SubworkflowStep */ + SubworkflowStep: { /** - * Content Type - * @description The type of this item. + * Annotation + * @description An annotation to provide details or to help understand the purpose and usage of this item. */ - history_content_type: components["schemas"]["HistoryContentType"]; + annotation: string | null; /** - * Id - * @example 0123456789ABCDEF + * ID + * @description The identifier of the step. It matches the index order of the step inside the workflow. */ - id: string; - [key: string]: unknown; - }; - /** UpdateCreatorAction */ - UpdateCreatorAction: { + id: number; /** - * Action Type - * @constant - * @enum {string} + * Input Steps + * @description A dictionary containing information about the inputs connected to this workflow step. */ - action_type: "update_creator"; - /** Creator */ - creator?: unknown; - }; - /** UpdateDatasetPermissionsPayload */ - UpdateDatasetPermissionsPayload: { - /** Access Ids[] */ - "access_ids[]"?: string[] | string | null; + input_steps: { + [key: string]: components["schemas"]["InputStep"]; + }; /** - * Action - * @description Indicates what action should be performed on the dataset. - * @default set_permissions + * Tool ID + * @description The unique name of the tool associated with this step. */ - action?: components["schemas"]["DatasetPermissionAction"] | null; - /** Manage Ids[] */ - "manage_ids[]"?: string[] | string | null; - /** Modify Ids[] */ - "modify_ids[]"?: string[] | string | null; - }; - /** UpdateDatasetPermissionsPayloadAliasB */ - UpdateDatasetPermissionsPayloadAliasB: { + tool_id?: string | null; /** - * Access IDs - * @description A list of role encoded IDs defining roles that should have access permission on the dataset. + * Tool Inputs + * @description TODO */ - access?: string[] | string | null; + tool_inputs?: unknown; /** - * Action - * @description Indicates what action should be performed on the dataset. - * @default set_permissions + * Tool Version + * @description The version of the tool associated with this step. */ - action?: components["schemas"]["DatasetPermissionAction"] | null; + tool_version?: string | null; /** - * Manage IDs - * @description A list of role encoded IDs defining roles that should have manage permission on the dataset. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - manage?: string[] | string | null; + type: "subworkflow"; + /** When */ + when: string | null; /** - * Modify IDs - * @description A list of role encoded IDs defining roles that should have modify permission on the dataset. + * Workflow ID + * @description The encoded ID of the workflow that will be run on this step. + * @example 0123456789ABCDEF */ - modify?: string[] | string | null; + workflow_id: string; }; - /** UpdateDatasetPermissionsPayloadAliasC */ - UpdateDatasetPermissionsPayloadAliasC: { + /** SuitableConverter */ + SuitableConverter: { /** - * Access IDs - * @description A list of role encoded IDs defining roles that should have access permission on the dataset. + * Name + * @description The name of the converter. */ - access_ids?: string[] | string | null; + name: string; /** - * Action - * @description Indicates what action should be performed on the dataset. - * @default set_permissions + * Original Type + * @description The type to convert from. */ - action?: components["schemas"]["DatasetPermissionAction"] | null; + original_type: string; /** - * Manage IDs - * @description A list of role encoded IDs defining roles that should have manage permission on the dataset. + * Target Type + * @description The type to convert to. */ - manage_ids?: string[] | string | null; + target_type: string; /** - * Modify IDs - * @description A list of role encoded IDs defining roles that should have modify permission on the dataset. + * Tool Id + * @description The ID of the tool that can perform the type conversion. */ - modify_ids?: string[] | string | null; + tool_id: string; }; /** - * UpdateHistoryContentsBatchPayload - * @description Contains property values that will be updated for all the history `items` provided. - * @example { - * "items": [ - * { - * "history_content_type": "dataset", - * "id": "string" - * } - * ], - * "visible": false - * } + * SuitableConverters + * @description Collection of converters that can be used on a particular dataset collection. */ - UpdateHistoryContentsBatchPayload: { - /** - * Items - * @description A list of content items to update with the changes. - */ - items: components["schemas"]["UpdateContentItem"][]; - [key: string]: unknown; - }; + SuitableConverters: components["schemas"]["SuitableConverter"][]; /** - * UpdateHistoryContentsPayload - * @description Can contain arbitrary/dynamic fields that will be updated for a particular history item. - * @example { - * "annotation": "Test", - * "visible": false - * } + * SupportedType + * @enum {string} */ - UpdateHistoryContentsPayload: { - /** - * Annotation - * @description A user-defined annotation for this item. - */ - annotation?: string | null; - /** - * Deleted - * @description Whether this item is marked as deleted. - */ - deleted?: boolean | null; - /** - * Name - * @description The new name of the item. - */ - name?: string | null; - /** - * Tags - * @description A list of tags to add to this item. - */ - tags?: components["schemas"]["TagCollection"] | null; - /** - * Visible - * @description Whether this item is visible in the history. - */ - visible?: boolean | null; - [key: string]: unknown; + SupportedType: "None" | "BasicAuth" | "BearerAuth" | "PassportAuth"; + /** + * TagCollection + * @description Represents the collection of tags associated with an item. + */ + TagCollection: string[]; + /** TagOperationParams */ + TagOperationParams: { + /** Tags */ + tags: string[]; + /** Type */ + type: "add_tags" | "remove_tags"; }; - /** UpdateHistoryPayload */ - UpdateHistoryPayload: { - /** Annotation */ - annotation?: string | null; - /** Deleted */ - deleted?: boolean | null; - /** Genome Build */ - genome_build?: string | null; - /** Importable */ - importable?: boolean | null; - /** Name */ - name?: string | null; - /** Preferred Object Store Id */ - preferred_object_store_id?: string | null; - /** Published */ - published?: boolean | null; - /** Purged */ - purged?: boolean | null; - tags?: components["schemas"]["TagCollection"] | null; - }; - /** UpdateInstancePayload */ - UpdateInstancePayload: { - /** Active */ - active?: boolean | null; - /** Description */ - description?: string | null; - /** Hidden */ - hidden?: boolean | null; + /** + * TaggableItemClass + * @enum {string} + */ + TaggableItemClass: + | "History" + | "HistoryDatasetAssociation" + | "HistoryDatasetCollectionAssociation" + | "LibraryDatasetDatasetAssociation" + | "Page" + | "StoredWorkflow" + | "Visualization"; + /** + * TaskState + * @description Enum representing the possible states of a task. + * @enum {string} + */ + TaskState: "PENDING" | "STARTED" | "RETRY" | "FAILURE" | "SUCCESS"; + /** TemplateSecret */ + TemplateSecret: { + /** Help */ + help: string | null; + /** Label */ + label?: string | null; /** Name */ - name?: string | null; - /** Variables */ - variables?: { - [key: string]: string | boolean | number; - } | null; - }; - /** UpdateInstanceSecretPayload */ - UpdateInstanceSecretPayload: { - /** Secret Name */ - secret_name: string; - /** Secret Value */ - secret_value: string; + name: string; }; - /** UpdateLibraryFolderPayload */ - UpdateLibraryFolderPayload: { + /** TemplateVariableBoolean */ + TemplateVariableBoolean: { /** - * Description - * @description The new description of the library folder. + * Default + * @default false */ - description?: string | null; + default: boolean; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; /** - * Name - * @description The new name of the library folder. + * Type + * @constant + * @enum {string} */ - name?: string | null; + type: "boolean"; }; - /** UpdateLibraryPayload */ - UpdateLibraryPayload: { - /** - * Description - * @description A detailed description of the Library. Leave unset to keep the existing. - */ - description?: string | null; - /** - * Name - * @description The new name of the Library. Leave unset to keep the existing. - */ - name?: string | null; + /** TemplateVariableInteger */ + TemplateVariableInteger: { /** - * Synopsis - * @description A short text describing the contents of the Library. Leave unset to keep the existing. + * Default + * @default 0 */ - synopsis?: string | null; - }; - /** UpdateLicenseAction */ - UpdateLicenseAction: { + default: number; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; /** - * Action Type + * Type * @constant * @enum {string} */ - action_type: "update_license"; - /** License */ - license: string; + type: "integer"; }; - /** UpdateNameAction */ - UpdateNameAction: { + /** TemplateVariablePathComponent */ + TemplateVariablePathComponent: { + /** Default */ + default?: string | null; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; /** - * Action Type + * Type * @constant * @enum {string} */ - action_type: "update_name"; - /** Name */ - name: string; + type: "path_component"; }; - /** UpdateObjectStoreIdPayload */ - UpdateObjectStoreIdPayload: { + /** TemplateVariableString */ + TemplateVariableString: { /** - * Object Store Id - * @description Object store ID to update to, it must be an object store with the same device ID as the target dataset currently. + * Default + * @default */ - object_store_id: string; - }; - /** UpdateOutputLabelAction */ - UpdateOutputLabelAction: { + default: string; + /** Help */ + help: string | null; + /** Label */ + label?: string | null; + /** Name */ + name: string; /** - * Action Type + * Type * @constant * @enum {string} */ - action_type: "update_output_label"; - /** Output */ - output: - | components["schemas"]["OutputReferenceByOrderIndex"] - | components["schemas"]["OutputReferenceByLabel"]; - /** Output Label */ - output_label: string; + type: "string"; }; - /** UpdateQuotaParams */ - UpdateQuotaParams: { + /** TestUpdateInstancePayload */ + TestUpdateInstancePayload: { + /** Variables */ + variables?: { + [key: string]: string | boolean | number; + } | null; + }; + /** TestUpgradeInstancePayload */ + TestUpgradeInstancePayload: { + /** Secrets */ + secrets: { + [key: string]: string; + }; + /** Template Version */ + template_version: number; + /** Variables */ + variables: { + [key: string]: string | boolean | number; + }; + }; + /** ToolDataDetails */ + ToolDataDetails: { /** - * Amount - * @description Quota size (E.g. ``10000MB``, ``99 gb``, ``0.2T``, ``unlimited``) + * Columns + * @description A list of column names */ - amount?: string | null; + columns: string[]; /** - * Default - * @description Whether or not this is a default quota. Valid values are ``no``, ``unregistered``, ``registered``. Calling this method with ``default="no"`` on a non-default quota will throw an error. Not passing this parameter is equivalent to passing ``no``. + * Fields + * @default [] */ - default?: components["schemas"]["DefaultQuotaValues"] | null; + fields: string[][]; /** - * Description - * @description Detailed text description for this Quota. + * Model class + * @description The name of class modelling this tool data */ - description?: string | null; + model_class: string; /** - * Groups - * @description A list of group IDs or names to associate with this quota. + * Name + * @description The name of this tool data entry */ - in_groups?: string[] | null; + name: string; + }; + /** ToolDataEntry */ + ToolDataEntry: { /** - * Users - * @description A list of user IDs or user emails to associate with this quota. + * Model class + * @description The name of class modelling this tool data */ - in_users?: string[] | null; + model_class: string; /** * Name - * @description The new name of the quota. This must be unique within a Galaxy instance. + * @description The name of this tool data entry */ - name?: string | null; + name: string; + }; + /** ToolDataEntryList */ + ToolDataEntryList: components["schemas"]["ToolDataEntry"][]; + /** ToolDataField */ + ToolDataField: { /** - * Operation - * @description One of (``+``, ``-``, ``=``). If you wish to change this value, you must also provide the ``amount``, otherwise it will not take effect. - * @default = + * Base directories + * @description A list of directories where the data files are stored */ - operation?: components["schemas"]["QuotaOperation"]; - }; - /** UpdateReportAction */ - UpdateReportAction: { + base_dir: string[]; + /** Fields */ + fields: { + [key: string]: string; + }; /** - * Action Type - * @constant - * @enum {string} + * Files + * @description A dictionary of file names and their size in bytes */ - action_type: "update_report"; - report: components["schemas"]["Report"]; - }; - /** UpdateStepLabelAction */ - UpdateStepLabelAction: { + files: { + [key: string]: number; + }; /** - * Action Type - * @constant - * @enum {string} + * Fingerprint + * @description SHA1 Hash */ - action_type: "update_step_label"; + fingerprint: string; /** - * Label - * @description The unique label of the step being referenced. + * Model class + * @description The name of class modelling this tool data field */ - label: string; + model_class: string; /** - * Step - * @description The target step for this action. + * Name + * @description The name of the field */ - step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; + name: string; }; - /** UpdateStepPositionAction */ - UpdateStepPositionAction: { + /** ToolDataItem */ + ToolDataItem: { /** - * Action Type - * @constant - * @enum {string} + * Values + * @description A `\t` (TAB) separated list of column __contents__. You must specify a value for each of the columns of the data table. */ - action_type: "update_step_position"; - position_shift: components["schemas"]["Position"]; + values: string; + }; + /** ToolStep */ + ToolStep: { /** - * Step - * @description The target step for this action. + * Annotation + * @description An annotation to provide details or to help understand the purpose and usage of this item. */ - step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; - }; - /** - * UpdateUserNotificationPreferencesRequest - * @description Contains the new notification preferences of a user. - */ - UpdateUserNotificationPreferencesRequest: { + annotation: string | null; /** - * Preferences - * @description The new notification preferences of the user. + * ID + * @description The identifier of the step. It matches the index order of the step inside the workflow. */ - preferences: { - [key: string]: components["schemas"]["NotificationCategorySettings"]; - }; - }; - /** UpgradeAllStepsAction */ - UpgradeAllStepsAction: { + id: number; /** - * Action Type - * @constant - * @enum {string} + * Input Steps + * @description A dictionary containing information about the inputs connected to this workflow step. */ - action_type: "upgrade_all_steps"; - }; - /** UpgradeInstancePayload */ - UpgradeInstancePayload: { - /** Secrets */ - secrets: { - [key: string]: string; - }; - /** Template Version */ - template_version: number; - /** Variables */ - variables: { - [key: string]: string | boolean | number; + input_steps: { + [key: string]: components["schemas"]["InputStep"]; }; - }; - /** UpgradeSubworkflowAction */ - UpgradeSubworkflowAction: { /** - * Action Type - * @constant - * @enum {string} + * Tool ID + * @description The unique name of the tool associated with this step. */ - action_type: "upgrade_subworkflow"; - /** Content Id */ - content_id?: string | null; + tool_id?: string | null; /** - * Step - * @description The target step for this action. + * Tool Inputs + * @description TODO */ - step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; - }; - /** UpgradeToolAction */ - UpgradeToolAction: { + tool_inputs?: unknown; /** - * Action Type - * @constant - * @enum {string} + * Tool Version + * @description The version of the tool associated with this step. */ - action_type: "upgrade_tool"; + tool_version?: string | null; /** - * Step - * @description The target step for this action. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; - /** Tool Version */ - tool_version?: string | null; + type: "tool"; + /** When */ + when: string | null; }; - /** UrlDataElement */ - UrlDataElement: { - /** Md5 */ - MD5?: string | null; + /** Tour */ + Tour: { /** - * Auto Decompress - * @description Decompress compressed data before sniffing? - * @default false + * Description + * @description Tour description */ - auto_decompress?: boolean; - /** Collection Type */ - collection_type?: string | null; - /** Created From Basename */ - created_from_basename?: string | null; + description: string; /** - * Dbkey - * @default ? + * Identifier + * @description Tour identifier */ - dbkey?: string; + id: string; /** - * Deferred - * @default false + * Name + * @description Name of tour */ - deferred?: boolean; - /** Description */ - description?: string | null; - elements_from?: components["schemas"]["ElementsFromType"] | null; + name: string; /** - * Ext - * @default auto + * Requirements + * @description Requirements to run the tour. */ - ext?: string; - extra_files?: components["schemas"]["ExtraFiles"] | null; - /** Info */ - info?: string | null; - /** Name */ - name?: string | number | boolean | null; + requirements: components["schemas"]["Requirement"][]; /** - * Space To Tab - * @default false + * Tags + * @description Topic topic tags */ - space_to_tab?: boolean; + tags: string[]; + }; + /** TourDetails */ + TourDetails: { /** - * Src - * @constant - * @enum {string} + * Description + * @description Tour description */ - src: "url"; - /** Tags */ - tags?: string[] | null; + description: string; /** - * To Posix Lines - * @default false + * Name + * @description Name of tour */ - to_posix_lines?: boolean; + name: string; /** - * Url - * @description URL to upload + * Requirements + * @description Requirements to run the tour. */ - url: string; - }; - /** UserBeaconSetting */ - UserBeaconSetting: { + requirements: components["schemas"]["Requirement"][]; /** - * Enabled - * @description True if beacon sharing is enabled + * Steps + * @description Tour steps */ - enabled: boolean; - }; - /** UserConcreteObjectStoreModel */ - UserConcreteObjectStoreModel: { - /** Active */ - active: boolean; - /** Badges */ - badges: components["schemas"]["BadgeDict"][]; - /** Description */ - description?: string | null; - /** Device */ - device?: string | null; - /** Hidden */ - hidden: boolean; - /** Name */ - name?: string | null; - /** Object Store Id */ - object_store_id?: string | null; - /** Private */ - private: boolean; - /** Purged */ - purged: boolean; - quota: components["schemas"]["QuotaModel"]; - /** Secrets */ - secrets: string[]; - /** Template Id */ - template_id: string; - /** Template Version */ - template_version: number; + steps: components["schemas"]["TourStep"][]; /** - * Type - * @enum {string} + * Tags + * @description Topic topic tags */ - type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3"; - /** Uuid */ - uuid: string; - /** Variables */ - variables: { - [key: string]: string | boolean | number; - } | null; - }; - /** UserCreationPayload */ - UserCreationPayload: { + tags: string[]; /** - * Email - * @description Email of the user + * Default title + * @description Default title for each step */ - email: string; + title_default?: string | null; + }; + /** + * TourList + * @default [] + */ + TourList: components["schemas"]["Tour"][]; + /** TourStep */ + TourStep: { /** - * user_password - * @description The password of the user. + * Content + * @description Text shown to the user */ - password: string; + content?: string | null; /** - * user_name - * @description The name of the user. + * Element + * @description CSS selector for the element to be described/clicked */ - username: string; - }; - /** UserDeletionPayload */ - UserDeletionPayload: { + element?: string | null; /** - * Purge user - * @deprecated - * @description Purge the user. Deprecated, please use the `purge` query parameter instead. - * @default false + * Placement + * @description Placement of the text box relative to the selected element */ - purge?: boolean; - }; - /** UserEmail */ - UserEmail: { - /** - * Email - * @description The email of the user. - */ - email: string; - /** - * User ID - * @description The encoded ID of the user. - * @example 0123456789ABCDEF - */ - id: string; - }; - /** UserFileSourceModel */ - UserFileSourceModel: { - /** Active */ - active: boolean; - /** Description */ - description: string | null; - /** Hidden */ - hidden: boolean; - /** Name */ - name: string; - /** Purged */ - purged: boolean; - /** Secrets */ - secrets: string[]; - /** Template Id */ - template_id: string; - /** Template Version */ - template_version: number; + placement?: string | null; /** - * Type - * @enum {string} + * Post-click + * @description Elements that receive a click() event after the step is shown */ - type: "ftp" | "posix" | "s3fs" | "azure"; - /** Uri Root */ - uri_root: string; - /** Uuid */ - uuid: string; - /** Variables */ - variables: { - [key: string]: string | boolean | number; - } | null; - }; - /** - * UserModel - * @description User in a transaction context. - */ - UserModel: { + postclick?: boolean | string[] | null; /** - * Active - * @description User is active + * Pre-click + * @description Elements that receive a click() event before the step is shown */ - active: boolean; + preclick?: boolean | string[] | null; /** - * Deleted - * @description User is deleted + * Text-insert + * @description Text to insert if element is a text box (e.g. tool search or upload) */ - deleted: boolean; + textinsert?: string | null; /** - * Email - * @description Email of the user + * Title + * @description Title displayed in the header of the step container */ - email: string; + title?: string | null; + }; + /** UndeleteHistoriesPayload */ + UndeleteHistoriesPayload: { /** - * ID - * @description Encoded ID of the user - * @example 0123456789ABCDEF + * IDs + * @description List of history IDs to be undeleted. */ - id: string; - /** Last password change */ - last_password_change: string | null; + ids: string[]; + }; + /** UpdateAnnotationAction */ + UpdateAnnotationAction: { /** - * Model class - * @description The name of the database model class. - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ - model_class: "User"; - /** - * user_name - * @description The name of the user. - */ - username: string; + action_type: "update_annotation"; + /** Annotation */ + annotation: string; }; /** - * UserNotificationListResponse - * @description A list of user notifications. - */ - UserNotificationListResponse: components["schemas"]["UserNotificationResponse"][]; - /** - * UserNotificationPreferences - * @description Contains the full notification preferences of a user. + * UpdateCollectionAttributePayload + * @description Contains attributes that can be updated for all elements in a dataset collection. */ - UserNotificationPreferences: { + UpdateCollectionAttributePayload: { /** - * Preferences - * @description The notification preferences of the user. + * Dbkey + * @description TODO */ - preferences: { - [key: string]: components["schemas"]["NotificationCategorySettings"]; - }; + dbkey: string; }; /** - * UserNotificationResponse - * @description A notification response specific to the user. + * UpdateContentItem + * @description Used for updating a particular history item. All fields are optional. */ - UserNotificationResponse: { + UpdateContentItem: { /** - * Category - * @description The category of the notification. Represents the type of the notification. E.g. 'message' or 'new_shared_item'. + * Content Type + * @description The type of this item. */ - category: components["schemas"]["PersonalNotificationCategory"]; + history_content_type: components["schemas"]["HistoryContentType"]; /** - * Content - * @description The content of the notification. The structure depends on the category. + * Id + * @example 0123456789ABCDEF */ - content: - | components["schemas"]["MessageNotificationContent"] - | components["schemas"]["NewSharedItemNotificationContent"]; + id: string; + } & { + [key: string]: unknown; + }; + /** UpdateCreatorAction */ + UpdateCreatorAction: { /** - * Create time - * Format: date-time - * @description The time when the notification was created. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - create_time: string; + action_type: "update_creator"; + /** Creator */ + creator?: unknown; + }; + /** UpdateDatasetPermissionsPayload */ + UpdateDatasetPermissionsPayload: { + /** Access Ids[] */ + "access_ids[]"?: string[] | string | null; /** - * Deleted - * @description Whether the notification is marked as deleted by the user. Deleted notifications don't show up in the notification list. + * Action + * @description Indicates what action should be performed on the dataset. + * @default set_permissions */ - deleted: boolean; + action: components["schemas"]["DatasetPermissionAction"] | null; + /** Manage Ids[] */ + "manage_ids[]"?: string[] | string | null; + /** Modify Ids[] */ + "modify_ids[]"?: string[] | string | null; + }; + /** UpdateDatasetPermissionsPayloadAliasB */ + UpdateDatasetPermissionsPayloadAliasB: { /** - * Expiration time - * @description The time when the notification will expire. If not set, the notification will never expire. Expired notifications will be permanently deleted. + * Access IDs + * @description A list of role encoded IDs defining roles that should have access permission on the dataset. */ - expiration_time?: string | null; + access?: string[] | string | null; /** - * ID - * @description The encoded ID of the notification. - * @example 0123456789ABCDEF + * Action + * @description Indicates what action should be performed on the dataset. + * @default set_permissions */ - id: string; + action: components["schemas"]["DatasetPermissionAction"] | null; /** - * Publication time - * Format: date-time - * @description The time when the notification was published. Notifications can be created and then published at a later time. + * Manage IDs + * @description A list of role encoded IDs defining roles that should have manage permission on the dataset. */ - publication_time: string; + manage?: string[] | string | null; /** - * Seen time - * @description The time when the notification was seen by the user. If not set, the notification was not seen yet. + * Modify IDs + * @description A list of role encoded IDs defining roles that should have modify permission on the dataset. */ - seen_time?: string | null; + modify?: string[] | string | null; + }; + /** UpdateDatasetPermissionsPayloadAliasC */ + UpdateDatasetPermissionsPayloadAliasC: { /** - * Source - * @description The source of the notification. Represents the agent that created the notification. E.g. 'galaxy' or 'admin'. + * Access IDs + * @description A list of role encoded IDs defining roles that should have access permission on the dataset. */ - source: string; + access_ids?: string[] | string | null; /** - * Update time - * Format: date-time - * @description The time when the notification was last updated. + * Action + * @description Indicates what action should be performed on the dataset. + * @default set_permissions */ - update_time: string; + action: components["schemas"]["DatasetPermissionAction"] | null; /** - * Variant - * @description The variant of the notification. Represents the intent or relevance of the notification. E.g. 'info' or 'urgent'. + * Manage IDs + * @description A list of role encoded IDs defining roles that should have manage permission on the dataset. */ - variant: components["schemas"]["NotificationVariant"]; + manage_ids?: string[] | string | null; + /** + * Modify IDs + * @description A list of role encoded IDs defining roles that should have modify permission on the dataset. + */ + modify_ids?: string[] | string | null; }; /** - * UserNotificationUpdateRequest - * @description A notification update request specific to the user. + * UpdateHistoryContentsBatchPayload + * @description Contains property values that will be updated for all the history `items` provided. + * @example { + * "items": [ + * { + * "history_content_type": "dataset", + * "id": "string" + * } + * ], + * "visible": false + * } */ - UserNotificationUpdateRequest: { - /** - * Deleted - * @description Whether the notification should be marked as deleted by the user. If not set, the notification will not be changed. - */ - deleted?: boolean | null; + UpdateHistoryContentsBatchPayload: { /** - * Seen - * @description Whether the notification should be marked as seen by the user. If not set, the notification will not be changed. + * Items + * @description A list of content items to update with the changes. */ - seen?: boolean | null; + items: components["schemas"]["UpdateContentItem"][]; + } & { + [key: string]: unknown; }; /** - * UserNotificationsBatchUpdateRequest - * @description A batch update request specific for user notifications. + * UpdateHistoryContentsPayload + * @description Can contain arbitrary/dynamic fields that will be updated for a particular history item. + * @example { + * "annotation": "Test", + * "visible": false + * } */ - UserNotificationsBatchUpdateRequest: { + UpdateHistoryContentsPayload: { /** - * Changes - * @description The changes that should be applied to the notifications. Only the fields that are set will be changed. + * Annotation + * @description A user-defined annotation for this item. */ - changes: components["schemas"]["UserNotificationUpdateRequest"]; + annotation?: string | null; /** - * Notification IDs - * @description The list of encoded notification IDs of the notifications that should be updated. + * Deleted + * @description Whether this item is marked as deleted. */ - notification_ids: string[]; - }; - /** UserObjectstoreUsage */ - UserObjectstoreUsage: { - /** Object Store Id */ - object_store_id: string; - /** Total Disk Usage */ - total_disk_usage: number; - }; - /** UserQuota */ - UserQuota: { + deleted?: boolean | null; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Name + * @description The new name of the item. */ - model_class: "UserQuotaAssociation"; + name?: string | null; /** - * User - * @description Information about a user associated with a quota. + * Tags + * @description A list of tags to add to this item. */ - user: components["schemas"]["UserModel"]; - }; - /** UserQuotaUsage */ - UserQuotaUsage: { - /** Quota */ - quota?: string | null; - /** Quota Bytes */ - quota_bytes?: number | null; - /** Quota Percent */ - quota_percent?: number | null; - /** Quota Source Label */ - quota_source_label?: string | null; - /** Total Disk Usage */ - total_disk_usage: number; - }; - /** UserUpdatePayload */ - UserUpdatePayload: { + tags?: components["schemas"]["TagCollection"] | null; /** - * Active - * @description User is active + * Visible + * @description Whether this item is visible in the history. */ + visible?: boolean | null; + } & { + [key: string]: unknown; + }; + /** UpdateHistoryPayload */ + UpdateHistoryPayload: { + /** Annotation */ + annotation?: string | null; + /** Deleted */ + deleted?: boolean | null; + /** Genome Build */ + genome_build?: string | null; + /** Importable */ + importable?: boolean | null; + /** Name */ + name?: string | null; + /** Preferred Object Store Id */ + preferred_object_store_id?: string | null; + /** Published */ + published?: boolean | null; + /** Purged */ + purged?: boolean | null; + tags?: components["schemas"]["TagCollection"] | null; + }; + /** UpdateInstancePayload */ + UpdateInstancePayload: { + /** Active */ active?: boolean | null; + /** Description */ + description?: string | null; + /** Hidden */ + hidden?: boolean | null; + /** Name */ + name?: string | null; + /** Variables */ + variables?: { + [key: string]: string | boolean | number; + } | null; + }; + /** UpdateInstanceSecretPayload */ + UpdateInstanceSecretPayload: { + /** Secret Name */ + secret_name: string; + /** Secret Value */ + secret_value: string; + }; + /** UpdateLibraryFolderPayload */ + UpdateLibraryFolderPayload: { /** - * Preferred Object Store ID - * @description The ID of the object store that should be used to store new datasets in this history. + * Description + * @description The new description of the library folder. */ - preferred_object_store_id?: string | null; + description?: string | null; /** - * Username - * @description The name of the user. + * Name + * @description The new name of the library folder. */ - username?: string | null; + name?: string | null; }; - /** Visualization */ - Visualization: Record; - /** VisualizationSummary */ - VisualizationSummary: { + /** UpdateLibraryPayload */ + UpdateLibraryPayload: { /** - * Annotation - * @description The annotation of this Visualization. + * Description + * @description A detailed description of the Library. Leave unset to keep the existing. */ - annotation?: string | null; + description?: string | null; /** - * Create Time - * @description The time and date this item was created. + * Name + * @description The new name of the Library. Leave unset to keep the existing. */ - create_time: string | null; + name?: string | null; /** - * DbKey - * @description The database key of the visualization. + * Synopsis + * @description A short text describing the contents of the Library. Leave unset to keep the existing. */ - dbkey?: string | null; + synopsis?: string | null; + }; + /** UpdateLicenseAction */ + UpdateLicenseAction: { /** - * Deleted - * @description Whether this Visualization has been deleted. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - deleted: boolean; + action_type: "update_license"; + /** License */ + license: string; + }; + /** UpdateNameAction */ + UpdateNameAction: { /** - * ID - * @description Encoded ID of the Visualization. - * @example 0123456789ABCDEF + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - id: string; + action_type: "update_name"; + /** Name */ + name: string; + }; + /** UpdateObjectStoreIdPayload */ + UpdateObjectStoreIdPayload: { /** - * Importable - * @description Whether this Visualization can be imported. + * Object Store Id + * @description Object store ID to update to, it must be an object store with the same device ID as the target dataset currently. */ - importable: boolean; + object_store_id: string; + }; + /** UpdateOutputLabelAction */ + UpdateOutputLabelAction: { /** - * Published - * @description Whether this Visualization has been published. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - published: boolean; + action_type: "update_output_label"; + /** Output */ + output: + | components["schemas"]["OutputReferenceByOrderIndex"] + | components["schemas"]["OutputReferenceByLabel"]; + /** Output Label */ + output_label: string; + }; + /** UpdateQuotaParams */ + UpdateQuotaParams: { /** - * Tags - * @description A list of tags to add to this item. + * Amount + * @description Quota size (E.g. ``10000MB``, ``99 gb``, ``0.2T``, ``unlimited``) */ - tags: components["schemas"]["TagCollection"] | null; + amount?: string | null; /** - * Title - * @description The name of the visualization. + * Default + * @description Whether or not this is a default quota. Valid values are ``no``, ``unregistered``, ``registered``. Calling this method with ``default="no"`` on a non-default quota will throw an error. Not passing this parameter is equivalent to passing ``no``. */ - title: string; + default?: components["schemas"]["DefaultQuotaValues"] | null; /** - * Type - * @description The type of the visualization. + * Description + * @description Detailed text description for this Quota. */ - type: string; + description?: string | null; /** - * Update Time - * @description The last time and date this item was updated. + * Groups + * @description A list of group IDs or names to associate with this quota. */ - update_time: string | null; + in_groups?: string[] | null; /** - * Username - * @description The name of the user owning this Visualization. + * Users + * @description A list of user IDs or user emails to associate with this quota. */ - username: string; - [key: string]: unknown; - }; - /** - * VisualizationSummaryList - * @default [] - */ - VisualizationSummaryList: components["schemas"]["VisualizationSummary"][]; - /** WorkflowInput */ - WorkflowInput: { + in_users?: string[] | null; /** - * Label - * @description Label of the input. + * Name + * @description The new name of the quota. This must be unique within a Galaxy instance. */ - label: string | null; + name?: string | null; /** - * UUID - * @description Universal unique identifier of the input. + * Operation + * @description One of (``+``, ``-``, ``=``). If you wish to change this value, you must also provide the ``amount``, otherwise it will not take effect. + * @default = */ - uuid: string | null; + operation: components["schemas"]["QuotaOperation"]; + }; + /** UpdateReportAction */ + UpdateReportAction: { /** - * Value - * @description TODO + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - value: unknown; + action_type: "update_report"; + report: components["schemas"]["Report"]; }; - /** WorkflowInvocationCollectionView */ - WorkflowInvocationCollectionView: { + /** UpdateStepLabelAction */ + UpdateStepLabelAction: { /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - create_time: string; + action_type: "update_step_label"; /** - * History ID - * @description The encoded ID of the history associated with the invocation. - * @example 0123456789ABCDEF + * Label + * @description The unique label of the step being referenced. */ - history_id: string; + label: string; /** - * ID - * @description The encoded ID of the workflow invocation. - * @example 0123456789ABCDEF + * Step + * @description The target step for this action. */ - id: string; + step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; + }; + /** UpdateStepPositionAction */ + UpdateStepPositionAction: { /** - * Model class - * @description The name of the database model class. - * @constant + * @description discriminator enum property added by openapi-typescript * @enum {string} */ - model_class: "WorkflowInvocation"; - /** - * Invocation state - * @description State of workflow invocation. - */ - state: components["schemas"]["InvocationState"]; + action_type: "update_step_position"; + position_shift: components["schemas"]["Position"]; /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. + * Step + * @description The target step for this action. */ - update_time: string; + step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; + }; + /** + * UpdateUserNotificationPreferencesRequest + * @description Contains the new notification preferences of a user. + */ + UpdateUserNotificationPreferencesRequest: { /** - * UUID - * @description Universal unique identifier of the workflow invocation. + * Preferences + * @description The new notification preferences of the user. */ - uuid?: string | null; + preferences: { + [key: string]: components["schemas"]["NotificationCategorySettings"]; + }; + }; + /** UpgradeAllStepsAction */ + UpgradeAllStepsAction: { /** - * Workflow ID - * @description The encoded Workflow ID associated with the invocation. - * @example 0123456789ABCDEF + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - workflow_id: string; + action_type: "upgrade_all_steps"; }; - /** WorkflowInvocationElementView */ - WorkflowInvocationElementView: { + /** UpgradeInstancePayload */ + UpgradeInstancePayload: { + /** Secrets */ + secrets: { + [key: string]: string; + }; + /** Template Version */ + template_version: number; + /** Variables */ + variables: { + [key: string]: string | boolean | number; + }; + }; + /** UpgradeSubworkflowAction */ + UpgradeSubworkflowAction: { /** - * Create Time - * Format: date-time - * @description The time and date this item was created. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - create_time: string; + action_type: "upgrade_subworkflow"; + /** Content Id */ + content_id?: string | null; /** - * History ID - * @description The encoded ID of the history associated with the invocation. - * @example 0123456789ABCDEF + * Step + * @description The target step for this action. */ - history_id: string; + step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; + }; + /** UpgradeToolAction */ + UpgradeToolAction: { /** - * ID - * @description The encoded ID of the workflow invocation. - * @example 0123456789ABCDEF + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - id: string; + action_type: "upgrade_tool"; /** - * Input step parameters - * @description Input step parameters of the workflow invocation. + * Step + * @description The target step for this action. */ - input_step_parameters: { - [key: string]: components["schemas"]["InvocationInputParameter"]; - }; + step: components["schemas"]["StepReferenceByOrderIndex"] | components["schemas"]["StepReferenceByLabel"]; + /** Tool Version */ + tool_version?: string | null; + }; + /** + * UploadOption + * @enum {string} + */ + UploadOption: "upload_file" | "upload_paths" | "upload_directory"; + /** UrlDataElement */ + UrlDataElement: { + /** Md5 */ + MD5?: string | null; + /** Sha-1 */ + "SHA-1"?: string | null; + /** Sha-256 */ + "SHA-256"?: string | null; + /** Sha-512 */ + "SHA-512"?: string | null; /** - * Inputs - * @description Input datasets/dataset collections of the workflow invocation. + * Auto Decompress + * @description Decompress compressed data before sniffing? + * @default false */ - inputs: { - [key: string]: components["schemas"]["InvocationInput"]; - }; + auto_decompress: boolean; + /** Collection Type */ + collection_type?: string | null; + /** Created From Basename */ + created_from_basename?: string | null; /** - * Messages - * @description A list of messages about why the invocation did not succeed. + * Dbkey + * @default ? */ - messages: ( - | components["schemas"]["InvocationCancellationReviewFailedResponse"] - | components["schemas"]["InvocationCancellationHistoryDeletedResponse"] - | components["schemas"]["InvocationCancellationUserRequestResponse"] - | components["schemas"]["InvocationFailureDatasetFailedResponse"] - | components["schemas"]["InvocationFailureCollectionFailedResponse"] - | components["schemas"]["InvocationFailureJobFailedResponse"] - | components["schemas"]["InvocationFailureOutputNotFoundResponse"] - | components["schemas"]["InvocationFailureExpressionEvaluationFailedResponse"] - | components["schemas"]["InvocationFailureWhenNotBooleanResponse"] - | components["schemas"]["InvocationUnexpectedFailureResponse"] - | components["schemas"]["InvocationEvaluationWarningWorkflowOutputNotFoundResponse"] - )[]; + dbkey: string; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * Deferred + * @default false */ - model_class: "WorkflowInvocation"; + deferred: boolean; + /** Description */ + description?: string | null; + elements_from?: components["schemas"]["ElementsFromType"] | null; /** - * Output collections - * @description Output dataset collections of the workflow invocation. + * Ext + * @default auto */ - output_collections: { - [key: string]: components["schemas"]["InvocationOutputCollection"]; - }; + ext: string; + extra_files?: components["schemas"]["ExtraFiles"] | null; + /** Hashes */ + hashes?: components["schemas"]["FetchDatasetHash"][] | null; + /** Info */ + info?: string | null; + /** Name */ + name?: string | number | boolean | null; /** - * Output values - * @description Output values of the workflow invocation. + * Space To Tab + * @default false */ - output_values: Record; + space_to_tab: boolean; /** - * Outputs - * @description Output datasets of the workflow invocation. + * @description discriminator enum property added by openapi-typescript + * @enum {string} */ - outputs: { - [key: string]: components["schemas"]["InvocationOutput"]; - }; + src: "url"; + /** Tags */ + tags?: string[] | null; /** - * Invocation state - * @description State of workflow invocation. + * To Posix Lines + * @default false */ - state: components["schemas"]["InvocationState"]; + to_posix_lines: boolean; /** - * Steps - * @description Steps of the workflow invocation. + * Url + * @description URL to upload */ - steps: components["schemas"]["InvocationStep"][]; + url: string; + }; + /** UserBeaconSetting */ + UserBeaconSetting: { /** - * Update Time - * Format: date-time - * @description The last time and date this item was updated. + * Enabled + * @description True if beacon sharing is enabled */ - update_time: string; + enabled: boolean; + }; + /** UserConcreteObjectStoreModel */ + UserConcreteObjectStoreModel: { + /** Active */ + active: boolean; + /** Badges */ + badges: components["schemas"]["BadgeDict"][]; + /** Description */ + description?: string | null; + /** Device */ + device?: string | null; + /** Hidden */ + hidden: boolean; + /** Name */ + name?: string | null; + /** Object Store Id */ + object_store_id?: string | null; + /** Private */ + private: boolean; + /** Purged */ + purged: boolean; + quota: components["schemas"]["QuotaModel"]; + /** Secrets */ + secrets: string[]; + /** Template Id */ + template_id: string; + /** Template Version */ + template_version: number; /** - * UUID - * @description Universal unique identifier of the workflow invocation. + * Type + * @enum {string} */ - uuid?: string | null; + type: "aws_s3" | "azure_blob" | "boto3" | "disk" | "generic_s3" | "onedata"; /** - * Workflow ID - * @description The encoded Workflow ID associated with the invocation. - * @example 0123456789ABCDEF + * Uuid + * Format: uuid4 */ - workflow_id: string; + uuid: string; + /** Variables */ + variables: { + [key: string]: string | boolean | number; + } | null; }; - /** WorkflowInvocationResponse */ - WorkflowInvocationResponse: - | components["schemas"]["WorkflowInvocationElementView"] - | components["schemas"]["WorkflowInvocationCollectionView"]; - /** WorkflowInvocationStateSummary */ - WorkflowInvocationStateSummary: { + /** UserCreationPayload */ + UserCreationPayload: { /** - * Id - * @example 0123456789ABCDEF + * Email + * @description Email of the user */ - id: string; + email: string; /** - * Model class - * @description The name of the database model class. - * @constant - * @enum {string} + * user_password + * @description The password of the user. */ - model: "WorkflowInvocation"; + password: string; /** - * Populated State - * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. + * user_name + * @description The name of the user. */ - populated_state: components["schemas"]["DatasetCollectionPopulatedState"]; - /** - * States - * @description A dictionary of job states and the number of jobs in that state. - * @default {} - */ - states?: { - [key: string]: number; - }; + username: string; }; - /** WriteInvocationStoreToPayload */ - WriteInvocationStoreToPayload: { + /** UserDeletionPayload */ + UserDeletionPayload: { /** - * Bco Merge History Metadata - * @description When reading tags/annotations to generate BCO object include history metadata. + * Purge user + * @deprecated + * @description Purge the user. Deprecated, please use the `purge` query parameter instead. * @default false */ - bco_merge_history_metadata?: boolean; + purge: boolean; + }; + /** UserEmail */ + UserEmail: { /** - * Bco Override Algorithmic Error - * @description Override algorithmic error for 'error domain' when generating BioCompute object. + * Email + * @description The email of the user. */ - bco_override_algorithmic_error?: { - [key: string]: string; - } | null; + email: string; /** - * Bco Override Empirical Error - * @description Override empirical error for 'error domain' when generating BioCompute object. + * User ID + * @description The encoded ID of the user. + * @example 0123456789ABCDEF */ - bco_override_empirical_error?: { - [key: string]: string; - } | null; + id: string; + }; + /** UserFileSourceModel */ + UserFileSourceModel: { + /** Active */ + active: boolean; + /** Description */ + description: string | null; + /** Hidden */ + hidden: boolean; + /** Name */ + name: string; + /** Purged */ + purged: boolean; + /** Secrets */ + secrets: string[]; + /** Template Id */ + template_id: string; + /** Template Version */ + template_version: number; /** - * Bco Override Environment Variables - * @description Override environment variables for 'execution_domain' when generating BioCompute object. + * Type + * @enum {string} */ - bco_override_environment_variables?: { - [key: string]: string; + type: "ftp" | "posix" | "s3fs" | "azure" | "onedata" | "webdav" | "dropbox" | "googledrive"; + /** Uri Root */ + uri_root: string; + /** + * Uuid + * Format: uuid4 + */ + uuid: string; + /** Variables */ + variables: { + [key: string]: string | boolean | number; } | null; + }; + /** + * UserModel + * @description User in a transaction context. + */ + UserModel: { /** - * Bco Override Xref - * @description Override xref for 'description domain' when generating BioCompute object. + * Active + * @description User is active */ - bco_override_xref?: components["schemas"]["XrefItem"][] | null; + active: boolean; /** - * Include deleted - * @description Include file contents for deleted datasets (if include_files is True). - * @default false + * Deleted + * @description User is deleted */ - include_deleted?: boolean; + deleted: boolean; /** - * Include Files - * @description include materialized files in export when available - * @default true + * Email + * @description Email of the user */ - include_files?: boolean; + email: string; /** - * Include hidden - * @description Include file contents for hidden datasets (if include_files is True). - * @default false + * ID + * @description Encoded ID of the user + * @example 0123456789ABCDEF */ - include_hidden?: boolean; + id: string; + /** Last password change */ + last_password_change: string | null; /** - * @description format of model store to export - * @default tar.gz + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} */ - model_store_format?: components["schemas"]["ModelStoreFormat"]; + model_class: "User"; /** - * Target URI - * @description Galaxy Files URI to write mode store content to. + * user_name + * @description The name of the user. */ - target_uri: string; + username: string; }; - /** WriteStoreToPayload */ - WriteStoreToPayload: { + /** + * UserNotificationListResponse + * @description A list of user notifications. + */ + UserNotificationListResponse: components["schemas"]["UserNotificationResponse"][]; + /** + * UserNotificationPreferences + * @description Contains the full notification preferences of a user. + */ + UserNotificationPreferences: { /** - * Include deleted - * @description Include file contents for deleted datasets (if include_files is True). - * @default false + * Preferences + * @description The notification preferences of the user. */ - include_deleted?: boolean; + preferences: { + [key: string]: components["schemas"]["NotificationCategorySettings"]; + }; + }; + /** + * UserNotificationResponse + * @description A notification response specific to the user. + */ + UserNotificationResponse: { /** - * Include Files - * @description include materialized files in export when available - * @default true + * Category + * @description The category of the notification. Represents the type of the notification. E.g. 'message' or 'new_shared_item'. */ - include_files?: boolean; + category: components["schemas"]["PersonalNotificationCategory"]; /** - * Include hidden - * @description Include file contents for hidden datasets (if include_files is True). - * @default false + * Content + * @description The content of the notification. The structure depends on the category. */ - include_hidden?: boolean; + content: + | components["schemas"]["MessageNotificationContent"] + | components["schemas"]["NewSharedItemNotificationContent"]; /** - * @description format of model store to export - * @default tar.gz + * Create time + * Format: date-time + * @description The time when the notification was created. */ - model_store_format?: components["schemas"]["ModelStoreFormat"]; + create_time: string; /** - * Target URI - * @description Galaxy Files URI to write mode store content to. + * Deleted + * @description Whether the notification is marked as deleted by the user. Deleted notifications don't show up in the notification list. */ - target_uri: string; + deleted: boolean; + /** + * Expiration time + * @description The time when the notification will expire. If not set, the notification will never expire. Expired notifications will be permanently deleted. + */ + expiration_time?: string | null; + /** + * ID + * @description The encoded ID of the notification. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Publication time + * Format: date-time + * @description The time when the notification was published. Notifications can be created and then published at a later time. + */ + publication_time: string; + /** + * Seen time + * @description The time when the notification was seen by the user. If not set, the notification was not seen yet. + */ + seen_time?: string | null; + /** + * Source + * @description The source of the notification. Represents the agent that created the notification. E.g. 'galaxy' or 'admin'. + */ + source: string; + /** + * Update time + * Format: date-time + * @description The time when the notification was last updated. + */ + update_time: string; + /** + * Variant + * @description The variant of the notification. Represents the intent or relevance of the notification. E.g. 'info' or 'urgent'. + */ + variant: components["schemas"]["NotificationVariant"]; + }; + /** + * UserNotificationUpdateRequest + * @description A notification update request specific to the user. + */ + UserNotificationUpdateRequest: { + /** + * Deleted + * @description Whether the notification should be marked as deleted by the user. If not set, the notification will not be changed. + */ + deleted?: boolean | null; + /** + * Seen + * @description Whether the notification should be marked as seen by the user. If not set, the notification will not be changed. + */ + seen?: boolean | null; + }; + /** + * UserNotificationsBatchUpdateRequest + * @description A batch update request specific for user notifications. + */ + UserNotificationsBatchUpdateRequest: { + /** + * Changes + * @description The changes that should be applied to the notifications. Only the fields that are set will be changed. + */ + changes: components["schemas"]["UserNotificationUpdateRequest"]; + /** + * Notification IDs + * @description The list of encoded notification IDs of the notifications that should be updated. + */ + notification_ids: string[]; + }; + /** UserObjectstoreUsage */ + UserObjectstoreUsage: { + /** Object Store Id */ + object_store_id: string; + /** Total Disk Usage */ + total_disk_usage: number; + }; + /** UserQuota */ + UserQuota: { + /** + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} + */ + model_class: "UserQuotaAssociation"; + /** + * User + * @description Information about a user associated with a quota. + */ + user: components["schemas"]["UserModel"]; + }; + /** UserQuotaUsage */ + UserQuotaUsage: { + /** Quota */ + quota?: string | null; + /** Quota Bytes */ + quota_bytes?: number | null; + /** Quota Percent */ + quota_percent?: number | null; + /** Quota Source Label */ + quota_source_label?: string | null; + /** Total Disk Usage */ + total_disk_usage: number; + }; + /** UserUpdatePayload */ + UserUpdatePayload: { + /** + * Active + * @description User is active + */ + active?: boolean | null; + /** + * Preferred Object Store ID + * @description The ID of the object store that should be used to store new datasets in this history. + */ + preferred_object_store_id?: string | null; + /** + * Username + * @description The name of the user. + */ + username?: string | null; + }; + /** Visualization */ + Visualization: Record; + /** VisualizationCreatePayload */ + VisualizationCreatePayload: { + /** + * Annotation + * @description The annotation of the visualization. + */ + annotation?: string | null; + /** + * Config + * @description The config of the visualization. + * @default {} + */ + config: Record | null; + /** + * DbKey + * @description The database key of the visualization. + */ + dbkey?: string | null; + /** + * Slug + * @description The slug of the visualization. + */ + slug?: string | null; + /** + * Title + * @description The name of the visualization. + * @default Untitled Visualization + */ + title: string | null; + /** + * Type + * @description The type of the visualization. + */ + type: string; + }; + /** VisualizationCreateResponse */ + VisualizationCreateResponse: { + /** + * ID + * @description Encoded ID of the Visualization. + * @example 0123456789ABCDEF + */ + id: string; + }; + /** VisualizationPluginResponse */ + VisualizationPluginResponse: { + /** + * Description + * @description The description of the plugin. + */ + description: string; + /** + * Embeddable + * @description Whether the plugin is embeddable. + */ + embeddable: boolean; + /** + * Entry Point + * @description The entry point of the plugin. + */ + entry_point: Record; + /** + * Groups + * @description The groups of the plugin. + */ + groups?: Record[] | null; + /** + * Href + * @description The href of the plugin. + */ + href: string; + /** + * HTML + * @description The HTML of the plugin. + */ + html: string; + /** + * Logo + * @description The logo of the plugin. + */ + logo?: string | null; + /** + * Name + * @description The name of the plugin. + */ + name: string; + /** + * Settings + * @description The settings of the plugin. + */ + settings: Record[]; + /** + * Specs + * @description The specs of the plugin. + */ + specs?: Record | null; + /** + * Target + * @description The target of the plugin. + */ + target: string; + /** + * Title + * @description The title of the plugin. + */ + title?: string | null; + }; + /** VisualizationRevisionResponse */ + VisualizationRevisionResponse: { + /** + * Config + * @description The config of the visualization revision. + */ + config: Record; + /** + * DbKey + * @description The database key of the visualization. + */ + dbkey?: string | null; + /** + * ID + * @description Encoded ID of the Visualization Revision. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} + */ + model_class: "VisualizationRevision"; + /** + * Title + * @description The name of the visualization revision. + */ + title: string; + /** + * Visualization ID + * @description Encoded ID of the Visualization. + * @example 0123456789ABCDEF + */ + visualization_id: string; + }; + /** VisualizationShowResponse */ + VisualizationShowResponse: { + /** + * Annotation + * @description The annotation of this Visualization. + */ + annotation?: string | null; + /** + * DbKey + * @description The database key of the visualization. + */ + dbkey?: string | null; + /** + * Email Hash + * @description The hash of the email of the user owning this Visualization. + */ + email_hash: string; + /** + * ID + * @description Encoded ID of the Visualization. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Latest Revision + * @description The latest revision of this Visualization. + */ + latest_revision: components["schemas"]["VisualizationRevisionResponse"]; + /** + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} + */ + model_class: "Visualization"; + /** + * Plugin + * @description The plugin of this Visualization. + */ + plugin?: components["schemas"]["VisualizationPluginResponse"] | null; + /** + * Revisions + * @description A list of encoded IDs of the revisions of this Visualization. + */ + revisions: string[]; + /** + * Slug + * @description The slug of the visualization. + */ + slug?: string | null; + /** + * Tags + * @description A list of tags to add to this item. + */ + tags?: components["schemas"]["TagCollection"] | null; + /** + * Title + * @description The name of the visualization. + */ + title: string; + /** + * Type + * @description The type of the visualization. + */ + type: string; + /** + * URL + * @description The URL of the visualization. + */ + url: string; + /** + * User ID + * @description The ID of the user owning this Visualization. + * @example 0123456789ABCDEF + */ + user_id: string; + /** + * Username + * @description The name of the user owning this Visualization. + */ + username: string; + }; + /** VisualizationSummary */ + VisualizationSummary: { + /** + * Annotation + * @description The annotation of this Visualization. + */ + annotation?: string | null; + /** + * Create Time + * @description The time and date this item was created. + */ + create_time: string | null; + /** + * DbKey + * @description The database key of the visualization. + */ + dbkey?: string | null; + /** + * Deleted + * @description Whether this Visualization has been deleted. + */ + deleted: boolean; + /** + * ID + * @description Encoded ID of the Visualization. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Importable + * @description Whether this Visualization can be imported. + */ + importable: boolean; + /** + * Published + * @description Whether this Visualization has been published. + */ + published: boolean; + /** + * Tags + * @description A list of tags to add to this item. + */ + tags: components["schemas"]["TagCollection"] | null; + /** + * Title + * @description The name of the visualization. + */ + title: string; + /** + * Type + * @description The type of the visualization. + */ + type: string; + /** + * Update Time + * @description The last time and date this item was updated. + */ + update_time: string | null; + /** + * Username + * @description The name of the user owning this Visualization. + */ + username: string; + } & { + [key: string]: unknown; + }; + /** + * VisualizationSummaryList + * @default [] + */ + VisualizationSummaryList: components["schemas"]["VisualizationSummary"][]; + /** VisualizationUpdatePayload */ + VisualizationUpdatePayload: { + /** + * Config + * @description The config of the visualization. + * @default {} + */ + config: Record | string | null; + /** + * DbKey + * @description The database key of the visualization. + */ + dbkey?: string | null; + /** + * Deleted + * @description Whether this Visualization has been deleted. + * @default false + */ + deleted: boolean | null; + /** + * Title + * @description The name of the visualization. + */ + title?: string | null; + }; + /** VisualizationUpdateResponse */ + VisualizationUpdateResponse: { + /** + * ID + * @description Encoded ID of the Visualization. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Revision + * @description Encoded ID of the Visualization Revision. + * @example 0123456789ABCDEF + */ + revision: string; + }; + /** WorkflowInput */ + WorkflowInput: { + /** + * Label + * @description Label of the input. + */ + label: string | null; + /** + * UUID + * @description Universal unique identifier of the input. + */ + uuid: string | null; + /** + * Value + * @description TODO + */ + value: unknown | null; + }; + /** WorkflowInvocationCollectionView */ + WorkflowInvocationCollectionView: { + /** + * Create Time + * Format: date-time + * @description The time and date this item was created. + */ + create_time: string; + /** + * History ID + * @description The encoded ID of the history associated with the invocation. + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * ID + * @description The encoded ID of the workflow invocation. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} + */ + model_class: "WorkflowInvocation"; + /** + * Invocation state + * @description State of workflow invocation. + */ + state: components["schemas"]["InvocationState"]; + /** + * Update Time + * Format: date-time + * @description The last time and date this item was updated. + */ + update_time: string; + /** + * UUID + * @description Universal unique identifier of the workflow invocation. + */ + uuid?: string | null; + /** + * Workflow ID + * @description The encoded Workflow ID associated with the invocation. + * @example 0123456789ABCDEF + */ + workflow_id: string; + }; + /** WorkflowInvocationElementView */ + WorkflowInvocationElementView: { + /** + * Create Time + * Format: date-time + * @description The time and date this item was created. + */ + create_time: string; + /** + * History ID + * @description The encoded ID of the history associated with the invocation. + * @example 0123456789ABCDEF + */ + history_id: string; + /** + * ID + * @description The encoded ID of the workflow invocation. + * @example 0123456789ABCDEF + */ + id: string; + /** + * Input step parameters + * @description Input step parameters of the workflow invocation. + */ + input_step_parameters: { + [key: string]: components["schemas"]["InvocationInputParameter"]; + }; + /** + * Inputs + * @description Input datasets/dataset collections of the workflow invocation. + */ + inputs: { + [key: string]: components["schemas"]["InvocationInput"]; + }; + /** + * Messages + * @description A list of messages about why the invocation did not succeed. + */ + messages: components["schemas"]["InvocationMessageResponseUnion"][]; + /** + * Model class + * @description The name of the database model class. + * @constant + * @enum {string} + */ + model_class: "WorkflowInvocation"; + /** + * Output collections + * @description Output dataset collections of the workflow invocation. + */ + output_collections: { + [key: string]: components["schemas"]["InvocationOutputCollection"]; + }; + /** + * Output values + * @description Output values of the workflow invocation. + */ + output_values: Record; + /** + * Outputs + * @description Output datasets of the workflow invocation. + */ + outputs: { + [key: string]: components["schemas"]["InvocationOutput"]; + }; + /** + * Invocation state + * @description State of workflow invocation. + */ + state: components["schemas"]["InvocationState"]; + /** + * Steps + * @description Steps of the workflow invocation. + */ + steps: components["schemas"]["InvocationStep"][]; + /** + * Update Time + * Format: date-time + * @description The last time and date this item was updated. + */ + update_time: string; + /** + * UUID + * @description Universal unique identifier of the workflow invocation. + */ + uuid?: string | null; + /** + * Workflow ID + * @description The encoded Workflow ID associated with the invocation. + * @example 0123456789ABCDEF + */ + workflow_id: string; + }; + /** + * WorkflowInvocationRequestModel + * @description Model a workflow invocation request (InvokeWorkflowPayload) for an existing invocation. + */ + WorkflowInvocationRequestModel: { + /** + * History ID + * @description The encoded history id the workflow was run in. + */ + history_id: string; + /** + * Inputs + * @description Values for inputs + */ + inputs: Record; + /** + * Inputs by + * @description How the 'inputs' field maps its inputs (datasets/collections/step parameters) to workflows steps. + */ + inputs_by: string; + /** + * Is instance + * @description This API yields a particular workflow instance, newer workflows belonging to the same storedworkflow may have different state. + * @default true + * @constant + * @enum {boolean} + */ + instance: true; + /** + * Legacy Step Parameters + * @description Parameters specified per-step for the workflow invocation, this is legacy and you should generally use inputs and only specify the formal parameters of a workflow instead. If these are set, the workflow was not executed in a best-practice fashion and we the resulting invocation request may not fully reflect the executed workflow state. + */ + parameters?: Record | null; + /** + * Legacy Step Parameters Normalized + * @description Indicates if legacy parameters are already normalized to be indexed by the order_index and are specified as a dictionary per step. Legacy-style parameters could previously be specified as one parameter per step or by tool ID. + * @default true + * @constant + * @enum {boolean} + */ + parameters_normalized: true; + /** + * Preferred Intermediate Object Store ID + * @description The ID of the object store that should be used to store the intermediate datasets of this workflow - - Galaxy's job configuration may override this in some cases but this workflow preference will override tool and user preferences + */ + preferred_intermediate_object_store_id?: string | null; + /** + * Preferred Object Store ID + * @description The ID of the object store that should be used to store all datasets (can instead specify object store IDs for intermediate and outputs datasts separately) - - Galaxy's job configuration may override this in some cases but this workflow preference will override tool and user preferences + */ + preferred_object_store_id?: string | null; + /** + * Preferred Outputs Object Store ID + * @description The ID of the object store that should be used to store the marked output datasets of this workflow - Galaxy's job configuration may override this in some cases but this workflow preference will override tool and user preferences. + */ + preferred_outputs_object_store_id?: string | null; + /** + * Replacement Parameters + * @description Class of parameters mostly used for string replacement in PJAs. In best practice workflows, these should be replaced with input parameters + * @default {} + */ + replacement_params: Record | null; + /** + * Resource Parameters + * @description If a workflow_resource_params_file file is defined and the target workflow is configured to consumer resource parameters, they can be specified with this parameter. See https://github.com/galaxyproject/galaxy/pull/4830 for more information. + * @default {} + */ + resource_params: Record | null; + /** + * Use cached job + * @description Indicated whether to use a cached job for workflow invocation. + * @default false + */ + use_cached_job: boolean; + /** + * Workflow ID + * @description The encoded Workflow ID associated with the invocation. + */ + workflow_id: string; + }; + /** WorkflowInvocationResponse */ + WorkflowInvocationResponse: + | components["schemas"]["WorkflowInvocationElementView"] + | components["schemas"]["WorkflowInvocationCollectionView"]; + /** WorkflowInvocationStateSummary */ + WorkflowInvocationStateSummary: { + /** + * Id + * @example 0123456789ABCDEF + */ + id: string; + /** + * @description The name of the database model class. (enum property replaced by openapi-typescript) + * @enum {string} + */ + model: "WorkflowInvocation"; + /** + * Populated State + * @description Indicates the general state of the elements in the dataset collection:- 'new': new dataset collection, unpopulated elements.- 'ok': collection elements populated (HDAs may or may not have errors).- 'failed': some problem populating, won't be populated. + */ + populated_state: components["schemas"]["DatasetCollectionPopulatedState"]; + /** + * States + * @description A dictionary of job states and the number of jobs in that state. + * @default {} + */ + states: { + [key: string]: number; + }; + }; + /** + * WorkflowJobMetric + * @example { + * "name": "start_epoch", + * "plugin": "core", + * "raw_value": "1614261340.0000000", + * "title": "Job Start Time", + * "value": "2021-02-25 14:55:40" + * } + */ + WorkflowJobMetric: { + /** + * Name + * @description The name of the metric variable. + */ + name: string; + /** + * Plugin + * @description The instrumenter plugin that generated this metric. + */ + plugin: string; + /** + * Raw Value + * @description The raw value of the metric as a string. + */ + raw_value: string; + /** Step Index */ + step_index: number; + /** Step Label */ + step_label: string | null; + /** + * Title + * @description A descriptive title for this metric. + */ + title: string; + /** Tool Id */ + tool_id: string; + /** + * Value + * @description The textual representation of the metric value. + */ + value: string; + }; + /** WorkflowLandingRequest */ + WorkflowLandingRequest: { + /** Request State */ + request_state: Record; + state: components["schemas"]["LandingRequestState"]; + /** + * UUID + * Format: uuid4 + * @description Universal unique identifier for this dataset. + */ + uuid: string; + /** Workflow Id */ + workflow_id: string; + /** + * Workflow Target Type + * @enum {string} + */ + workflow_target_type: "stored_workflow" | "workflow" | "trs_url"; + }; + /** WriteInvocationStoreToPayload */ + WriteInvocationStoreToPayload: { + /** + * Bco Merge History Metadata + * @description When reading tags/annotations to generate BCO object include history metadata. + * @default false + */ + bco_merge_history_metadata: boolean; + /** + * Bco Override Algorithmic Error + * @description Override algorithmic error for 'error domain' when generating BioCompute object. + */ + bco_override_algorithmic_error?: { + [key: string]: string; + } | null; + /** + * Bco Override Empirical Error + * @description Override empirical error for 'error domain' when generating BioCompute object. + */ + bco_override_empirical_error?: { + [key: string]: string; + } | null; + /** + * Bco Override Environment Variables + * @description Override environment variables for 'execution_domain' when generating BioCompute object. + */ + bco_override_environment_variables?: { + [key: string]: string; + } | null; + /** + * Bco Override Xref + * @description Override xref for 'description domain' when generating BioCompute object. + */ + bco_override_xref?: components["schemas"]["XrefItem"][] | null; + /** + * Include deleted + * @description Include file contents for deleted datasets (if include_files is True). + * @default false + */ + include_deleted: boolean; + /** + * Include Files + * @description include materialized files in export when available + * @default true + */ + include_files: boolean; + /** + * Include hidden + * @description Include file contents for hidden datasets (if include_files is True). + * @default false + */ + include_hidden: boolean; + /** + * @description format of model store to export + * @default tar.gz + */ + model_store_format: components["schemas"]["ModelStoreFormat"]; + /** + * Target URI + * @description Galaxy Files URI to write mode store content to. + */ + target_uri: string; + }; + /** WriteStoreToPayload */ + WriteStoreToPayload: { + /** + * Include deleted + * @description Include file contents for deleted datasets (if include_files is True). + * @default false + */ + include_deleted: boolean; + /** + * Include Files + * @description include materialized files in export when available + * @default true + */ + include_files: boolean; + /** + * Include hidden + * @description Include file contents for hidden datasets (if include_files is True). + * @default false + */ + include_hidden: boolean; + /** + * @description format of model store to export + * @default tar.gz + */ + model_store_format: components["schemas"]["ModelStoreFormat"]; + /** + * Target URI + * @description Galaxy Files URI to write mode store content to. + */ + target_uri: string; + }; + /** XrefItem */ + XrefItem: { + /** + * Access Time + * Format: date-time + * @description Date and time the external reference was accessed + */ + access_time: string; + /** + * Ids + * @description List of reference identifiers + */ + ids: string[]; + /** + * Name + * @description Name of external reference + */ + name: string; + /** + * Namespace + * @description External resource vendor prefix + */ + namespace: string; + }; + /** Organization */ + galaxy__schema__drs__Organization: { + /** + * Name + * @description Name of the organization responsible for the service + */ + name: string; + /** + * Url + * Format: uri + * @description URL of the website of the organization (RFC 3986 format) + */ + url: string; + }; + /** Organization */ + galaxy__schema__schema__Organization: { + /** Address */ + address?: string | null; + /** Alternate Name */ + alternateName?: string | null; + /** + * Class + * @default Organization + */ + class: string; + /** Email */ + email?: string | null; + /** Fax Number */ + faxNumber?: string | null; + /** + * Identifier + * @description Identifier (typically an orcid.org ID) + */ + identifier?: string | null; + /** Image URL */ + image?: string | null; + /** + * Name + * @description The name of the creator. + */ + name?: string | null; + /** Telephone */ + telephone?: string | null; + /** URL */ + url?: string | null; + }; + }; + responses: never; + parameters: never; + requestBodies: never; + headers: never; + pathItems: never; +} +export type $defs = Record; +export interface operations { + get_api_key_api_authenticate_baseauth_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["APIKeyResponse"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + query_api_chat_post: { + parameters: { + query: { + job_id: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ChatPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + feedback_api_chat__job_id__feedback_put: { + parameters: { + query: { + feedback: number; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + job_id: string | null; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": number | null; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_configuration_get: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Object containing exposable configuration settings */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": Record; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + decode_id_api_configuration_decode__encoded_id__get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description Encoded id to be decoded */ + encoded_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Decoded id */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: number; + }; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Dynamic tool configuration files */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: string; + }[]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + encode_id_api_configuration_encode__decoded_id__get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description Decoded id to be encoded */ + decoded_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Encoded id */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: string; + }; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + tool_lineages_api_configuration_tool_lineages_get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Tool lineages for tools that have them */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: Record; + }[]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + reload_toolbox_api_configuration_toolbox_put: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + content_api_dataset_collection_element__dce_id__get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded ID of the dataset collection element. */ + dce_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DCESummary"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + create_api_dataset_collections_post: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateNewCollectionPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HDCADetailed"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get: { + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + /** @description The maximum number of content elements to return. */ + limit?: number | null; + /** @description The number of content elements that will be skipped before returning. */ + offset?: number | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + hdca_id: string; + /** @description Parent collection ID describing what collection the contents belongs to. */ + parent_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DatasetCollectionContentElements"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_dataset_collections__id__get: { + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + /** @description The view of collection instance to return. */ + view?: string; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + attributes_api_dataset_collections__id__attributes_get: { + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + copy_api_dataset_collections__id__copy_post: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateCollectionAttributePayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + dataset_collections__download: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + prepare_collection_download_api_dataset_collections__id__prepare_download_post: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Short term storage reference for async monitoring of this download. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AsyncFile"]; + }; + }; + /** @description Required asynchronous tasks required for this operation not available. */ + 501: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + suitable_converters_api_dataset_collections__id__suitable_converters_get: { + parameters: { + query?: { + /** @description The type of collection instance. Either `history` (default) or `library`. */ + instance_type?: "history" | "library"; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the `HDCA`. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["SuitableConverters"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_api_datasets_get: { + parameters: { + query?: { + /** @description Optional identifier of a History. Use it to restrict the search within a particular History. */ + history_id?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + delete_batch_api_datasets_delete: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteDatasetBatchPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeleteDatasetBatchResult"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + show_api_datasets__dataset_id__get: { + parameters: { + query?: { + /** @description The type of information about the dataset to be requested. */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + /** @description The type of information about the dataset to be requested. Each of these values may require additional parameters in the request and may return different responses. */ + data_type?: components["schemas"]["RequestDataType"] | null; + /** @description Maximum number of items to return. Currently only applies to `data_type=raw_data` requests */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item. Currently only applies to `data_type=raw_data` requests */ + offset?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + datasets__update_dataset: { + parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + datasets__delete: { + parameters: { + query?: { + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; + }; + cookie?: never; }; - /** XrefItem */ - XrefItem: { - /** - * Access Time - * Format: date-time - * @description Date and time the external reference was accessed - */ - access_time: string; - /** - * Ids - * @description List of reference identifiers - */ - ids: string[]; - /** - * Name - * @description Name of external reference - */ - name: string; - /** - * Namespace - * @description External resource vendor prefix - */ - namespace: string; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + }; }; - /** Organization */ - galaxy__schema__drs__Organization: { - /** - * Name - * @description Name of the organization responsible for the service - */ - name: string; - /** - * Url - * Format: uri - * @description URL of the website of the organization (RFC 3986 format) - */ - url: string; + responses: { + /** @description Request has been executed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description Request accepted, processing will finish later. */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; - /** Organization */ - galaxy__schema__schema__Organization: { - /** Address */ - address?: string | null; - /** Alternate Name */ - alternateName?: string | null; - /** - * Class - * @default Organization - */ - class?: string; - /** Email */ - email?: string | null; - /** Fax Number */ - faxNumber?: string | null; - /** - * Identifier - * @description Identifier (typically an orcid.org ID) - */ - identifier?: string | null; - /** Image URL */ - image?: string | null; - /** - * Name - * @description The name of the creator. - */ - name?: string | null; - /** Telephone */ - telephone?: string | null; - /** URL */ - url?: string | null; + }; + get_structured_content_api_datasets__dataset_id__content__content_type__get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + content_type: components["schemas"]["DatasetContentType"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; }; }; - responses: never; - parameters: never; - requestBodies: never; - headers: never; - pathItems: never; -} - -export type $defs = Record; - -export type external = Record; - -export interface operations { - /** Returns returns an API key for authenticated user based on BaseAuth headers. */ - get_api_key_api_authenticate_baseauth_get: { + converted_api_datasets__dataset_id__converted_get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["APIKeyResponse"]; + "application/json": components["schemas"]["ConvertedDatasetsMap"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return an object containing exposable configuration settings - * @description Return an object containing exposable configuration settings. - * - * A more complete list is returned if the user is an admin. - * Pass in `view` and a comma-seperated list of keys to control which - * configuration settings are returned. - */ - index_api_configuration_get: { + converted_ext_api_datasets__dataset_id__converted__ext__get: { parameters: { query?: { /** @description View to be passed to the serializer */ @@ -13707,3582 +19916,4475 @@ export interface operations { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + /** @description File extension of the new format to convert this dataset to. */ + ext: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Object containing exposable configuration settings */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": Record; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Decode a given id - * @description Decode a given id. - */ - decode_id_api_configuration_decode__encoded_id__get: { + extra_files_api_datasets__dataset_id__extra_files_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description Encoded id to be decoded */ - encoded_id: string; + /** @description The encoded database identifier of the dataset. */ + dataset_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Decoded id */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": { - [key: string]: number; - }; + "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return dynamic tool configuration files - * @description Return dynamic tool configuration files. - */ - dynamic_tool_confs_api_configuration_dynamic_tool_confs_get: { + get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Dynamic tool configuration files */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": { - [key: string]: string; - }[]; + "application/json": components["schemas"]["DatasetTextContentDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Encode a given id - * @description Decode a given id. - */ - encode_id_api_configuration_encode__decoded_id__get: { + compute_hash_api_datasets__dataset_id__hash_put: { parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description Decoded id to be encoded */ - decoded_id: number; + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ComputeDatasetHashPayload"]; }; }; responses: { - /** @description Encoded id */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": { - [key: string]: string; - }; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return tool lineages for tools that have them - * @description Return tool lineages for tools that have them. - */ - tool_lineages_api_configuration_tool_lineages_get: { + show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get: { parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Tool lineages for tools that have them */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": { - [key: string]: Record; - }[]; + "application/json": components["schemas"]["DatasetInheritanceChain"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Reload the Galaxy toolbox (but not individual tools) - * @description Reload the Galaxy toolbox (but not individual tools). - */ - reload_toolbox_api_configuration_toolbox_put: { + get_metrics_api_datasets__dataset_id__metrics_get: { parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the dataset */ + dataset_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Content */ - content_api_dataset_collection_element__dce_id__get: { + datasets__update_object_store_id: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded ID of the dataset collection element. */ - dce_id: string; + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateObjectStoreIdPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DCESummary"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a new dataset collection instance. */ - create_api_dataset_collections_post: { + resolve_parameters_display_api_datasets__dataset_id__parameters_display_get: { parameters: { + query?: { + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateNewCollectionPayload"]; + path: { + /** @description The ID of the dataset */ + dataset_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["HDCADetailed"]; + "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns direct child contents of indicated dataset collection parent ID. */ - contents_dataset_collection_api_dataset_collections__hdca_id__contents__parent_id__get: { + update_permissions_api_datasets__dataset_id__permissions_put: { parameters: { - query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; - /** @description The maximum number of content elements to return. */ - limit?: number | null; - /** @description The number of content elements that will be skipped before returning. */ - offset?: number | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - hdca_id: string; - /** @description Parent collection ID describing what collection the contents belongs to. */ - parent_id: string; + /** @description The ID of the History Dataset. */ + dataset_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["UpdateDatasetPermissionsPayload"] + | components["schemas"]["UpdateDatasetPermissionsPayloadAliasB"] + | components["schemas"]["UpdateDatasetPermissionsPayloadAliasC"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetCollectionContentElements"]; + "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns detailed information about the given collection. */ - show_api_dataset_collections__id__get: { + show_storage_api_datasets__dataset_id__storage_get: { parameters: { query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; - /** @description The view of collection instance to return. */ - view?: string; + /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ + hda_ldda?: components["schemas"]["DatasetSourceType"]; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the History Dataset. */ + dataset_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["HDCADetailed"] | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["DatasetStorageDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns `dbkey`/`extension` attributes for all the collection elements. */ - attributes_api_dataset_collections__id__attributes_get: { + display_api_datasets__history_content_id__display_get: { parameters: { query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["DatasetCollectionAttributesResult"]; + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Copy the given collection datasets to a new collection using a new `dbkey` attribute. */ - copy_api_dataset_collections__id__copy_post: { + display_api_datasets__history_content_id__display_head: { parameters: { + query?: { + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateCollectionAttributePayload"]; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ - dataset_collections__download: { + datasets__get_metadata_file: { parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Prepare an short term storage object that the collection will be downloaded to. - * @description The history dataset collection will be written as a `zip` archive to the - * returned short term storage object. Progress tracking this file's creation - * can be tracked with the short_term_storage API. - */ - prepare_collection_download_api_dataset_collections__id__prepare_download_post: { + get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { parameters: { + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Short term storage reference for async monitoring of this download. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": unknown; }; }; - /** @description Required asynchronous tasks required for this operation not available. */ - 501: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns a list of applicable converters for all datatypes in the given collection. */ - suitable_converters_api_dataset_collections__id__suitable_converters_get: { + index_api_datatypes_get: { parameters: { query?: { - /** @description The type of collection instance. Either `history` (default) or `library`. */ - instance_type?: "history" | "library"; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the `HDCA`. */ - id: string; + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + extension_only?: boolean | null; + /** @description Whether to return only datatypes which can be uploaded */ + upload_only?: boolean | null; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description List of data types */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SuitableConverters"]; + "application/json": components["schemas"]["DatatypeDetails"][] | string[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Search datasets or collections using a query system. */ - index_api_datasets_get: { + converters_api_datatypes_converters_get: { parameters: { - query?: { - /** @description Optional identifier of a History. Use it to restrict the search within a particular History. */ - history_id?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description List of all datatype converters */ 200: { - content: { - "application/json": ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DatatypeConverterList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Deletes or purges a batch of datasets. - * @description Deletes or purges a batch of datasets. - * **Warning**: only the ownership of the datasets (and upload state for HDAs) is checked, - * no other checks or restrictions are made. - */ - delete_batch_api_datasets_delete: { + edam_data_api_datatypes_edam_data_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["DeleteDatasetBatchPayload"]; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Dictionary/map of datatypes and EDAM data */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DeleteDatasetBatchResult"]; + "application/json": { + [key: string]: string; + }; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about and/or content of a dataset. - * @description **Note**: Due to the multipurpose nature of this endpoint, which can receive a wild variety of parameters - * and return different kinds of responses, the documentation here will be limited. - * To get more information please check the source code. - */ - show_api_datasets__dataset_id__get: { + edam_data_detailed_api_datatypes_edam_data_detailed_get: { parameters: { - query?: { - /** @description The type of information about the dataset to be requested. */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - /** @description The type of information about the dataset to be requested. Each of these values may require additional parameters in the request and may return different responses. */ - data_type?: components["schemas"]["RequestDataType"] | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the values for the history dataset (HDA) item with the given ``ID``. - * @description Updates the values for the history content item with the given ``ID``. - */ - datasets__update_dataset: { + edam_formats_api_datatypes_edam_formats_get: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Dictionary/map of datatypes and EDAM formats */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": { + [key: string]: string; + }; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Delete the history dataset content with the given ``ID``. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ - datasets__delete: { + edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { parameters: { - query?: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Request has been executed. */ + /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ 200: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + headers: { + [name: string]: unknown; }; - }; - /** @description Request accepted, processing will finish later. */ - 202: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Retrieve information about the content of a dataset. */ - get_structured_content_api_datasets__dataset_id__content__content_type__get: { + mapping_api_datatypes_mapping_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - content_type: components["schemas"]["DatasetContentType"]; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Dictionary to map data types with their classes */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["DatatypesMap"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a a map with all the existing converted datasets associated with this instance. - * @description Return a map of ` : ` containing all the *existing* converted datasets. - */ - converted_api_datasets__dataset_id__converted_get: { + sniffers_api_datatypes_sniffers_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description List of datatype sniffers */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ConvertedDatasetsMap"]; + "application/json": string[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return information about datasets made by converting this dataset to a new format. - * @description Return information about datasets made by converting this dataset to a new format. - * - * If there is no existing converted dataset for the format in `ext`, one will be created. - * - * **Note**: `view` and `keys` are also available to control the serialization of the dataset. - */ - converted_ext_api_datasets__dataset_id__converted__ext__get: { + types_and_mapping_api_datatypes_types_and_mapping_get: { parameters: { query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - /** @description File extension of the new format to convert this dataset to. */ - ext: string; + /** @description Whether to return only the datatype's extension rather than the datatype's details */ + extension_only?: boolean | null; + /** @description Whether to return only datatypes which can be uploaded */ + upload_only?: boolean | null; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Dictionary to map data types with their classes */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"]; + "application/json": components["schemas"]["DatatypesCombinedMap"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of extra files/directories associated with a dataset. */ - extra_files_api_datasets__dataset_id__extra_files_get: { + display_applications_index_api_display_applications_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The encoded database identifier of the dataset. */ - dataset_id: string; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetExtraFiles"]; + "application/json": components["schemas"]["DisplayApplication"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns dataset content as Text. */ - get_content_as_text_api_datasets__dataset_id__get_content_as_text_get: { + display_applications_reload_api_display_applications_reload_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + [key: string]: string[]; + } | null; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetTextContentDetails"]; + "application/json": components["schemas"]["ReloadFeedback"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Compute dataset hash for dataset and update model */ - compute_hash_api_datasets__dataset_id__hash_put: { + download_api_drs_download__object_id__get: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ComputeDatasetHashPayload"]; + /** @description The ID of the group */ + object_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** For internal use, this endpoint may change without warning. */ - show_inheritance_chain_api_datasets__dataset_id__inheritance_chain_get: { + file_sources__instances_index: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetInheritanceChain"]; + "application/json": components["schemas"]["UserFileSourceModel"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return job metrics for specified job. - * @deprecated - */ - get_metrics_api_datasets__dataset_id__metrics_get: { + file_sources__create_instance: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the dataset */ - dataset_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": (components["schemas"]["JobMetric"] | null)[]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update an object store ID for a dataset you own. */ - datasets__update_object_store_id: { + file_sources__test_new_instance_configuration: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; - }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateObjectStoreIdPayload"]; + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["PluginStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Resolve parameters as a list for nested display. - * @deprecated - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ - resolve_parameters_display_api_datasets__dataset_id__parameters_display_get: { + file_sources__instances_get: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the dataset */ - dataset_id: string; + /** @description The UUID index for a persisted UserFileSourceStore object. */ + uuid: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobDisplayParametersSummary"]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ - update_permissions_api_datasets__dataset_id__permissions_put: { + file_sources__instances_update: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + /** @description The UUID index for a persisted UserFileSourceStore object. */ + uuid: string; }; + cookie?: never; }; requestBody: { content: { "application/json": - | components["schemas"]["UpdateDatasetPermissionsPayload"] - | components["schemas"]["UpdateDatasetPermissionsPayloadAliasB"] - | components["schemas"]["UpdateDatasetPermissionsPayloadAliasC"]; + | components["schemas"]["UpdateInstanceSecretPayload"] + | components["schemas"]["UpgradeInstancePayload"] + | components["schemas"]["UpdateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetAssociationRoles"]; + "application/json": components["schemas"]["UserFileSourceModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Display user-facing storage details related to the objectstore a dataset resides in. */ - show_storage_api_datasets__dataset_id__storage_get: { + file_sources__instances_purge: { parameters: { - query?: { - /** @description Whether this dataset belongs to a history (HDA) or a library (LDDA). */ - hda_ldda?: components["schemas"]["DatasetSourceType"]; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - dataset_id: string; + /** @description The UUID index for a persisted UserFileSourceStore object. */ + uuid: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["DatasetStorageDetails"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - display_api_datasets__history_content_id__display_get: { + file_sources__instances_test_instance: { parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The UUID index for a persisted UserFileSourceStore object. */ + uuid: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PluginStatus"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - display_api_datasets__history_content_id__display_head: { + file_sources__test_instances_update: { parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The UUID index for a persisted UserFileSourceStore object. */ + uuid: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["TestUpgradeInstancePayload"] + | components["schemas"]["TestUpdateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["PluginStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the metadata file associated with this history item. */ - datasets__get_metadata_file: { + file_sources__templates_index: { parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list of the configured file source templates. */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["FileSourceTemplateSummaries"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Check if metadata file can be downloaded. */ - get_metadata_file_datasets_api_datasets__history_content_id__metadata_file_head: { + file_sources__template_oauth2: { parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The template ID of the target file source template. */ + template_id: string; + /** @description The template version of the target file source template. */ + template_version: number; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description OAuth2 authorization url to redirect user to prior to creation. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["OAuth2Info"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists all available data types - * @description Gets the list of all available data types. - */ - index_api_datatypes_get: { + index_api_folders__folder_id__contents_get: { parameters: { query?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - extension_only?: boolean | null; - /** @description Whether to return only datatypes which can be uploaded */ - upload_only?: boolean | null; + /** @description Maximum number of contents to return. */ + limit?: number; + /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ + offset?: number; + /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ + search_text?: string | null; + /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ + include_deleted?: boolean | null; + /** @description Sort results by specified field. */ + order_by?: "name" | "description" | "type" | "size" | "update_time"; + /** @description Sort results in descending order. */ + sort_desc?: boolean | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description List of data types */ + /** @description The contents of the folder that match the query parameters. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatatypeDetails"][] | string[]; + "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of all installed converters - * @description Gets the list of all installed converters. - */ - converters_api_datatypes_converters_get: { - responses: { - /** @description List of all datatype converters */ - 200: { - content: { - "application/json": components["schemas"]["DatatypeConverterList"]; - }; + add_history_datasets_to_library_api_folders__folder_id__contents_post: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; }; - /** @description Request Error */ - "4XX": { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + path: { + /** @description The encoded identifier of the library folder. */ + folder_id: string; }; - /** @description Server Error */ - "5XX": { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFilePayload"]; }; }; - }; - /** - * Returns a dictionary/map of datatypes and EDAM data - * @description Gets a map of datatypes and their corresponding EDAM data. - */ - edam_data_api_datatypes_edam_data_get: { responses: { - /** @description Dictionary/map of datatypes and EDAM data */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": { - [key: string]: string; - }; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a dictionary of datatypes and EDAM data details - * @description Gets a map of datatypes and their corresponding EDAM data. - * EDAM data contains the EDAM iri, label, and definition. - */ - edam_data_detailed_api_datatypes_edam_data_detailed_get: { + show_api_folders__id__get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description Dictionary of EDAM data details containing the EDAM iri, label, and definition */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a dictionary/map of datatypes and EDAM formats - * @description Gets a map of datatypes and their corresponding EDAM formats. - */ - edam_formats_api_datatypes_edam_formats_get: { + update_api_folders__id__put: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + }; + }; responses: { - /** @description Dictionary/map of datatypes and EDAM formats */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": { - [key: string]: string; - }; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a dictionary of datatypes and EDAM format details - * @description Gets a map of datatypes and their corresponding EDAM formats. - * EDAM formats contain the EDAM iri, label, and definition. - */ - edam_formats_detailed_api_datatypes_edam_formats_detailed_get: { + create_api_folders__id__post: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryFolderPayload"]; + }; + }; responses: { - /** @description Dictionary of EDAM format details containing the EDAM iri, label, and definition */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatatypesEDAMDetailsDict"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns mappings for data types and their implementing classes - * @description Gets mappings for data types. - */ - mapping_api_datatypes_mapping_get: { + delete_api_folders__id__delete: { + parameters: { + query?: { + /** @description Whether to restore a deleted library folder. */ + undelete?: boolean | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description Dictionary to map data types with their classes */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatatypesMap"]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of all installed sniffers - * @description Gets the list of all installed data type sniffers. - */ - sniffers_api_datatypes_sniffers_get: { + update_api_folders__id__patch: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + }; + }; responses: { - /** @description List of datatype sniffers */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string[]; + "application/json": components["schemas"]["LibraryFolderDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns all the data types extensions and their mappings - * @description Combines the datatype information from (/api/datatypes) and the - * mapping information from (/api/datatypes/mapping) into a single - * response. - */ - types_and_mapping_api_datatypes_types_and_mapping_get: { + get_permissions_api_folders__id__permissions_get: { parameters: { query?: { - /** @description Whether to return only the datatype's extension rather than the datatype's details */ - extension_only?: boolean | null; - /** @description Whether to return only datatypes which can be uploaded */ - upload_only?: boolean | null; + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Dictionary to map data types with their classes */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatatypesCombinedMap"]; + "application/json": + | components["schemas"]["LibraryFolderCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of display applications. - * @description Returns the list of display applications. - */ - display_applications_index_api_display_applications_get: { + set_permissions_api_folders__id__permissions_post: { + parameters: { + query?: { + /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ + action?: components["schemas"]["LibraryFolderPermissionAction"] | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded identifier of the library folder. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; + }; + }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DisplayApplication"][]; + "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Reloads the list of display applications. - * @description Reloads the list of display applications. - */ - display_applications_reload_api_display_applications_reload_post: { + delete_api_forms__id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody?: { - content: { - "application/json": { - [key: string]: string[]; - } | null; + path: { + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ReloadFeedback"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Download */ - download_api_drs_download__object_id__get: { + undelete_api_forms__id__undelete_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group */ - object_id: string; + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a list of persisted file source instances defined by the requesting user. */ - file_sources__instances_index: { + index_api_ftp_files_get: { parameters: { + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + /** @description Maximum number of entries to return. */ + limit?: number | null; + /** @description Number of entries to skip. */ + offset?: number | null; + /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ + query?: string | null; + /** @description Sort the entries by the specified field. */ + sort_by?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserFileSourceModel"][]; + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a user-bound file source. */ - file_sources__create_instance: { + index_api_genomes_get: { parameters: { + query?: { + /** @description If true, return genome keys with chromosome lengths */ + chrom_info?: boolean; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; - }; - }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Installed genomes */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserFileSourceModel"]; + "application/json": string[][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Test payload for creating user-bound file source. */ - file_sources__test_new_instance_configuration: { + show_api_genomes__id__get: { parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + num?: number; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; + path: { + /** @description Genome ID */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Information about genome build */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["PluginStatus"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a persisted user file source instance. */ - file_sources__instances_get: { + indexes_api_genomes__id__indexes_get: { parameters: { + query?: { + /** @description Index type */ + type?: string; + /** @description Format */ + format?: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The UUID index for a persisted UserFileSourceStore object. */ - user_file_source_id: string; + /** @description Genome ID */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Indexes for a genome id for provided type */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserFileSourceModel"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update or upgrade user file source instance. */ - file_sources__instances_update: { + sequences_api_genomes__id__sequences_get: { parameters: { + query?: { + /** @description If true, return reference data */ + reference?: boolean; + /** @description Limits size of returned data */ + chrom?: string; + /** @description Limits size of returned data */ + low?: number; + /** @description Limits size of returned data */ + high?: number; + /** @description Format */ + format?: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The UUID index for a persisted UserFileSourceStore object. */ - user_file_source_id: string; - }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["UpdateInstanceSecretPayload"] - | components["schemas"]["UpgradeInstancePayload"] - | components["schemas"]["UpdateInstancePayload"]; + /** @description Genome ID */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Raw sequence data */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserFileSourceModel"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purge user file source instance. */ - file_sources__instances_purge: { + index_api_groups_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The UUID index for a persisted UserFileSourceStore object. */ - user_file_source_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["GroupListResponse"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a list of file source templates available to build user defined file sources from */ - file_sources__templates_index: { + create_api_groups_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["GroupCreatePayload"]; + }; }; responses: { - /** @description A list of the configured file source templates. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["FileSourceTemplateSummaries"]; + "application/json": components["schemas"]["GroupListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a list of a folder's contents (files and sub-folders) with additional metadata about the folder. - * @description Returns a list of a folder's contents (files and sub-folders). - * - * Additional metadata for the folder is provided in the response as a separate object containing data - * for breadcrumb path building, permissions and other folder's details. - * - * *Note*: When sorting, folders always have priority (they show-up before any dataset regardless of the sorting). - * - * **Security note**: - * - Accessing a library folder or sub-folder requires only access to the parent library. - * - Deleted folders can only be accessed by admins or users with `MODIFY` permission. - * - Datasets may be public, private or restricted (to a group of users). Listing deleted datasets has the same requirements as folders. - */ - index_api_folders__folder_id__contents_get: { + show_group_api_groups__group_id__get: { parameters: { - query?: { - /** @description Maximum number of contents to return. */ - limit?: number; - /** @description Return contents from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, contents between position 200-299 will be returned. */ - offset?: number; - /** @description Used to filter the contents. Only the folders and files which name contains this text will be returned. */ - search_text?: string | null; - /** @description Returns also deleted contents. Deleted contents can only be retrieved by Administrators or users with */ - include_deleted?: boolean | null; - /** @description Sort results by specified field. */ - order_by?: "name" | "description" | "type" | "size" | "update_time"; - /** @description Sort results in descending order. */ - sort_desc?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; + group_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The contents of the folder that match the query parameters. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderContentsIndexResult"]; + "application/json": components["schemas"]["GroupResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Creates a new library file from an existing HDA/HDCA. */ - add_history_datasets_to_library_api_folders__folder_id__contents_post: { + update_api_groups__group_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - folder_id: string; + group_id: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateLibraryFilePayload"]; + "application/json": components["schemas"]["GroupUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["GroupResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about a particular library folder. - * @description Returns detailed information about the library folder with the given ID. - */ - show_api_folders__id__get: { + delete_api_groups__group_id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; + group_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the information of an existing library folder. - * @description Updates the information of an existing library folder. - */ - update_api_folders__id__put: { + purge_api_groups__group_id__purge_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + group_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a new library folder underneath the one specified by the ID. - * @description Returns detailed information about the newly created library folder. - */ - create_api_folders__id__post: { + group_roles_api_groups__group_id__roles_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateLibraryFolderPayload"]; + /** @description The ID of the group. */ + group_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["GroupRoleListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Marks the specified library folder as deleted (or undeleted). - * @description Marks the specified library folder as deleted (or undeleted). - */ - delete_api_folders__id__delete: { + group_role_api_groups__group_id__roles__role_id__get: { parameters: { - query?: { - /** @description Whether to restore a deleted library folder. */ - undelete?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update - * @description Updates the information of an existing library folder. - */ - update_api_folders__id__patch: { + update_api_groups__group_id__roles__role_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryFolderPayload"]; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderDetails"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Gets the current or available permissions of a particular library folder. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ - get_permissions_api_folders__id__permissions_get: { + delete_api_groups__group_id__roles__role_id__delete: { parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the role. */ + role_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["LibraryFolderCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; + "application/json": components["schemas"]["GroupRoleResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Sets the permissions to manage a library folder. - * @description Sets the permissions to manage a library folder. - */ - set_permissions_api_folders__id__permissions_post: { + undelete_api_groups__group_id__undelete_post: { parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. Currently only `set_permissions` is supported. */ - action?: components["schemas"]["LibraryFolderPermissionAction"] | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded identifier of the library folder. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["LibraryFolderPermissionsPayload"]; + group_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibraryFolderCurrentPermissions"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete */ - delete_api_forms__id__delete: { + group_user_api_groups__group_id__user__user_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Undelete */ - undelete_api_forms__id__undelete_post: { + update_api_groups__group_id__user__user_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays remote files available to the user. Please use /api/remote_files instead. - * @deprecated - * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. - */ - index_api_ftp_files_get: { + delete_api_groups__group_id__user__user_id__delete: { parameters: { - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; - /** @description Maximum number of entries to return. */ - limit?: number | null; - /** @description Number of entries to skip. */ - offset?: number | null; - /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ - query?: string | null; - /** @description Sort the entries by the specified field. */ - sort_by?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return a list of installed genomes */ - index_api_genomes_get: { + group_users_api_groups__group_id__users_get: { parameters: { - query?: { - /** @description If true, return genome keys with chromosome lengths */ - chrom_info?: boolean; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the group. */ + group_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Installed genomes */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string[][]; + "application/json": components["schemas"]["GroupUserListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return information about build */ - show_api_genomes__id__get: { + group_user_api_groups__group_id__users__user_id__get: { parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - num?: number; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description Genome ID */ - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Information about genome build */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all available indexes for a genome id for provided type */ - indexes_api_genomes__id__indexes_get: { + update_api_groups__group_id__users__user_id__put: { parameters: { - query?: { - /** @description Index type */ - type?: string; - /** @description Format */ - format?: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description Genome ID */ - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Indexes for a genome id for provided type */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return raw sequence data */ - sequences_api_genomes__id__sequences_get: { + delete_api_groups__group_id__users__user_id__delete: { parameters: { - query?: { - /** @description If true, return reference data */ - reference?: boolean; - /** @description Limits size of returned data */ - chrom?: string; - /** @description Limits size of returned data */ - low?: number; - /** @description Limits size of returned data */ - high?: number; - /** @description Format */ - format?: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description Genome ID */ - id: string; + /** @description The ID of the group. */ + group_id: string; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Raw sequence data */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["GroupUserResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays a collection (list) of groups. */ - index_api_groups_get: { + search_forum_api_help_forum_search_get: { parameters: { + query: { + /** @description Search query to use for searching the Galaxy Help forum. */ + query: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupListResponse"]; + "application/json": components["schemas"]["HelpForumSearchResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Creates a new group. */ - create_api_groups_post: { + index_api_histories_get: { parameters: { + query?: { + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + /** @description Whether to include archived histories. */ + show_archived?: boolean | null; + /** @description Sort index by this specified attribute */ + sort_by?: "create_time" | "name" | "update_time" | "username"; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `name` + * : The history's name. + * + * `annotation` + * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Historys: `title`, `description`, `slug`, `tag`. + * + * */ + search?: string | null; + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + all?: boolean | null; + /** + * @deprecated + * @description Whether to return only deleted items. + */ + deleted?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupCreatePayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupListResponse"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information about a group. */ - show_group_api_groups__group_id__get: { + create_api_histories_post: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - group_id: string; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupResponse"]; + "application/json": + | components["schemas"]["JobImportHistoryResponse"] + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Modifies a group. */ - update_api_groups__group_id__put: { + get_archived_histories_api_histories_archived_get: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - group_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["GroupUpdatePayload"]; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupResponse"]; + "application/json": ( + | components["schemas"]["CustomArchivedHistoryView"] + | components["schemas"]["ArchivedHistoryDetailed"] + | components["schemas"]["ArchivedHistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete */ - delete_api_groups__group_id__delete: { + batch_delete_api_histories_batch_delete_put: { parameters: { + query?: { + purge?: boolean; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - group_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["DeleteHistoriesPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purge */ - purge_api_groups__group_id__purge_post: { + batch_undelete_api_histories_batch_undelete_put: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - group_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UndeleteHistoriesPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays a collection (list) of groups. */ - group_roles_api_groups__group_id__roles_get: { + count_api_histories_count_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupRoleListResponse"]; + "application/json": number; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information about a group role. */ - group_role_api_groups__group_id__roles__role_id__get: { + index_deleted_api_histories_deleted_get: { parameters: { + query?: { + /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ + all?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Adds a role to a group */ - update_api_groups__group_id__roles__role_id__put: { + undelete_api_histories_deleted__history_id__undelete_post: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Removes a role from a group */ - delete_api_groups__group_id__roles__role_id__delete: { + create_from_store_api_histories_from_store_post: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the role. */ - role_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupRoleResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Undelete */ - undelete_api_groups__group_id__undelete_post: { + create_from_store_async_api_histories_from_store_async_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - group_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryFromStore"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ - group_user_api_groups__group_id__user__user_id__get: { + show_recent_api_histories_most_recently_used_get: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ - update_api_groups__group_id__user__user_id__put: { + published_api_histories_published_get: { parameters: { + query?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ - delete_api_groups__group_id__user__user_id__delete: { + shared_with_me_api_histories_shared_with_me_get: { parameters: { + query?: { + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": ( + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays a collection (list) of groups. - * @description GET /api/groups/{encoded_group_id}/users - * Displays a collection (list) of groups. - */ - group_users_api_groups__group_id__users_get: { + history_api_histories__history_id__get: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserListResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays information about a group user. - * @description Displays information about a group user. - */ - group_user_api_groups__group_id__users__user_id__get: { + update_api_histories__history_id__put: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Adds a user to a group - * @description PUT /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Adds a user to a group - */ - update_api_groups__group_id__users__user_id__put: { + delete_api_histories__history_id__delete: { parameters: { + query?: { + purge?: boolean; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes a user from a group - * @description DELETE /api/groups/{encoded_group_id}/users/{encoded_user_id} - * Removes a user from a group - */ - delete_api_groups__group_id__users__user_id__delete: { + archive_history_api_histories__history_id__archive_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the group. */ - group_id: string; - /** @description The ID of the user. */ - user_id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["GroupUserResponse"]; + "application/json": + | components["schemas"]["CustomArchivedHistoryView"] + | components["schemas"]["ArchivedHistoryDetailed"] + | components["schemas"]["ArchivedHistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Search the Galaxy Help forum. - * @description Search the Galaxy Help forum using the Discourse API. - * - * **Note**: This endpoint is for **INTERNAL USE ONLY** and is not part of the public Galaxy API. - */ - search_forum_api_help_forum_search_get: { + restore_archived_history_api_histories__history_id__archive_restore_put: { parameters: { - query: { - /** @description Search query to use for searching the Galaxy Help forum. */ - query: string; + query?: { + /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ + force?: boolean | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["HelpForumSearchResponse"]; + "application/json": + | components["schemas"]["CustomHistoryView"] + | components["schemas"]["HistoryDetailed"] + | components["schemas"]["HistorySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns histories available to the current user. */ - index_api_histories_get: { + citations_api_histories__history_id__citations_get: { parameters: { - query?: { - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - /** @description Whether to include archived histories. */ - show_archived?: boolean | null; - /** @description Sort index by this specified attribute */ - sort_by?: "create_time" | "name" | "update_time" | "username"; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `name` - * : The history's name. - * - * `annotation` - * : The history's annotation. (The tag `a` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The history's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Historys: `title`, `description`, `slug`, `tag`. - */ - search?: string | null; - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - all?: boolean | null; - /** - * @deprecated - * @description Whether to return only deleted items. - */ - deleted?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": unknown[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new history. - * @description The new history can also be copied form a existing history or imported from an archive or URL. - */ - create_api_histories_post: { + history_contents__index: { parameters: { query?: { + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ keys?: string | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; }; header?: { + /** @description Accept header to determine the response format. Default is 'application/json'. */ + accept?: "application/json" | "application/vnd.galaxy.history.contents.stats+json"; /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": components["schemas"]["Body_create_api_histories_post"]; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The contents of the history that match the query. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["JobImportHistoryResponse"] - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["HistoryContentsResult"]; + "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get a list of all archived histories for the current user. - * @description Get a list of all archived histories for the current user. - * - * Archived histories are histories are not part of the active histories of the user but they can be accessed using this endpoint. - */ - get_archived_histories_api_histories_archived_get: { + update_batch_api_histories__history_id__contents_put: { parameters: { query?: { /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; + }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": ( - | components["schemas"]["CustomArchivedHistoryView"] - | components["schemas"]["ArchivedHistoryDetailed"] - | components["schemas"]["ArchivedHistorySummary"] - )[]; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["HistoryContentsResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Marks several histories with the given IDs as deleted. */ - batch_delete_api_histories_batch_delete_put: { + history_contents__create: { parameters: { query?: { - purge?: boolean; + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"] | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -17292,424 +24394,547 @@ export interface operations { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["DeleteHistoriesPayload"]; + "application/json": components["schemas"]["CreateHistoryContentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Marks several histories with the given IDs as undeleted. */ - batch_undelete_api_histories_batch_undelete_put: { + history_contents__archive: { parameters: { query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description The name that the Archive will have (defaults to history name). */ + filename?: string | null; + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UndeleteHistoriesPayload"]; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns number of histories for the current user. */ - count_api_histories_count_get: { + history_contents__archive_named: { parameters: { + query?: { + /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ + dry_run?: boolean | null; + /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ + q?: string[] | null; + /** @description The value to filter by. */ + qv?: string[] | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ + order?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The name that the Archive will have (defaults to history name). */ + filename: string; + /** + * @deprecated + * @description Output format of the archive. + */ + format: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": number; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns deleted histories for the current user. */ - index_deleted_api_histories_deleted_get: { + bulk_operation_api_histories__history_id__contents_bulk_put: { parameters: { query?: { - /** @description Whether all histories from other users in this Galaxy should be included. Only admins are allowed to query all histories. */ - all?: boolean | null; /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ q?: string[] | null; /** @description The value to filter by. */ qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Restores a deleted history with the given ID (that hasn't been purged). */ - undelete_api_histories_deleted__history_id__undelete_post: { + history_contents__download_collection: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { + /** @description The ID of the `HDCA`. */ + id: string; /** @description The encoded database identifier of the History. */ - history_id: string; + history_id: string | null; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create histories from a model store. */ - create_from_store_api_histories_from_store_post: { + materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Launch a task to create histories from a model store. */ - create_from_store_async_api_histories_from_store_async_post: { + update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + dataset_id: string; + }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateHistoryFromStore"]; + "application/json": + | components["schemas"]["UpdateDatasetPermissionsPayload"] + | components["schemas"]["UpdateDatasetPermissionsPayloadAliasB"] + | components["schemas"]["UpdateDatasetPermissionsPayloadAliasC"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["DatasetAssociationRoles"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the most recently used history of the user. */ - show_recent_api_histories_most_recently_used_get: { + history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { parameters: { query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ + offset?: number | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all histories that are published. */ - published_api_histories_published_get: { + history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { parameters: { query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ + preview?: boolean; + /** @description If non-null, get the specified filename from the extra files for this dataset. */ + filename?: string | null; + /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ + to_ext?: string | null; + /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ + raw?: boolean; + /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ + ck_size?: number | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the History Dataset. */ + history_content_id: string; + history_id: string | null; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all histories that are shared with the current user. */ - shared_with_me_api_histories_shared_with_me_get: { + extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { parameters: { - query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"] - )[]; + "application/json": components["schemas"]["DatasetExtraFiles"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the history with the given ID. */ - history_api_histories__history_id__get: { + history_contents__get_metadata_file: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + query: { + /** @description The name of the metadata file to retrieve. */ + metadata_file: string; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ @@ -17718,363 +24943,339 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the History Dataset. */ + history_content_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates the values for the history with the given ID. */ - update_api_histories__history_id__put: { + index_api_histories__history_id__contents__history_content_id__tags_get: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; history_id: string; }; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryPayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Marks the history with the given ID as deleted. */ - delete_api_histories__history_id__delete: { + show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { parameters: { - query?: { - purge?: boolean; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; + tag_name: string; history_id: string; }; + cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryPayload"] | null; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Archive a history. - * @description Marks the given history as 'archived' and returns the history. - * - * Archiving a history will remove it from the list of active histories of the user but it will still be - * accessible via the `/api/histories/{id}` or the `/api/histories/archived` endpoints. - * - * Associating an export record: - * - * - Optionally, an export record (containing information about a recent snapshot of the history) can be associated with the - * archived history by providing an `archive_export_id` in the payload. The export record must belong to the history and - * must be in the ready state. - * - When associating an export record, the history can be purged after it has been archived using the `purge_history` flag. - * - * If the history is already archived, this endpoint will return a 409 Conflict error, indicating that the history is already archived. - * If the history was not purged after it was archived, you can restore it using the `/api/histories/{id}/archive/restore` endpoint. - */ - archive_history_api_histories__history_id__archive_post: { + update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; + tag_name: string; history_id: string; }; + cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["ArchiveHistoryRequestPayload"] | null; + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["CustomArchivedHistoryView"] - | components["schemas"]["ArchivedHistoryDetailed"] - | components["schemas"]["ArchivedHistorySummary"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Restore an archived history. - * @description Restores an archived history and returns it. - * - * Restoring an archived history will add it back to the list of active histories of the user (unless it was purged). - * - * **Warning**: Please note that histories that are associated with an archive export might be purged after export, so un-archiving them - * will not restore the datasets that were in the history before it was archived. You will need to import back the archive export - * record to restore the history and its datasets as a new copy. See `/api/histories/from_store_async` for more information. - */ - restore_archived_history_api_histories__history_id__archive_restore_put: { + create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { parameters: { - query?: { - /** @description If true, the history will be un-archived even if it has an associated archive export record and was purged. */ - force?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; + tag_name: string; history_id: string; }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ItemTagsCreatePayload"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["CustomHistoryView"] - | components["schemas"]["HistoryDetailed"] - | components["schemas"]["HistorySummary"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return all the citations for the tools used to produce the datasets in the history. */ - citations_api_histories__history_id__citations_get: { + delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ + history_content_id: string; + tag_name: string; history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown[]; + "application/json": boolean; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the contents of the given history. - * @description Return a list of `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - history_contents__index: { + history_contents__show_legacy: { parameters: { query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; + /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ + fuzzy_count?: number | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The contents of the history that match the query. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["HistoryContentsResult"]; - "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Batch update specific properties of a set items contained in the given History. - * @description Batch update specific properties of a set items contained in the given History. - * - * If you provide an invalid/unknown property key the request will not fail, but no changes - * will be made to the items. - */ - update_batch_api_histories__history_id__contents_put: { + history_contents__update_legacy: { parameters: { query?: { + /** @description The type of the target history element. */ + type?: components["schemas"]["HistoryContentType"]; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -18087,44 +25288,73 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateHistoryContentsBatchPayload"]; + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["HistoryContentsResult"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a new `HDA` or `HDCA` in the given History. - * @deprecated - * @description Create a new `HDA` or `HDCA` in the given History. - */ - history_contents__create: { + history_contents__delete_legacy: { parameters: { query?: { /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"] | null; + type?: components["schemas"]["HistoryContentType"]; + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; /** @description View to be passed to the serializer */ view?: string | null; /** @description Comma-separated list of keys to be passed to the serializer */ @@ -18137,72 +25367,58 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; + cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description Request has been executed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description Request accepted, processing will finish later. */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ - history_contents__archive: { + validate_api_histories__history_id__contents__id__validate_put: { parameters: { - query?: { - /** @description The name that the Archive will have (defaults to history name). */ - filename?: string | null; - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -18210,40 +25426,78 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": Record; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Build and return a compressed archive of the selected history contents. - * @description Build and return a compressed archive of the selected history contents. - * - * **Note**: this is a volatile endpoint and settings and behavior may change. - */ - history_contents__archive_named: { + history_contents__index_typed: { parameters: { query?: { - /** @description Whether to return the archive and file paths only (as JSON) and not an actual archive file. */ - dry_run?: boolean | null; + /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ + v?: string | null; + /** + * @deprecated + * @description Legacy name for the `dataset_details` parameter. + */ + details?: string | null; + /** + * @deprecated + * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. + */ + ids?: string | null; + /** + * @deprecated + * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. + */ + types?: string[] | null; + /** + * @deprecated + * @description Whether to return deleted or undeleted datasets only. Leave unset for both. + */ + deleted?: boolean | null; + /** + * @deprecated + * @description Whether to return visible or hidden datasets only. Leave unset for both. + */ + visible?: boolean | null; + /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ + shareable?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ q?: string[] | null; /** @description The value to filter by. */ @@ -18256,55 +25510,58 @@ export interface operations { order?: string | null; }; header?: { + /** @description Accept header to determine the response format. Default is 'application/json'. */ + accept?: "application/json" | "application/vnd.galaxy.history.contents.stats+json"; /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The name that the Archive will have (defaults to history name). */ - filename: string; - /** - * @deprecated - * @description Output format of the archive. - */ - format: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The contents of the history that match the query. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["HistoryContentsResult"]; + "application/vnd.galaxy.history.contents.stats+json": components["schemas"]["HistoryContentsWithStatsResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Executes an operation on a set of items contained in the given History. - * @description Executes an operation on a set of items contained in the given History. - * - * The items to be processed can be explicitly set or determined by a dynamic query. - */ - bulk_operation_api_histories__history_id__contents_bulk_put: { + history_contents__create_typed: { parameters: { query?: { - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ @@ -18313,112 +25570,132 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["HistoryContentBulkOperationPayload"]; + "application/json": components["schemas"]["CreateHistoryContentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["HistoryContentBulkOperationResult"]; - }; - }; - /** @description Request Error */ - "4XX": { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + headers: { + [name: string]: unknown; }; - }; - /** @description Server Error */ - "5XX": { content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + | ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; - }; - }; - /** - * Download the content of a dataset collection as a `zip` archive. - * @description Download the content of a history dataset collection as a `zip` archive - * while maintaining approximate collection structure. - */ - history_contents__download_collection: { - parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the `HDCA`. */ - id: string; - /** @description The encoded database identifier of the History. */ - history_id: string | null; - }; - }; - responses: { - /** @description Successful Response */ - 200: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Materialize a deferred dataset into real, usable dataset. */ - materialize_dataset_api_histories__history_id__contents_datasets__id__materialize_post: { + history_contents__show: { parameters: { + query?: { + /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ + fuzzy_count?: number | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; /** @description The ID of the item (`HDA`/`HDCA`) */ id: string; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set permissions of the given history dataset to the given role ids. - * @description Set permissions of the given history dataset to the given role ids. - */ - update_permissions_api_histories__history_id__contents__dataset_id__permissions_put: { + history_contents__update_typed: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -18427,141 +25704,189 @@ export interface operations { /** @description The encoded database identifier of the History. */ history_id: string; /** @description The ID of the item (`HDA`/`HDCA`) */ - dataset_id: string; + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": - | components["schemas"]["UpdateDatasetPermissionsPayload"] - | components["schemas"]["UpdateDatasetPermissionsPayloadAliasB"] - | components["schemas"]["UpdateDatasetPermissionsPayloadAliasC"]; + "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetAssociationRoles"]; + "application/json": + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays (preview) or downloads dataset content. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - history_contents_display_api_histories__history_id__contents__history_content_id__display_get: { + history_contents__delete_typed: { parameters: { query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; + /** + * @deprecated + * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. + */ + purge?: boolean | null; + /** + * @deprecated + * @description When deleting a dataset collection, whether to also delete containing datasets. + */ + recursive?: boolean | null; + /** + * @deprecated + * @description Whether to stop the creating job if all outputs of the job have been deleted. + */ + stop_job?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description Request has been executed. */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; + }; + /** @description Request accepted, processing will finish later. */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["DeleteHistoryContentResult"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Check if dataset content can be previewed or downloaded. - * @description Streams the dataset for download or the contents preview to be displayed in a browser. - */ - history_contents_display_api_histories__history_id__contents__history_content_id__display_head: { + show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { parameters: { - query?: { - /** @description Whether to get preview contents to be directly displayed on the web. If preview is False (default) the contents will be downloaded instead. */ - preview?: boolean; - /** @description If non-null, get the specified filename from the extra files for this dataset. */ - filename?: string | null; - /** @description The file extension when downloading the display data. Use the value `data` to let the server infer it from the data type. */ - to_ext?: string | null; - /** @description The query parameter 'raw' should be considered experimental and may be dropped at some point in the future without warning. Generally, data should be processed by its datatype prior to display. */ - raw?: boolean; - /** @description Set this for datatypes that allow chunked display through the display_data method to enable chunking. This specifies a byte offset into the target dataset's display. */ - offset?: number | null; - /** @description If offset is set, this recommends 'how large' the next chunk should be. This is not respected or interpreted uniformly and should be interpreted as a very loose recommendation. Different datatypes interpret 'largeness' differently - for bam datasets this is a number of lines whereas for tabular datatypes this is interpreted as a number of bytes. */ - ck_size?: number | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the History Dataset. */ - history_content_id: string; - history_id: string | null; + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of extra files/directories associated with a dataset. */ - extra_files_history_api_histories__history_id__contents__history_content_id__extra_files_get: { + prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -18569,38 +25894,51 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DatasetExtraFiles"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns the metadata file associated with this history item. */ - history_contents__get_metadata_file: { + write_store_api_histories__history_id__contents__type_s__id__write_store_post: { parameters: { - query: { - /** @description The name of the metadata file to retrieve. */ - metadata_file: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -18608,353 +25946,401 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the History Dataset. */ - history_content_id: string; + /** @description The ID of the item (`HDA`/`HDCA`) */ + id: string; + /** @description The type of the target history element. */ + type: components["schemas"]["HistoryContentType"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteStoreToPayload"]; }; }; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tags based on history_content_id */ - index_api_histories__history_id__contents__history_content_id__tags_get: { + create_from_store_api_histories__history_id__contents_from_store_post: { parameters: { + query?: { + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Comma-separated list of keys to be passed to the serializer */ + keys?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_content_id: string; + /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateHistoryContentFromStore"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; + "application/json": ( + | components["schemas"]["HDACustom"] + | components["schemas"]["HDADetailed"] + | components["schemas"]["HDASummary"] + | components["schemas"]["HDAInaccessible"] + | components["schemas"]["HDCACustom"] + | components["schemas"]["HDCADetailed"] + | components["schemas"]["HDCASummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tag based on history_content_id */ - show_api_histories__history_id__contents__history_content_id__tags__tag_name__get: { + get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update tag based on history_content_id */ - update_api_histories__history_id__contents__history_content_id__tags__tag_name__put: { + disable_link_access_api_histories__history_id__disable_link_access_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create tag based on history_content_id */ - create_api_histories__history_id__contents__history_content_id__tags__tag_name__post: { + enable_link_access_api_histories__history_id__enable_link_access_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete tag based on history_content_id */ - delete_api_histories__history_id__contents__history_content_id__tags__tag_name__delete: { + get_history_exports_api_histories__history_id__exports_get: { parameters: { + query?: { + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + }; header?: { + /** @description Accept header to determine the response format. Default is 'application/json'. */ + accept?: "application/json" | "application/vnd.galaxy.task.export+json"; /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_content_id: string; - tag_name: string; + /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list of history exports */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": boolean; + "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; + "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return detailed information about an HDA within a history. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - history_contents__show_legacy: { + archive_export_api_histories__history_id__exports_put: { parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ - fuzzy_count?: number | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; + }; }; responses: { - /** @description Successful Response */ + /** @description Object containing url to fetch export from. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + | components["schemas"]["JobExportHistoryArchiveModel"] + | components["schemas"]["JobIdResponse"]; + }; + }; + /** @description The exported archive file is not ready yet. */ + 202: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the values for the history content item with the given ``ID`` and query specified type. ``/api/histories/{history_id}/contents/{type}s/{id}`` should be used instead. - * @deprecated - * @description Updates the values for the history content item with the given ``ID``. - */ - history_contents__update_legacy: { + history_archive_download_api_histories__history_id__exports__jeha_id__get: { parameters: { - query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; + path: { + /** @description The encoded database identifier of the History. */ + history_id: string; + /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ + jeha_id: string | "latest"; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The archive file containing the History. */ 200: { - content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Delete the history dataset with the given ``ID``. - * @description Delete the history content with the given ``ID`` and query specified type (defaults to dataset). - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ - history_contents__delete_legacy: { + index_jobs_summary_api_histories__history_id__jobs_summary_get: { parameters: { query?: { - /** @description The type of the target history element. */ - type?: components["schemas"]["HistoryContentType"]; - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; + /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ + ids?: string | null; + /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ + types?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ @@ -18963,48 +26349,47 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Request has been executed. */ + /** @description Successful Response */ 200: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + headers: { + [name: string]: unknown; }; - }; - /** @description Request accepted, processing will finish later. */ - 202: { content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + "application/json": ( + | components["schemas"]["JobStateSummary"] + | components["schemas"]["ImplicitCollectionJobsStateSummary"] + | components["schemas"]["WorkflowInvocationStateSummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Validates the metadata associated with a dataset within a History. - * @description Validates the metadata associated with a dataset within a History. - */ - validate_api_histories__history_id__contents__id__validate_put: { + materialize_to_history_api_histories__history_id__materialize_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19012,87 +26397,47 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": Record; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the contents of the given history filtered by type. - * @description Return a list of either `HDA`/`HDCA` data for the history with the given ``ID``. - * - * - The contents can be filtered and queried using the appropriate parameters. - * - The amount of information returned for each item can be customized. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - history_contents__index_typed: { + prepare_store_download_api_histories__history_id__prepare_store_download_post: { parameters: { - query?: { - /** @description Only `dev` value is allowed. Set it to use the latest version of this endpoint. **All parameters marked as `deprecated` will be ignored when this parameter is set.** */ - v?: string | null; - /** - * @deprecated - * @description Legacy name for the `dataset_details` parameter. - */ - details?: string | null; - /** - * @deprecated - * @description A comma-separated list of encoded `HDA/HDCA` IDs. If this list is provided, only information about the specific datasets will be returned. Also, setting this value will return `all` details of the content item. - */ - ids?: string | null; - /** - * @deprecated - * @description A list or comma-separated list of kinds of contents to return (currently just `dataset` and `dataset_collection` are available). If unset, all types will be returned. - */ - types?: string[] | null; - /** - * @deprecated - * @description Whether to return deleted or undeleted datasets only. Leave unset for both. - */ - deleted?: boolean | null; - /** - * @deprecated - * @description Whether to return visible or hidden datasets only. Leave unset for both. - */ - visible?: boolean | null; - /** @description Whether to return only shareable or not shareable datasets. Leave unset for both. */ - shareable?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - /** @description Generally a property name to filter by followed by an (often optional) hyphen and operator string. */ - q?: string[] | null; - /** @description The value to filter by. */ - qv?: string[] | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed (optionally) by '-asc' or '-dsc' for ascending and descending order respectively. Orders can be stacked as a comma-separated list of values. */ - order?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19100,45 +26445,47 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["StoreExportPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HistoryContentsResult"] - | components["schemas"]["HistoryContentsWithStatsResult"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a new `HDA` or `HDCA` in the given History. - * @description Create a new `HDA` or `HDCA` in the given History. - */ - history_contents__create_typed: { + publish_api_histories__history_id__publish_put: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19146,118 +26493,91 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateHistoryContentPayload"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - | ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return detailed information about a specific HDA or HDCA with the given `ID` within a history. - * @description Return detailed information about an `HDA` or `HDCA` within a history. - * - * **Note**: Anonymous users are allowed to get their current history contents. - */ - history_contents__show: { + share_with_users_api_histories__history_id__share_with_users_put: { parameters: { - query?: { - /** @description This value can be used to broadly restrict the magnitude of the number of elements returned via the API for large collections. The number of actual elements returned may be "a bit" more than this number or "a lot" less - varying on the depth of nesting, balance of nesting at each level, and size of target collection. The consumer of this API should not expect a stable number or pre-calculable number of elements to be produced given this parameter - the only promise is that this API will not respond with an order of magnitude more elements estimated with this value. The UI uses this parameter to fetch a "balanced" concept of the "start" of large collections at every depth of the collection. */ - fuzzy_count?: number | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["ShareHistoryWithStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the values for the history content item with the given ``ID`` and path specified type. - * @description Updates the values for the history content item with the given ``ID``. - */ - history_contents__update_typed: { + sharing_api_histories__history_id__sharing_get: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19265,73 +26585,43 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateHistoryContentsPayload"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; - }; - }; - /** - * Delete the history content with the given ``ID`` and path specified type. - * @description Delete the history content with the given ``ID`` and path specified type. - * - * **Note**: Currently does not stop any active jobs for which this dataset is an output. - */ - history_contents__delete_typed: { - parameters: { - query?: { - /** - * @deprecated - * @description Whether to remove from disk the target HDA or child HDAs of the target HDCA. - */ - purge?: boolean | null; - /** - * @deprecated - * @description When deleting a dataset collection, whether to also delete containing datasets. - */ - recursive?: boolean | null; - /** - * @deprecated - * @description Whether to stop the creating job if all outputs of the job have been deleted. - */ - stop_job?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + }; + }; + set_slug_api_histories__history_id__slug_put: { + parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19339,272 +26629,272 @@ export interface operations { path: { /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["DeleteHistoryContentPayload"]; + "application/json": components["schemas"]["SetSlugPayload"]; }; }; responses: { - /** @description Request has been executed. */ - 200: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; - }; - }; - /** @description Request accepted, processing will finish later. */ - 202: { - content: { - "application/json": components["schemas"]["DeleteHistoryContentResult"]; + /** @description Successful Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return detailed information about an `HDA` or `HDCAs` jobs. - * @description Return detailed information about an `HDA` or `HDCAs` jobs. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - show_jobs_summary_api_histories__history_id__contents__type_s__id__jobs_summary_get: { + index_api_histories__history_id__tags_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"]; + "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a dataset or dataset collection for export-style download. */ - prepare_store_download_api_histories__history_id__contents__type_s__id__prepare_store_download_post: { + show_api_histories__history_id__tags__tag_name__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["StoreExportPayload"]; + tag_name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a dataset or dataset collection for export-style download and write to supplied URI. */ - write_store_api_histories__history_id__contents__type_s__id__write_store_post: { + update_api_histories__history_id__tags__tag_name__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; - /** @description The ID of the item (`HDA`/`HDCA`) */ - id: string; - /** @description The type of the target history element. */ - type: components["schemas"]["HistoryContentType"]; + tag_name: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create contents from store. - * @description Create history contents from model store. - * Input can be a tarfile created with build_objects script distributed - * with galaxy-data, from an exported history with files stripped out, - * or hand-crafted JSON dictionary. - */ - create_from_store_api_histories__history_id__contents_from_store_post: { + create_api_histories__history_id__tags__tag_name__post: { parameters: { - query?: { - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Comma-separated list of keys to be passed to the serializer */ - keys?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; + tag_name: string; }; + cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["CreateHistoryContentFromStore"]; + "application/json": components["schemas"]["ItemTagsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["HDACustom"] - | components["schemas"]["HDADetailed"] - | components["schemas"]["HDASummary"] - | components["schemas"]["HDAInaccessible"] - | components["schemas"]["HDCADetailed"] - | components["schemas"]["HDCASummary"] - )[]; + "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns meta data for custom builds. */ - get_custom_builds_metadata_api_histories__history_id__custom_builds_metadata_get: { + delete_api_histories__history_id__tags__tag_name__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ history_id: string; + tag_name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CustomBuildsMetadataResponse"]; + "application/json": boolean; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - disable_link_access_api_histories__history_id__disable_link_access_put: { + unpublish_api_histories__history_id__unpublish_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19613,34 +26903,42 @@ export interface operations { /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - enable_link_access_api_histories__history_id__enable_link_access_put: { + write_store_api_histories__history_id__write_store_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -19649,3232 +26947,3926 @@ export interface operations { /** @description The encoded database identifier of the History. */ history_id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteStoreToPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get previous history exports. - * @description By default the legacy job-based history exports (jeha) are returned. - * - * Change the `accept` content type header to return the new task-based history exports. - */ - get_history_exports_api_histories__history_id__exports_get: { + index_invocations_api_invocations_get: { parameters: { query?: { - /** @description The maximum number of items to return. */ + /** @description Return only invocations for this Workflow ID */ + workflow_id?: string | null; + /** @description Return only invocations for this History ID */ + history_id?: string | null; + /** @description Return only invocations for this Job ID */ + job_id?: string | null; + /** @description Return invocations for this User ID. */ + user_id?: string | null; + /** @description Sort Workflow Invocations by this attribute */ + sort_by?: components["schemas"]["InvocationSortByEnum"] | null; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description Set to false to only include terminal Invocations. */ + include_terminal?: boolean | null; + /** @description Limit the number of invocations to return. */ limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + /** @description Number of invocations to skip. */ offset?: number | null; + /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ + instance?: boolean | null; + /** @description View to be passed to the serializer */ + view?: string | null; + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + include_nested_invocations?: boolean; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list of history exports */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobExportHistoryArchiveListResponse"]; - "application/vnd.galaxy.task.export+json": components["schemas"]["ExportTaskListResponse"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Start job (if needed) to create history export for corresponding history. - * @deprecated - * @description This will start a job to create a history export archive. - * - * Calling this endpoint multiple times will return the 202 status code until the archive - * has been completely generated and is ready to download. When ready, it will return - * the 200 status code along with the download link information. - * - * If the history will be exported to a `directory_uri`, instead of returning the download - * link information, the Job ID will be returned so it can be queried to determine when - * the file has been written. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ - archive_export_api_histories__history_id__exports_put: { + create_invocations_from_store_api_invocations_from_store_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; + path?: never; + cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["ExportHistoryArchivePayload"] | null; + "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; }; }; responses: { - /** @description Object containing url to fetch export from. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["JobExportHistoryArchiveModel"] - | components["schemas"]["JobIdResponse"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; - /** @description The exported archive file is not ready yet. */ - 202: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * If ready and available, return raw contents of exported history as a downloadable archive. - * @deprecated - * @description See ``PUT /api/histories/{id}/exports`` to initiate the creation - * of the history export - when ready, that route will return 200 status - * code (instead of 202) and this route can be used to download the archive. - * - * **Deprecation notice**: Please use `/api/histories/{id}/prepare_store_download` or - * `/api/histories/{id}/write_store` instead. - */ - history_archive_download_api_histories__history_id__exports__jeha_id__get: { + step_api_invocations_steps__step_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - /** @description The ID of the specific Job Export History Association or `latest` (default) to download the last generated archive. */ - jeha_id: string | "latest"; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The archive file containing the History. */ + /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["InvocationStep"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * @description Return job state summary info for jobs, implicit groups jobs for collections or workflow invocations. - * - * **Warning**: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - index_jobs_summary_api_histories__history_id__jobs_summary_get: { + show_invocation_api_invocations__invocation_id__get: { parameters: { query?: { - /** @description A comma-separated list of encoded ids of job summary objects to return - if `ids` is specified types must also be specified and have same length. */ - ids?: string | null; - /** @description A comma-separated list of type of object represented by elements in the `ids` array - any of `Job`, `ImplicitCollectionJob`, or `WorkflowInvocation`. */ - types?: string | null; + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. */ + legacy_job_state?: boolean; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["JobStateSummary"] - | components["schemas"]["ImplicitCollectionJobsStateSummary"] - | components["schemas"]["WorkflowInvocationStateSummary"] - )[]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Materialize a deferred library or HDA dataset into real, usable dataset in specified history. */ - materialize_to_history_api_histories__history_id__materialize_post: { + cancel_invocation_api_invocations__invocation_id__delete: { parameters: { + query?: { + /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ + step_details?: boolean; + /** @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. */ + legacy_job_state?: boolean; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["MaterializeDatasetInstanceAPIRequest"]; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return a short term storage token to monitor download of the history. */ - prepare_store_download_api_histories__history_id__prepare_store_download_post: { + invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["StoreExportPayload"]; + path: { + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - publish_api_histories__history_id__publish_put: { + get_invocation_metrics_api_invocations__invocation_id__metrics_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["WorkflowJobMetric"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ - share_with_users_api_histories__history_id__share_with_users_put: { + prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["ShareWithPayload"]; + "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ShareHistoryWithStatus"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ - sharing_api_histories__history_id__sharing_get: { + show_invocation_report_api_invocations__invocation_id__report_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["InvocationReport"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - set_slug_api_histories__history_id__slug_put: { + show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["SetSlugPayload"]; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tags based on history_id */ - index_api_histories__history_id__tags_get: { + invocation_as_request_api_invocations__invocation_id__request_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_id: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsListResponse"]; + "application/json": components["schemas"]["WorkflowInvocationRequestModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tag based on history_id */ - show_api_histories__history_id__tags__tag_name__get: { + invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": ( + | components["schemas"]["InvocationStepJobsResponseStepModel"] + | components["schemas"]["InvocationStepJobsResponseJobModel"] + | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update tag based on history_id */ - update_api_histories__history_id__tags__tag_name__put: { + invocation_step_api_invocations__invocation_id__steps__step_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create tag based on history_id */ - create_api_histories__history_id__tags__tag_name__post: { + update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + /** @description The encoded database identifier of the WorkflowInvocationStep. */ + step_id: string; }; + cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["ItemTagsCreatePayload"]; + "application/json": components["schemas"]["InvocationUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ItemTagsResponse"]; + "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete tag based on history_id */ - delete_api_histories__history_id__tags__tag_name__delete: { + write_store_api_invocations__invocation_id__write_store_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - history_id: string; - tag_name: string; + /** @description The encoded database identifier of the Invocation. */ + invocation_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": boolean; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - unpublish_api_histories__history_id__unpublish_put: { + job_lock_status_api_job_lock_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["JobLock"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare history for export-style download and write to supplied URI. */ - write_store_api_histories__history_id__write_store_post: { + update_job_lock_api_job_lock_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the History. */ - history_id: string; - }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["WriteStoreToPayload"]; + "application/json": components["schemas"]["JobLock"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["JobLock"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of a user's workflow invocations. */ - index_invocations_api_invocations_get: { + index_api_jobs_get: { parameters: { query?: { - /** @description Return only invocations for this Workflow ID */ - workflow_id?: string | null; - /** @description Return only invocations for this History ID */ - history_id?: string | null; - /** @description Return only invocations for this Job ID */ - job_id?: string | null; - /** @description Return invocations for this User ID. */ + /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ + user_details?: boolean; + /** @description an encoded user id to restrict query to, must be own id if not admin user */ user_id?: string | null; - /** @description Sort Workflow Invocations by this attribute */ - sort_by?: components["schemas"]["InvocationSortByEnum"] | null; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** @description Set to false to only include terminal Invocations. */ - include_terminal?: boolean | null; - /** @description Limit the number of invocations to return. */ - limit?: number | null; - /** @description Number of invocations to skip. */ - offset?: number | null; - /** @description Is provided workflow id for Workflow instead of StoredWorkflow? */ - instance?: boolean | null; - /** @description View to be passed to the serializer */ - view?: string | null; - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - include_nested_invocations?: boolean; + /** @description Determines columns to return. Defaults to 'collection'. */ + view?: components["schemas"]["JobIndexViewEnum"]; + /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ + date_range_min?: string | null; + /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ + date_range_max?: string | null; + /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ + history_id?: string | null; + /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ + workflow_id?: string | null; + /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ + invocation_id?: string | null; + /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ + implicit_collection_jobs_id?: string | null; + /** @description Sort results by specified field. */ + order_by?: components["schemas"]["JobIndexSortByEnum"]; + /** @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `user` + * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tool_id` + * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `runner` + * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * `handler` + * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Jobs: `user`, `tool`, `handler`, `runner`. + * + * */ + search?: string | null; + /** @description Maximum number of jobs to return. */ + limit?: number; + /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ + offset?: number; + /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ + state?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ + tool_id?: string[] | null; + /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ + tool_id_like?: string[] | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": ( + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"] + | components["schemas"]["JobSummary"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create Invocations From Store - * @description Create invocation(s) from a supplied model store. - */ - create_invocations_from_store_api_invocations_from_store_post: { + search_jobs_api_jobs_search_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateInvocationsFromStorePayload"]; + "application/json": components["schemas"]["SearchJobsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"][]; + "application/json": components["schemas"]["EncodedJobDetails"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show details of workflow invocation step. */ - step_api_invocations_steps__step_id__get: { + show_job_api_jobs__job_id__get: { parameters: { + query?: { + /** @description Show extra information. */ + full?: boolean | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": + | components["schemas"]["ShowFullJobResponse"] + | components["schemas"]["EncodedJobDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get detailed description of a workflow invocation. */ - show_invocation_api_invocations__invocation_id__get: { + cancel_job_api_jobs__job_id__delete: { parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the job */ + job_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteJobPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": boolean; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Cancel the specified workflow invocation. */ - cancel_invocation_api_invocations__invocation_id__delete: { + check_common_problems_api_jobs__job_id__common_problems_get: { parameters: { - query?: { - /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ - step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ - legacy_job_state?: boolean; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["WorkflowInvocationResponse"]; + "application/json": components["schemas"]["JobInputSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - invocation_jobs_summary_api_invocations__invocation_id__jobs_summary_get: { + get_console_output_api_jobs__job_id__console_output_get: { parameters: { + query: { + stdout_position: number; + stdout_length: number; + stderr_position: number; + stderr_length: number; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InvocationJobsResponse"]; + "application/json": components["schemas"]["JobConsoleOutput"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a workflow invocation export-style download. */ - prepare_store_download_api_invocations__invocation_id__prepare_store_download_post: { + destination_params_job_api_jobs__job_id__destination_params_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["PrepareStoreDownloadPayload"]; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["JobDestinationParams"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get JSON summarizing invocation for reporting. */ - show_invocation_report_api_invocations__invocation_id__report_get: { + report_error_api_jobs__job_id__error_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the job */ + job_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ReportJobErrorPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InvocationReport"]; + "application/json": components["schemas"]["JobErrorSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get PDF summarizing invocation for reporting. */ - show_invocation_report_pdf_api_invocations__invocation_id__report_pdf_get: { + get_inputs_api_jobs__job_id__inputs_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["JobInputAssociation"][]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description Warning: We allow anyone to fetch job state information about any object they - * can guess an encoded ID for - it isn't considered protected data. This keeps - * polling IDs as part of state calculation for large histories and collections as - * efficient as possible. - */ - invocation_step_jobs_summary_api_invocations__invocation_id__step_jobs_summary_get: { + get_metrics_api_jobs__job_id__metrics_get: { parameters: { + query?: { + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["InvocationStepJobsResponseStepModel"] - | components["schemas"]["InvocationStepJobsResponseJobModel"] - | components["schemas"]["InvocationStepJobsResponseCollectionJobsModel"] - )[]; + "application/json": (components["schemas"]["JobMetric"] | null)[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/steps/{step_id}`. `invocation_id` is ignored. - */ - invocation_step_api_invocations__invocation_id__steps__step_id__get: { + get_token_api_jobs__job_id__oidc_tokens_get: { parameters: { + query: { + /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ + job_key: string; + /** @description OIDC provider name */ + provider: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InvocationStep"]; + "text/plain": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + "text/plain": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update state of running workflow step invocation - still very nebulous but this would be for stuff like confirming paused steps can proceed etc. */ - update_invocation_step_api_invocations__invocation_id__steps__step_id__put: { + get_outputs_api_jobs__job_id__outputs_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - /** @description The encoded database identifier of the WorkflowInvocationStep. */ - step_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["InvocationUpdatePayload"]; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InvocationStep"]; + "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Prepare a workflow invocation export-style download and write to supplied URI. */ - write_store_api_invocations__invocation_id__write_store_post: { + resolve_parameters_display_api_jobs__job_id__parameters_display_get: { parameters: { + query?: { + /** + * @deprecated + * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). + */ + hda_ldda?: components["schemas"]["DatasetSourceType"] | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Invocation. */ - invocation_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["WriteInvocationStoreToPayload"]; + /** @description The ID of the job */ + job_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["JobDisplayParametersSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Job Lock Status - * @description Get job lock status. - */ - job_lock_status_api_job_lock_get: { + resume_paused_job_api_jobs__job_id__resume_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the job */ + job_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["JobOutputAssociation"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update Job Lock - * @description Set job lock status. - */ - update_job_lock_api_job_lock_put: { + index_api_libraries_get: { parameters: { + query?: { + /** @description Whether to include deleted libraries in the result. */ + deleted?: boolean | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["JobLock"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobLock"]; + "application/json": components["schemas"]["LibrarySummaryList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Index */ - index_api_jobs_get: { + create_api_libraries_post: { parameters: { - query?: { - /** @description If true, and requester is an admin, will return external job id and user email. This is only available to admins. */ - user_details?: boolean; - /** @description an encoded user id to restrict query to, must be own id if not admin user */ - user_id?: string | null; - /** @description Determines columns to return. Defaults to 'collection'. */ - view?: components["schemas"]["JobIndexViewEnum"]; - /** @description Limit listing of jobs to those that are updated after specified date (e.g. '2014-01-01') */ - date_range_min?: string | null; - /** @description Limit listing of jobs to those that are updated before specified date (e.g. '2014-01-01') */ - date_range_max?: string | null; - /** @description Limit listing of jobs to those that match the history_id. If none, jobs from any history may be returned. */ - history_id?: string | null; - /** @description Limit listing of jobs to those that match the specified workflow ID. If none, jobs from any workflow (or from no workflows) may be returned. */ - workflow_id?: string | null; - /** @description Limit listing of jobs to those that match the specified workflow invocation ID. If none, jobs from any workflow invocation (or from no workflows) may be returned. */ - invocation_id?: string | null; - /** @description Limit listing of jobs to those that match the specified implicit collection job ID. If none, jobs from any implicit collection execution (or from no implicit collection execution) may be returned. */ - implicit_collection_jobs_id?: string | null; - /** @description Sort results by specified field. */ - order_by?: components["schemas"]["JobIndexSortByEnum"]; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `user` - * : The user email of the user that executed the Job. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tool_id` - * : The tool ID corresponding to the job. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `runner` - * : The job runner name used to execute the job. (The tag `r` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * `handler` - * : The job handler name used to execute the job. (The tag `h` can be used a short hand alias for this tag to filter on this attribute.) This tag is only available for requests using admin keys and/or sessions. - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Jobs: `user`, `tool`, `handler`, `runner`. - */ - search?: string | null; - /** @description Maximum number of jobs to return. */ - limit?: number; - /** @description Return jobs starting from this specified position. For example, if ``limit`` is set to 100 and ``offset`` to 200, jobs 200-299 will be returned. */ - offset?: number; - /** @description A list or comma-separated list of states to filter job query on. If unspecified, jobs of any state may be returned. */ - state?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool_ids. If none, all are returned */ - tool_id?: string[] | null; - /** @description Limit listing of jobs to those that match one of the included tool ID sql-like patterns. If none, all are returned */ - tool_id_like?: string[] | null; + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateLibraryPayload"]; + }; + }; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["LibrarySummary"]; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + index_deleted_api_libraries_deleted_get: { + parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"] - | components["schemas"]["JobSummary"] - )[]; + "application/json": components["schemas"]["LibrarySummaryList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return jobs for current user - * @description This method is designed to scan the list of previously run jobs and find records of jobs that had - * the exact some input parameters and datasets. This can be used to minimize the amount of repeated work, and simply - * recycle the old results. - */ - search_jobs_api_jobs_search_post: { + create_from_store_api_libraries_from_store_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["SearchJobsPayload"]; + "application/json": components["schemas"]["CreateLibrariesFromStore"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["EncodedJobDetails"][]; + "application/json": components["schemas"]["LibrarySummary"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return dictionary containing description of job data. */ - show_job_api_jobs__job_id__get: { + show_api_libraries__id__get: { parameters: { - query?: { - /** @description Show extra information. */ - full?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["ShowFullJobResponse"] - | components["schemas"]["EncodedJobDetails"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Cancels specified job */ - cancel_job_api_jobs__job_id__delete: { + delete_api_libraries__id__delete: { parameters: { + query?: { + /** @description Whether to restore a deleted library. */ + undelete?: boolean | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; }; + cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["DeleteJobPayload"] | null; + "application/json": components["schemas"]["DeleteLibraryPayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": boolean; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Check inputs and job for common potential problems to aid in error reporting */ - check_common_problems_api_jobs__job_id__common_problems_get: { + update_api_libraries__id__patch: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateLibraryPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobInputSummary"]; + "application/json": components["schemas"]["LibrarySummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return destination parameters for specified job. */ - destination_params_job_api_jobs__job_id__destination_params_get: { + get_permissions_api_libraries__id__permissions_get: { parameters: { + query?: { + /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ + scope?: components["schemas"]["LibraryPermissionScope"] | null; + /** @description Indicates whether the roles available for the library access are requested. */ + is_library_access?: boolean | null; + /** @description The page number to retrieve when paginating the available roles. */ + page?: number; + /** @description The maximum number of permissions per page when paginating. */ + page_limit?: number; + /** @description Optional search text to retrieve only the roles matching this query. */ + q?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobDestinationParams"]; + "application/json": + | components["schemas"]["LibraryCurrentPermissions"] + | components["schemas"]["LibraryAvailablePermissions"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Submits a bug report via the API. */ - report_error_api_jobs__job_id__error_post: { + set_permissions_api_libraries__id__permissions_post: { parameters: { + query?: { + /** @description Indicates what action should be performed on the Library. */ + action?: components["schemas"]["LibraryPermissionAction"] | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + /** @description The ID of the Library. */ + id: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["ReportJobErrorPayload"]; + "application/json": + | components["schemas"]["LibraryPermissionsPayload"] + | components["schemas"]["LegacyLibraryPermissionsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobErrorSummary"]; + "application/json": + | components["schemas"]["LibraryLegacySummary"] + | components["schemas"]["LibraryCurrentPermissions"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns input datasets created by a job. */ - get_inputs_api_jobs__job_id__inputs_get: { + index_api_libraries__library_id__contents_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + library_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobInputAssociation"][]; + "application/json": components["schemas"]["LibraryContentsIndexListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return job metrics for specified job. */ - get_metrics_api_jobs__job_id__metrics_get: { + create_form_api_libraries__library_id__contents_post: { parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + library_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "multipart/form-data": components["schemas"]["Body_create_form_api_libraries__library_id__contents_post"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": (components["schemas"]["JobMetric"] | null)[]; + "application/json": + | components["schemas"]["LibraryContentsCreateFolderListResponse"] + | components["schemas"]["LibraryContentsCreateFileListResponse"] + | components["schemas"]["LibraryContentsCreateDatasetCollectionResponse"] + | components["schemas"]["LibraryContentsCreateDatasetResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get a fresh OIDC token - * @description Allows remote job running mechanisms to get a fresh OIDC token that can be used on remote side to authorize user. It is not meant to represent part of Galaxy's stable, user facing API - */ - get_token_api_jobs__job_id__oidc_tokens_get: { + library_content_api_libraries__library_id__contents__id__get: { parameters: { - query: { - /** @description A key used to authenticate this request as acting on behalf or a job runner for the specified job */ - job_key: string; - /** @description OIDC provider name */ - provider: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - job_id: string; + library_id: string; + /** @example F0123456789ABCDEF */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "text/plain": string; + "application/json": + | components["schemas"]["LibraryContentsShowFolderResponse"] + | components["schemas"]["LibraryContentsShowDatasetResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { - "text/plain": components["schemas"]["MessageExceptionModel"]; + "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns output datasets created by a job. */ - get_outputs_api_jobs__job_id__outputs_get: { + update_api_libraries__library_id__contents__id__put: { parameters: { + query: { + payload: unknown; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + library_id: string; + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Resolve parameters as a list for nested display. - * @description Resolve parameters as a list for nested display. - * This API endpoint is unstable and tied heavily to Galaxy's JS client code, - * this endpoint will change frequently. - */ - resolve_parameters_display_api_jobs__job_id__parameters_display_get: { + delete_api_libraries__library_id__contents__id__delete: { parameters: { - query?: { - /** - * @deprecated - * @description Whether this dataset belongs to a history (HDA) or a library (LDDA). - */ - hda_ldda?: components["schemas"]["DatasetSourceType"] | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the job */ - job_id: string; + library_id: string; + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["LibraryContentsDeletePayload"] | null; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobDisplayParametersSummary"]; + "application/json": components["schemas"]["LibraryContentsDeleteResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Resumes a paused job. */ - resume_paused_job_api_jobs__job_id__resume_put: { + index_api_licenses_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the job */ - job_id: string; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description List of SPDX licenses */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["JobOutputAssociation"][]; + "application/json": components["schemas"]["LicenseMetadataModel"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a list of summary data for all libraries. - * @description Returns a list of summary data for all libraries. - */ - index_api_libraries_get: { + get_api_licenses__id__get: { parameters: { - query?: { - /** @description Whether to include deleted libraries in the result. */ - deleted?: boolean | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; + query?: never; + header?: never; + path: { + /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ + id: unknown; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description SPDX license metadata */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummaryList"]; + "application/json": components["schemas"]["LicenseMetadataModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new library and returns its summary information. - * @description Creates a new library and returns its summary information. Currently, only admin users can create libraries. - */ - create_api_libraries_post: { + create_api_metrics_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateLibraryPayload"]; + "application/json": components["schemas"]["CreateMetricsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns a list of summary data for all libraries marked as deleted. - * @description Returns a list of summary data for all libraries marked as deleted. - */ - index_deleted_api_libraries_deleted_get: { + get_user_notifications_api_notifications_get: { parameters: { + query?: { + limit?: number | null; + offset?: number | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummaryList"]; + "application/json": components["schemas"]["UserNotificationListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create libraries from a model store. */ - create_from_store_api_libraries_from_store_post: { + update_user_notifications_api_notifications_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["CreateLibrariesFromStore"]; + "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummary"][]; + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns summary information about a particular library. - * @description Returns summary information about a particular library. - */ - show_api_libraries__id__get: { + send_notification_api_notifications_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationCreateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": + | components["schemas"]["NotificationCreatedResponse"] + | components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Marks the specified library as deleted (or undeleted). - * @description Marks the specified library as deleted (or undeleted). - * Currently, only admin users can delete or restore libraries. - */ - delete_api_libraries__id__delete: { + delete_user_notifications_api_notifications_delete: { parameters: { - query?: { - /** @description Whether to restore a deleted library. */ - undelete?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; - }; + path?: never; + cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["DeleteLibraryPayload"] | null; + "application/json": components["schemas"]["NotificationsBatchRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the information of an existing library. - * @description Updates the information of an existing library. - */ - update_api_libraries__id__patch: { + get_all_broadcasted_api_notifications_broadcast_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["UpdateLibraryPayload"]; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["LibrarySummary"]; + "application/json": components["schemas"]["BroadcastNotificationListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Gets the current or available permissions of a particular library. - * @description Gets the current or available permissions of a particular library. - * The results can be paginated and additionally filtered by a query. - */ - get_permissions_api_libraries__id__permissions_get: { + broadcast_notification_api_notifications_broadcast_post: { parameters: { - query?: { - /** @description The scope of the permissions to retrieve. Either the `current` permissions or the `available`. */ - scope?: components["schemas"]["LibraryPermissionScope"] | null; - /** @description Indicates whether the roles available for the library access are requested. */ - is_library_access?: boolean | null; - /** @description The page number to retrieve when paginating the available roles. */ - page?: number; - /** @description The maximum number of permissions per page when paginating. */ - page_limit?: number; - /** @description Optional search text to retrieve only the roles matching this query. */ - q?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Library. */ - id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["LibraryCurrentPermissions"] - | components["schemas"]["LibraryAvailablePermissions"]; + "application/json": components["schemas"]["NotificationCreatedResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Sets the permissions to access and manipulate a library. - * @description Sets the permissions to access and manipulate a library. - */ - set_permissions_api_libraries__id__permissions_post: { + get_broadcasted_api_notifications_broadcast__notification_id__get: { parameters: { - query?: { - /** @description Indicates what action should be performed on the Library. */ - action?: components["schemas"]["LibraryPermissionAction"] | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Library. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["LibraryPermissionsPayload"] - | components["schemas"]["LegacyLibraryPermissionsPayload"]; + /** @description The ID of the Notification. */ + notification_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: { - "application/json": - | components["schemas"]["LibraryLegacySummary"] - | components["schemas"]["LibraryCurrentPermissions"]; - }; - }; - /** @description Request Error */ - "4XX": { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; - }; - }; - /** @description Server Error */ - "5XX": { - content: { - "application/json": components["schemas"]["MessageExceptionModel"]; + headers: { + [name: string]: unknown; }; - }; - }; - }; - /** - * Lists all available SPDX licenses - * @description Returns an index with all the available [SPDX licenses](https://spdx.org/licenses/). - */ - index_api_licenses_get: { - responses: { - /** @description List of SPDX licenses */ - 200: { content: { - "application/json": components["schemas"]["LicenseMetadataModel"][]; + "application/json": components["schemas"]["BroadcastNotificationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Gets the SPDX license metadata associated with the short identifier - * @description Returns the license metadata associated with the given - * [SPDX license short ID](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/). - */ - get_api_licenses__id__get: { + update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; path: { - /** @description The [SPDX license short identifier](https://spdx.github.io/spdx-spec/appendix-I-SPDX-license-list/) */ - id: unknown; + /** @description The ID of the Notification. */ + notification_id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; }; }; responses: { - /** @description SPDX license metadata */ - 200: { - content: { - "application/json": components["schemas"]["LicenseMetadataModel"]; + /** @description Successful Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Records a collection of metrics. - * @description Record any metrics sent and return some status object. - */ - create_api_metrics_post: { + get_notification_preferences_api_notifications_preferences_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateMetricsPayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the list of notifications associated with the user. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - * - * You can use the `limit` and `offset` parameters to paginate through the notifications. - */ - get_user_notifications_api_notifications_get: { + update_notification_preferences_api_notifications_preferences_put: { parameters: { - query?: { - limit?: number | null; - offset?: number | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserNotificationListResponse"]; + "application/json": components["schemas"]["UserNotificationPreferences"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates a list of notifications with the requested values in a single request. */ - update_user_notifications_api_notifications_put: { + get_notifications_status_api_notifications_status_get: { parameters: { + query: { + since: string; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["UserNotificationsBatchUpdateRequest"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + "application/json": components["schemas"]["NotificationStatusSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Sends a notification to a list of recipients (users, groups or roles). - * @description Sends a notification to a list of recipients (users, groups or roles). - */ - send_notification_api_notifications_post: { + show_notification_api_notifications__notification_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["NotificationCreateRequest"]; + path: { + /** @description The ID of the Notification. */ + notification_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["NotificationCreatedResponse"] - | components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["UserNotificationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Deletes a list of notifications received by the user in a single request. */ - delete_user_notifications_api_notifications_delete: { + update_user_notification_api_notifications__notification_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; + }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["NotificationsBatchRequest"]; + "application/json": components["schemas"]["UserNotificationUpdateRequest"]; }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationsBatchUpdateResponse"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns all currently active broadcasted notifications. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ - get_all_broadcasted_api_notifications_broadcast_get: { + delete_user_notification_api_notifications__notification_id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Notification. */ + notification_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["BroadcastNotificationListResponse"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Broadcasts a notification to every user in the system. - * @description Broadcasted notifications are a special kind of notification that are always accessible to all users, including anonymous users. - * They are typically used to display important information such as maintenance windows or new features. - * These notifications are displayed differently from regular notifications, usually in a banner at the top or bottom of the page. - * - * Broadcasted notifications can include action links that are displayed as buttons. - * This allows users to easily perform tasks such as filling out surveys, accepting legal agreements, or accessing new tutorials. - * - * Some key features of broadcasted notifications include: - * - They are not associated with a specific user, so they cannot be deleted or marked as read. - * - They can be scheduled to be displayed in the future or to expire after a certain time. - * - By default, broadcasted notifications are published immediately and expire six months after publication. - * - Only admins can create, edit, reschedule, or expire broadcasted notifications as needed. - */ - broadcast_notification_api_notifications_broadcast_post: { + object_stores__instances_index: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["BroadcastNotificationCreateRequest"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["NotificationCreatedResponse"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the information of a specific broadcasted notification. - * @description Only Admin users can access inactive notifications (scheduled or recently expired). - */ - get_broadcasted_api_notifications_broadcast__notification_id__get: { + object_stores__create_instance: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["BroadcastNotificationResponse"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the state of a broadcasted notification. - * @description Only Admins can update broadcasted notifications. This is useful to reschedule, edit or expire broadcasted notifications. - */ - update_broadcasted_notification_api_notifications_broadcast__notification_id__put: { + object_stores__test_new_instance_configuration: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["NotificationBroadcastUpdateRequest"]; + "application/json": components["schemas"]["CreateInstancePayload"]; }; }; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PluginStatus"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the current user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - The settings will contain all possible channels, but the client should only show the ones that are really supported by the server. - * The supported channels are returned in the `supported-channels` header. - */ - get_notification_preferences_api_notifications_preferences_get: { + object_stores__instances_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The UUID used to identify a persisted UserObjectStore object. */ + uuid: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates the user's preferences for notifications. - * @description Anonymous users cannot have notification preferences. They will receive only broadcasted notifications. - * - * - Can be used to completely enable/disable notifications for a particular type (category) - * or to enable/disable a particular channel on each category. - */ - update_notification_preferences_api_notifications_preferences_put: { + object_stores__instances_update: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The UUID used to identify a persisted UserObjectStore object. */ + uuid: string; + }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateUserNotificationPreferencesRequest"]; + "application/json": + | components["schemas"]["UpdateInstanceSecretPayload"] + | components["schemas"]["UpgradeInstancePayload"] + | components["schemas"]["UpdateInstancePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserNotificationPreferences"]; + "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Returns the current status summary of the user's notifications since a particular date. - * @description Anonymous users cannot receive personal notifications, only broadcasted notifications. - */ - get_notifications_status_api_notifications_status_get: { + object_stores__instances_purge: { parameters: { - query: { - since: string; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The UUID used to identify a persisted UserObjectStore object. */ + uuid: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["NotificationStatusSummary"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information about a notification received by the user. */ - show_notification_api_notifications__notification_id__get: { + object_stores__instances_test_instance: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description The UUID used to identify a persisted UserObjectStore object. */ + uuid: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserNotificationResponse"]; + "application/json": components["schemas"]["PluginStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates the state of a notification received by the user. */ - update_user_notification_api_notifications__notification_id__put: { + object_stores__test_instances_update: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Notification. */ - notification_id: string; + /** @description The UUID used to identify a persisted UserObjectStore object. */ + uuid: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["UserNotificationUpdateRequest"]; + "application/json": + | components["schemas"]["TestUpgradeInstancePayload"] + | components["schemas"]["TestUpdateInstancePayload"]; }; }; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["PluginStatus"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Deletes a notification received by the user. - * @description When a notification is deleted, it is not immediately removed from the database, but marked as deleted. - * - * - It will not be returned in the list of notifications, but admins can still access it as long as it is not expired. - * - It will be eventually removed from the database by a background task after the expiration time. - * - Deleted notifications will be permanently deleted when the expiration time is reached. - */ - delete_user_notification_api_notifications__notification_id__delete: { + object_stores__templates_index: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Notification. */ - notification_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ - 204: { - content: never; + /** @description A list of the configured object store templates. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a list of persisted object store instances defined by the requesting user. */ - object_stores__instances_index: { + index_api_object_stores_get: { parameters: { + query?: { + /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ + selectable?: boolean; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list of the configured object stores. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"][]; + "application/json": ( + | components["schemas"]["ConcreteObjectStoreModel"] + | components["schemas"]["UserConcreteObjectStoreModel"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a user-bound object store. */ - object_stores__create_instance: { + show_info_api_object_stores__object_store_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; + path: { + /** @description The concrete object store ID. */ + object_store_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; + "application/json": components["schemas"]["ConcreteObjectStoreModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Test payload for creating user-bound object store. */ - object_stores__test_new_instance_configuration: { + index_api_pages_get: { parameters: { + query?: { + /** @description Whether to include deleted pages in the result. */ + deleted?: boolean; + limit?: number; + offset?: number; + /** @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `title` + * : The page's title. + * + * `slug` + * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Pages: `title`, `slug`, `tag`, `user`. + * + * */ + search?: string | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + /** @description Sort page index by this specified attribute on the page model */ + sort_by?: "create_time" | "title" | "update_time" | "username"; + /** @description Sort in descending order? */ + sort_desc?: boolean; + user_id?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateInstancePayload"]; - }; - }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list with summary page information. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["PluginStatus"]; + "application/json": components["schemas"]["PageSummaryList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a persisted user object store instance. */ - object_stores__instances_get: { + create_api_pages_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The UUID used to identify a persisted UserObjectStore object. */ - user_object_store_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreatePagePayload"]; }; }; responses: { - /** @description Successful Response */ + /** @description The page summary information. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; + "application/json": components["schemas"]["PageSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update or upgrade user object store instance. */ - object_stores__instances_update: { + show_api_pages__id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The UUID used to identify a persisted UserObjectStore object. */ - user_object_store_id: string; - }; - }; - requestBody: { - content: { - "application/json": - | components["schemas"]["UpdateInstanceSecretPayload"] - | components["schemas"]["UpgradeInstancePayload"] - | components["schemas"]["UpdateInstancePayload"]; + /** @description The ID of the Page. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The page summary information. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserConcreteObjectStoreModel"]; + "application/json": components["schemas"]["PageDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purge user object store instance. */ - object_stores__instances_purge: { + delete_api_pages__id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The UUID used to identify a persisted UserObjectStore object. */ - user_object_store_id: string; + /** @description The ID of the Page. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a list of object store templates available to build user defined object stores from */ - object_stores__templates_index: { + show_pdf_api_pages__id__pdf_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list of the configured object store templates. */ + /** @description PDF document with the last revision of the page. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ObjectStoreTemplateSummaries"]; + "application/pdf": unknown; + }; + }; + /** @description PDF conversion service not available. */ + 501: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get a list of (currently only concrete) object stores configured with this Galaxy instance. */ - index_api_object_stores_get: { + disable_link_access_api_pages__id__disable_link_access_put: { parameters: { - query?: { - /** @description Restrict index query to user selectable object stores, the current implementation requires this to be true. */ - selectable?: boolean; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list of the configured object stores. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["ConcreteObjectStoreModel"] - | components["schemas"]["UserConcreteObjectStoreModel"] - )[]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get information about a concrete object store configured with Galaxy. */ - show_info_api_object_stores__object_store_id__get: { + enable_link_access_api_pages__id__enable_link_access_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The concrete object store ID. */ - object_store_id: string; + /** @description The ID of the Page. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ConcreteObjectStoreModel"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists all Pages viewable by the user. - * @description Get a list with summary information of all Pages available to the user. - */ - index_api_pages_get: { + prepare_pdf_api_pages__id__prepare_download_post: { parameters: { - query?: { - /** @description Whether to include deleted pages in the result. */ - deleted?: boolean; - limit?: number; - offset?: number; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The page's title. - * - * `slug` - * : The page's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The page's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The page's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Pages: `title`, `slug`, `tag`, `user`. - */ - search?: string | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - /** @description Sort page index by this specified attribute on the page model */ - sort_by?: "create_time" | "title" | "update_time" | "username"; - /** @description Sort in descending order? */ - sort_desc?: boolean; - user_id?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Page. */ + id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list with summary page information. */ + /** @description Short term storage reference for async monitoring of this download. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["PageSummaryList"]; + "application/json": components["schemas"]["AsyncFile"]; }; }; + /** @description PDF conversion service not available. */ + 501: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Create a page and return summary information. - * @description Get a list with details of all Pages available to the user. - */ - create_api_pages_post: { + publish_api_pages__id__publish_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreatePagePayload"]; + path: { + /** @description The ID of the Page. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The page summary information. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["PageSummary"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a page summary and the content of the last revision. - * @description Return summary information about a specific Page and the content of the last revision. - */ - show_api_pages__id__get: { + share_with_users_api_pages__id__share_with_users_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -22883,34 +30875,46 @@ export interface operations { /** @description The ID of the Page. */ id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; + }; }; responses: { - /** @description The page summary information. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["PageDetails"]; + "application/json": components["schemas"]["ShareWithStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Marks the specific Page as deleted. - * @description Marks the Page with the given ID as deleted. - */ - delete_api_pages__id__delete: { + sharing_api_pages__id__sharing_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -22919,34 +30923,42 @@ export interface operations { /** @description The ID of the Page. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["SharingStatus"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a PDF document of the last revision of the Page. - * @description Return a PDF document of the last revision of the Page. - * - * This feature may not be available in this Galaxy. - */ - show_pdf_api_pages__id__pdf_get: { + set_slug_api_pages__id__slug_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -22955,38 +30967,44 @@ export interface operations { /** @description The ID of the Page. */ id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; + }; }; responses: { - /** @description PDF document with the last revision of the page. */ - 200: { - content: { - "application/pdf": unknown; + /** @description Successful Response */ + 204: { + headers: { + [name: string]: unknown; }; - }; - /** @description PDF conversion service not available. */ - 501: { - content: never; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - disable_link_access_api_pages__id__disable_link_access_put: { + undelete_api_pages__id__undelete_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -22995,34 +31013,40 @@ export interface operations { /** @description The ID of the Page. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - enable_link_access_api_pages__id__enable_link_access_put: { + unpublish_api_pages__id__unpublish_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -23031,1977 +31055,2523 @@ export interface operations { /** @description The ID of the Page. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return a PDF document of the last revision of the Page. - * @description Return a STS download link for this page to be downloaded as a PDF. - * - * This feature may not be available in this Galaxy. - */ - prepare_pdf_api_pages__id__prepare_download_post: { + index_api_quotas_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Page. */ - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Short term storage reference for async monitoring of this download. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncFile"]; + "application/json": components["schemas"]["QuotaSummaryList"]; }; }; - /** @description PDF conversion service not available. */ - 501: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - publish_api_pages__id__publish_put: { + create_api_quotas_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Page. */ - id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateQuotaParams"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["CreateQuotaResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ - share_with_users_api_pages__id__share_with_users_put: { + index_deleted_api_quotas_deleted_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Page. */ - id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ShareWithStatus"]; + "application/json": components["schemas"]["QuotaSummaryList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given Page. - * @description Return the sharing status of the item. - */ - sharing_api_pages__id__sharing_get: { + deleted_quota_api_quotas_deleted__id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Page. */ + /** @description The ID of the Quota. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["QuotaDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - set_slug_api_pages__id__slug_put: { + undelete_api_quotas_deleted__id__undelete_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Page. */ + /** @description The ID of the Quota. */ id: string; }; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["SetSlugPayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": string; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Undelete the specific Page. - * @description Marks the Page with the given ID as undeleted. - */ - undelete_api_pages__id__undelete_put: { + quota_api_quotas__id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Page. */ + /** @description The ID of the Quota. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["QuotaDetails"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - unpublish_api_pages__id__unpublish_put: { + update_api_quotas__id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Page. */ + /** @description The ID of the Quota. */ id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["UpdateQuotaParams"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays a list with information of quotas that are currently active. - * @description Displays a list with information of quotas that are currently active. - */ - index_api_quotas_get: { + delete_api_quotas__id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the Quota. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["DeleteQuotaPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["QuotaSummaryList"]; + "application/json": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new quota. - * @description Creates a new quota. - */ - create_api_quotas_post: { + purge_api_quotas__id__purge_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateQuotaParams"]; + path: { + /** @description The ID of the Quota. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CreateQuotaResult"]; + "application/json": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays a list with information of quotas that have been deleted. - * @description Displays a list with information of quotas that have been deleted. - */ - index_deleted_api_quotas_deleted_get: { + index_api_remote_files_get: { parameters: { + query?: { + /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ + target?: string; + /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ + format?: components["schemas"]["RemoteFilesFormat"] | null; + /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ + recursive?: boolean | null; + /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ + disable?: components["schemas"]["RemoteFilesDisableMode"] | null; + /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ + writeable?: boolean | null; + /** @description Maximum number of entries to return. */ + limit?: number | null; + /** @description Number of entries to skip. */ + offset?: number | null; + /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ + query?: string | null; + /** @description Sort the entries by the specified field. */ + sort_by?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list with details about the remote files available to the user. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["QuotaSummaryList"]; + "application/json": + | components["schemas"]["ListUriResponse"] + | components["schemas"]["ListJstreeResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays details on a particular quota that has been deleted. - * @description Displays details on a particular quota that has been deleted. - */ - deleted_quota_api_quotas_deleted__id__get: { + create_entry_api_remote_files_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Quota. */ - id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CreateEntryPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["QuotaDetails"]; + "application/json": components["schemas"]["CreatedEntryResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Restores a previously deleted quota. - * @description Restores a previously deleted quota. - */ - undelete_api_quotas_deleted__id__undelete_post: { + plugins_api_remote_files_plugins_get: { parameters: { + query?: { + /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ + browsable_only?: boolean | null; + /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + include_kind?: components["schemas"]["PluginKind"][] | null; + /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ + exclude_kind?: components["schemas"]["PluginKind"][] | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list with details about each plugin. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": components["schemas"]["FilesSourcePluginList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays details on a particular active quota. - * @description Displays details on a particular active quota. - */ - quota_api_quotas__id__get: { + index_api_roles_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["QuotaDetails"]; + "application/json": components["schemas"]["RoleListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Updates an existing quota. - * @description Updates an existing quota. - */ - update_api_quotas__id__put: { + create_api_roles_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the Quota. */ - id: string; - }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["UpdateQuotaParams"]; + "application/json": components["schemas"]["RoleDefinitionModel"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Deletes an existing quota. - * @description Deletes an existing quota. - */ - delete_api_quotas__id__delete: { + show_api_roles__id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Quota. */ id: string; }; + cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["DeleteQuotaPayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purges a previously deleted quota. */ - purge_api_quotas__id__purge_post: { + delete_api_roles__id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the Quota. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Displays remote files available to the user. - * @description Lists all remote files available to the user from different sources. - * - * The total count of files and directories is returned in the 'total_matches' header. - */ - index_api_remote_files_get: { + purge_api_roles__id__purge_post: { parameters: { - query?: { - /** @description The source to load datasets from. Possible values: ftpdir, userdir, importdir */ - target?: string; - /** @description The requested format of returned data. Either `flat` to simply list all the files, `jstree` to get a tree representation of the files, or the default `uri` to list files and directories by their URI. */ - format?: components["schemas"]["RemoteFilesFormat"] | null; - /** @description Whether to recursively lists all sub-directories. This will be `True` by default depending on the `target`. */ - recursive?: boolean | null; - /** @description (This only applies when `format` is `jstree`) The value can be either `folders` or `files` and it will disable the corresponding nodes of the tree. */ - disable?: components["schemas"]["RemoteFilesDisableMode"] | null; - /** @description Whether the query is made with the intention of writing to the source. If set to True, only entries that can be written to will be returned. */ - writeable?: boolean | null; - /** @description Maximum number of entries to return. */ - limit?: number | null; - /** @description Number of entries to skip. */ - offset?: number | null; - /** @description Search query to filter entries by. The syntax could be different depending on the target source. */ - query?: string | null; - /** @description Sort the entries by the specified field. */ - sort_by?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list with details about the remote files available to the user. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["ListUriResponse"] - | components["schemas"]["ListJstreeResponse"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Creates a new entry (directory/record) on the remote files source. - * @description Creates a new entry on the remote files source. - */ - create_entry_api_remote_files_post: { + undelete_api_roles__id__undelete_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CreateEntryPayload"]; + path: { + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CreatedEntryResponse"]; + "application/json": components["schemas"]["RoleModelResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Display plugin information for each of the gxfiles:// URI targets available. - * @description Display plugin information for each of the gxfiles:// URI targets available. - */ - plugins_api_remote_files_plugins_get: { + serve_api_short_term_storage__storage_request_id__get: { parameters: { - query?: { - /** @description Whether to return browsable filesources only. The default is `True`, which will omit filesourceslike `http` and `base64` that do not implement a list method. */ - browsable_only?: boolean | null; - /** @description Whether to return **only** filesources of the specified kind. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - include_kind?: components["schemas"]["PluginKind"][] | null; - /** @description Whether to exclude filesources of the specified kind from the list. The default is `None`, which will return all filesources. Multiple values can be specified by repeating the parameter. */ - exclude_kind?: components["schemas"]["PluginKind"][] | null; - }; - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; + query?: never; + header?: never; + path: { + storage_request_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list with details about each plugin. */ + /** @description The archive file containing the History. */ 200: { - content: { - "application/json": components["schemas"]["FilesSourcePluginList"]; + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Request was cancelled without an exception condition recorded. */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Index */ - index_api_roles_get: { + is_ready_api_short_term_storage__storage_request_id__ready_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; + query?: never; + header?: never; + path: { + storage_request_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Boolean indicating if the storage is ready. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["RoleListResponse"]; + "application/json": boolean; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create */ - create_api_roles_post: { + cleanup_datasets_api_storage_datasets_delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["RoleDefinitionModel"]; + "application/json": components["schemas"]["CleanupStorageItemsRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show */ - show_api_roles__id__get: { + discarded_datasets_api_storage_datasets_discarded_get: { parameters: { + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete */ - delete_api_roles__id__delete: { + discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Purge */ - purge_api_roles__id__purge_post: { + cleanup_histories_api_storage_histories_delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CleanupStorageItemsRequest"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["StorageItemsCleanupResult"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Undelete */ - undelete_api_roles__id__undelete_post: { + archived_histories_api_storage_histories_archived_get: { parameters: { + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["RoleModelResponse"]; + "application/json": components["schemas"]["StoredItem"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Serve the staged download specified by request ID. */ - serve_api_short_term_storage__storage_request_id__get: { + archived_histories_summary_api_storage_histories_archived_summary_get: { parameters: { - path: { - storage_request_id: string; + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The archive file containing the History. */ + /** @description Successful Response */ 200: { - content: never; - }; - /** @description Request was cancelled without an exception condition recorded. */ - 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["CleanableItemsSummary"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Determine if specified storage request ID is ready for download. */ - is_ready_api_short_term_storage__storage_request_id__ready_get: { + discarded_histories_api_storage_histories_discarded_get: { parameters: { - path: { - storage_request_id: string; + query?: { + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ + order?: components["schemas"]["StoredItemOrderBy"] | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Boolean indicating if the storage is ready. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": boolean; + "application/json": components["schemas"]["StoredItem"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Purges a set of datasets by ID from disk. The datasets must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ - cleanup_datasets_api_storage_datasets_delete: { + discarded_histories_summary_api_storage_histories_discarded_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["CleanupStorageItemsRequest"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["StorageItemsCleanupResult"]; + "application/json": components["schemas"]["CleanableItemsSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns discarded datasets owned by the given user. The results can be paginated. */ - discarded_datasets_api_storage_datasets_discarded_get: { + update_api_tags_put: { parameters: { - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ItemTagsPayload"]; + }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["StoredItem"][]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns information with the total storage space taken by discarded datasets owned by the given user. */ - discarded_datasets_summary_api_storage_datasets_discarded_summary_get: { + state_api_tasks__task_id__state_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; + query?: never; + header?: never; + path: { + task_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description String indicating task state. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; + "application/json": components["schemas"]["TaskState"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Purges a set of histories by ID. The histories must be owned by the user. - * @description **Warning**: This operation cannot be undone. All objects will be deleted permanently from the disk. - */ - cleanup_histories_api_storage_histories_delete: { + index_api_tool_data_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CleanupStorageItemsRequest"]; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A list with details on individual data tables. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["StorageItemsCleanupResult"]; + "application/json": components["schemas"]["ToolDataEntryList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns archived histories owned by the given user that are not purged. The results can be paginated. */ - archived_histories_api_storage_histories_archived_get: { + create_api_tool_data_post: { parameters: { query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; + tool_data_file_path?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ImportToolDataBundle"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["StoredItem"][]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns information with the total storage space taken by non-purged archived histories associated with the given user. */ - archived_histories_summary_api_storage_histories_archived_summary_get: { + show_api_tool_data__table_name__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The name of the tool data table */ + table_name: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A description of the given data table and its content */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns all discarded histories associated with the given user. */ - discarded_histories_api_storage_histories_discarded_get: { + delete_api_tool_data__table_name__delete: { parameters: { - query?: { - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description String containing one of the valid ordering attributes followed by '-asc' or '-dsc' for ascending and descending order respectively. */ - order?: components["schemas"]["StoredItemOrderBy"] | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The name of the tool data table */ + table_name: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ToolDataItem"]; + }; }; responses: { - /** @description Successful Response */ + /** @description A description of the affected data table and its content */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["StoredItem"][]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns information with the total storage space taken by discarded histories associated with the given user. */ - discarded_histories_summary_api_storage_histories_discarded_summary_get: { + show_field_api_tool_data__table_name__fields__field_name__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The name of the tool data table */ + table_name: string; + /** @description The name of the tool data table field */ + field_name: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Information about a data table field */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CleanableItemsSummary"]; + "application/json": components["schemas"]["ToolDataField"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Apply a new set of tags to an item. - * @description Replaces the tags associated with an item with the new ones specified in the payload. - * - * - The previous tags will be __deleted__. - * - If no tags are provided in the request body, the currently associated tags will also be __deleted__. - */ - update_api_tags_put: { + download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ItemTagsPayload"]; + path: { + /** @description The name of the tool data table */ + table_name: string; + /** @description The name of the tool data table field */ + field_name: string; + /** @description The name of a file associated with this data table field */ + file_name: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ - 204: { - content: never; + /** @description Information about a data table field */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Determine state of task ID */ - state_api_tasks__task_id__state_get: { + reload_api_tool_data__table_name__reload_get: { parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; path: { - task_id: string; + /** @description The name of the tool data table */ + table_name: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description String indicating task state. */ + /** @description A description of the reloaded data table and its content */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["TaskState"]; + "application/json": components["schemas"]["ToolDataDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; - }; - /** - * Lists all available data tables - * @description Get the list of all available data tables. - */ - index_api_tool_data_get: { + }; + index_api_tool_shed_repositories_get: { + parameters: { + query?: { + /** @description Filter by repository name. */ + name?: string | null; + /** @description Filter by repository owner. */ + owner?: string | null; + /** @description Filter by changeset revision. */ + changeset?: string | null; + /** @description Filter by whether the repository has been deleted. */ + deleted?: boolean | null; + /** @description Filter by whether the repository has been uninstalled. */ + uninstalled?: boolean | null; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description A list with details on individual data tables. */ + /** @description A list of installed tool shed repository objects. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ToolDataEntryList"]; + "application/json": components["schemas"]["InstalledToolShedRepository"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Import a data manager bundle */ - create_api_tool_data_post: { + check_for_updates_api_tool_shed_repositories_check_for_updates_get: { parameters: { query?: { - tool_data_file_path?: string | null; + id?: string | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ImportToolDataBundle"]; - }; - }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description A description of the state and updates message. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["CheckForUpdatesResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get details of a given data table - * @description Get details of a given tool data table. - */ - show_api_tool_data__table_name__get: { + show_api_tool_shed_repositories__id__get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; + query?: never; + header?: never; path: { - /** @description The name of the tool data table */ - table_name: string; + /** @description The encoded database identifier of the installed Tool Shed Repository. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A description of the given data table and its content */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ToolDataDetails"]; + "application/json": components["schemas"]["InstalledToolShedRepository"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes an item from a data table - * @description Removes an item from a data table and reloads it to return its updated details. - */ - delete_api_tool_data__table_name__delete: { + fetch_form_api_tools_fetch_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The name of the tool data table */ - table_name: string; - }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["ToolDataItem"]; + "multipart/form-data": components["schemas"]["Body_fetch_form_api_tools_fetch_post"]; }; }; responses: { - /** @description A description of the affected data table and its content */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ToolDataDetails"]; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get information about a particular field in a tool data table - * @description Reloads a data table and return its details. - */ - show_field_api_tool_data__table_name__fields__field_name__get: { + index_api_tours_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The name of the tool data table */ - table_name: string; - /** @description The name of the tool data table field */ - field_name: string; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Information about a data table field */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ToolDataField"]; + "application/json": components["schemas"]["TourList"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get information about a particular field in a tool data table - * @description Download a file associated with the data table field. - */ - download_field_file_api_tool_data__table_name__fields__field_name__files__file_name__get: { + show_api_tours__tour_id__get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; + query?: never; + header?: never; path: { - /** @description The name of the tool data table */ - table_name: string; - /** @description The name of the tool data table field */ - field_name: string; - /** @description The name of a file associated with this data table field */ - file_name: string; + tour_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Information about a data table field */ + /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["TourDetails"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Reloads a tool data table - * @description Reloads a data table and return its details. - */ - reload_api_tool_data__table_name__reload_get: { + update_tour_api_tours__tour_id__post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The name of the tool data table */ - table_name: string; + tour_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A description of the reloaded data table and its content */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ToolDataDetails"]; + "application/json": components["schemas"]["TourDetails"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Lists installed tool shed repositories. */ - index_api_tool_shed_repositories_get: { + get_users_api_users_get: { parameters: { query?: { - /** @description Filter by repository name. */ - name?: string | null; - /** @description Filter by repository owner. */ - owner?: string | null; - /** @description Filter by changeset revision. */ - changeset?: string | null; - /** @description Filter by whether the repository has been deleted. */ - deleted?: boolean | null; - /** @description Filter by whether the repository has been uninstalled. */ - uninstalled?: boolean | null; + /** @description Indicates if the collection will be about deleted users */ + deleted?: boolean; + /** @description An email address to filter on */ + f_email?: string | null; + /** @description An username address to filter on */ + f_name?: string | null; + /** @description Filter on username OR email */ + f_any?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description A list of installed tool shed repository objects. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InstalledToolShedRepository"][]; + "application/json": ( + | components["schemas"]["UserModel"] + | components["schemas"]["LimitedUserModel"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Check for updates to the specified repository, or all installed repositories. */ - check_for_updates_api_tool_shed_repositories_check_for_updates_get: { + create_user_api_users_post: { parameters: { - query?: { - id?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["UserCreationPayload"] + | components["schemas"]["RemoteUserCreationPayload"]; + }; }; responses: { - /** @description A description of the state and updates message. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CheckForUpdatesResponse"]; + "application/json": components["schemas"]["CreatedUserModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show installed tool shed repository. */ - show_api_tool_shed_repositories__id__get: { + recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { parameters: { - path: { - /** @description The encoded database identifier of the installed Tool Shed Repository. */ - id: string; + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The asynchronous task summary to track the task state. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["InstalledToolShedRepository"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Upload files to Galaxy */ - fetch_form_api_tools_fetch_post: { + get_deleted_users_api_users_deleted_get: { parameters: { + query?: { + /** @description An email address to filter on */ + f_email?: string | null; + /** @description An username address to filter on */ + f_name?: string | null; + /** @description Filter on username OR email */ + f_any?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; - requestBody: { - content: { - "multipart/form-data": components["schemas"]["Body_fetch_form_api_tools_fetch_post"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": ( + | components["schemas"]["UserModel"] + | components["schemas"]["LimitedUserModel"] + )[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Index - * @description Return list of available tours. - */ - index_api_tours_get: { + get_deleted_user_api_users_deleted__user_id__get: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["TourList"]; + "application/json": + | components["schemas"]["DetailedUserModel"] + | components["schemas"]["AnonUserModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show - * @description Return a tour definition. - */ - show_api_tours__tour_id__get: { + undelete_user_api_users_deleted__user_id__undelete_post: { parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; path: { - tour_id: string; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["TourDetails"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update Tour - * @description Return a tour definition. - */ - update_tour_api_tours__tour_id__post: { + recalculate_disk_usage_api_users_recalculate_disk_usage_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - tour_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The asynchronous task summary to track the task state. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["TourDetails"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get Users - * @description Return a collection of users. Filters will only work if enabled in config or user is admin. - */ - get_users_api_users_get: { + get_user_api_users__user_id__get: { parameters: { query?: { - /** @description Indicates if the collection will be about deleted users */ - deleted?: boolean; - /** @description An email address to filter on */ - f_email?: string | null; - /** @description An username address to filter on */ - f_name?: string | null; - /** @description Filter on username OR email */ - f_any?: string | null; + /** @description Indicates if the user is deleted */ + deleted?: boolean | null; }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["UserModel"] - | components["schemas"]["LimitedUserModel"] - )[]; + "application/json": + | components["schemas"]["DetailedUserModel"] + | components["schemas"]["AnonUserModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a new Galaxy user. Only admins can create users for now. */ - create_user_api_users_post: { + update_user_api_users__user_id__put: { parameters: { + query?: { + /** @description Indicates if the user is deleted */ + deleted?: boolean | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + }; + cookie?: never; }; requestBody: { content: { - "application/json": - | components["schemas"]["UserCreationPayload"] - | components["schemas"]["RemoteUserCreationPayload"]; + "application/json": components["schemas"]["UserUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CreatedUserModel"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Triggers a recalculation of the current user disk usage. - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ - recalculate_disk_usage_api_users_current_recalculate_disk_usage_put: { + delete_user_api_users__user_id__delete: { parameters: { + query?: { + /** @description Whether to definitely remove this user. Only deleted users can be purged. */ + purge?: boolean; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["UserDeletionPayload"] | null; + }; }; responses: { - /** @description The asynchronous task summary to track the task state. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["DetailedUserModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get Deleted Users - * @description Return a collection of deleted users. Only admins can see deleted users. - */ - get_deleted_users_api_users_deleted_get: { + get_or_create_api_key_api_users__user_id__api_key_get: { parameters: { - query?: { - /** @description An email address to filter on */ - f_email?: string | null; - /** @description An username address to filter on */ - f_name?: string | null; - /** @description Filter on username OR email */ - f_any?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": ( - | components["schemas"]["UserModel"] - | components["schemas"]["LimitedUserModel"] - )[]; + "application/json": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return information about a deleted user. Only admins can see deleted users. */ - get_deleted_user_api_users_deleted__user_id__get: { + create_api_key_api_users__user_id__api_key_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25010,33 +33580,42 @@ export interface operations { /** @description The ID of the user. */ user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["DetailedUserModel"] - | components["schemas"]["AnonUserModel"]; + "application/json": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Restore a deleted user. Only admins can restore users. */ - undelete_user_api_users_deleted__user_id__undelete_post: { + delete_api_key_api_users__user_id__api_key_delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25045,155 +33624,183 @@ export interface operations { /** @description The ID of the user. */ user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["DetailedUserModel"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Triggers a recalculation of the current user disk usage. - * @deprecated - * @description This route will be removed in a future version. - * - * Please use `/api/users/current/recalculate_disk_usage` instead. - */ - recalculate_disk_usage_api_users_recalculate_disk_usage_put: { + get_api_key_detailed_api_users__user_id__api_key_detailed_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The ID of the user. */ + user_id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The asynchronous task summary to track the task state. */ + /** @description The API key of the user. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["APIKeyModel"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ + /** @description The user doesn't have an API key. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return information about a specified or the current user. Only admin can see deleted or other users */ - get_user_api_users__user_id__get: { + get_beacon_settings_api_users__user_id__beacon_get: { parameters: { - query?: { - /** @description Indicates if the user is deleted */ - deleted?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": - | components["schemas"]["DetailedUserModel"] - | components["schemas"]["AnonUserModel"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update the values of a user. Only admin can update others. */ - update_user_api_users__user_id__put: { + set_beacon_settings_api_users__user_id__beacon_post: { parameters: { - query?: { - /** @description Indicates if the user is deleted */ - deleted?: boolean | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The ID of the user. */ + user_id: string; }; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["UserUpdatePayload"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": components["schemas"]["UserBeaconSetting"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete a user. Only admins can delete others or purge users. */ - delete_user_api_users__user_id__delete: { + get_custom_builds_api_users__user_id__custom_builds_get: { parameters: { - query?: { - /** @description Whether to definitely remove this user. Only deleted users can be purged. */ - purge?: boolean; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25202,36 +33809,42 @@ export interface operations { /** @description The ID of the user. */ user_id: string; }; + cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["UserDeletionPayload"] | null; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DetailedUserModel"]; + "application/json": components["schemas"]["CustomBuildsCollection"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's API key */ - get_or_create_api_key_api_users__user_id__api_key_get: { + add_custom_builds_api_users__user_id__custom_builds__key__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25239,32 +33852,49 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; + /** @description The key of the custom build to be deleted. */ + key: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["CustomBuildCreationPayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create a new API key for the user */ - create_api_key_api_users__user_id__api_key_post: { + delete_custom_build_api_users__user_id__custom_builds__key__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25272,32 +33902,45 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; + /** @description The key of the custom build to be deleted. */ + key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": components["schemas"]["DeletedCustomBuild"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete the current API key of the user */ - delete_api_key_api_users__user_id__api_key_delete: { + set_favorite_api_users__user_id__favorites__object_type__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25305,30 +33948,49 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; + /** @description The object type the user wants to favorite */ + object_type: components["schemas"]["FavoriteObjectType"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["FavoriteObject"]; }; }; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["FavoriteObjectsSummary"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's API key with extra information. */ - get_api_key_detailed_api_users__user_id__api_key_detailed_get: { + remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25336,75 +33998,91 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; + /** @description The object type the user wants to favorite */ + object_type: components["schemas"]["FavoriteObjectType"]; + /** @description The ID of an object the user wants to remove from favorites */ + object_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The API key of the user. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["APIKeyModel"]; + "application/json": components["schemas"]["FavoriteObjectsSummary"]; }; }; - /** @description The user doesn't have an API key. */ - 204: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return information about beacon share settings - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ - get_beacon_settings_api_users__user_id__beacon_get: { + get_user_objectstore_usage_api_users__user_id__objectstore_usage_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": components["schemas"]["UserObjectstoreUsage"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Change beacon setting - * @description **Warning**: This endpoint is experimental and might change or disappear in future versions. - */ - set_beacon_settings_api_users__user_id__beacon_post: { + recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25413,36 +34091,49 @@ export interface operations { /** @description The ID of the user. */ user_id: string; }; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["UserBeaconSetting"]; - }; - }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description The asynchronous task summary to track the task state. */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserBeaconSetting"]; + "application/json": components["schemas"]["AsyncTaskResultSummary"]; + }; + }; + /** @description The background task was submitted but there is no status tracking ID available. */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns collection of custom builds. */ - get_custom_builds_api_users__user_id__custom_builds_get: { + get_user_roles_api_users__user_id__roles_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25451,31 +34142,42 @@ export interface operations { /** @description The ID of the user. */ user_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["CustomBuildsCollection"]; + "application/json": components["schemas"]["RoleListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Add new custom build. */ - add_custom_builds_api_users__user_id__custom_builds__key__put: { + send_activation_email_api_users__user_id__send_activation_email_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25483,39 +34185,43 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; - /** @description The key of the custom build to be deleted. */ - key: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["CustomBuildCreationPayload"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete a custom build */ - delete_custom_build_api_users__user_id__custom_builds__key__delete: { + set_theme_api_users__user_id__theme__theme__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25523,428 +34229,538 @@ export interface operations { path: { /** @description The ID of the user. */ user_id: string; - /** @description The key of the custom build to be deleted. */ - key: string; + /** @description The theme of the GUI */ + theme: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["DeletedCustomBuild"]; + "application/json": string; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Add the object to user's favorites */ - set_favorite_api_users__user_id__favorites__object_type__put: { + get_user_usage_api_users__user_id__usage_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The object type the user wants to favorite */ - object_type: components["schemas"]["FavoriteObjectType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["FavoriteObject"]; + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["FavoriteObjectsSummary"]; + "application/json": components["schemas"]["UserQuotaUsage"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Remove the object from user's favorites */ - remove_favorite_api_users__user_id__favorites__object_type___object_id__delete: { + get_user_usage_for_label_api_users__user_id__usage__label__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The object type the user wants to favorite */ - object_type: components["schemas"]["FavoriteObjectType"]; - /** @description The ID of an object the user wants to remove from favorites */ - object_id: string; + /** @description The ID of the user to get or 'current'. */ + user_id: string | "current"; + /** @description The label corresponding to the quota source to fetch usage information about. */ + label: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["FavoriteObjectsSummary"]; + "application/json": components["schemas"]["UserQuotaUsage"] | null; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's object store usage summary broken down by object store ID */ - get_user_objectstore_usage_api_users__user_id__objectstore_usage_get: { + version_api_version_get: { parameters: { - header?: { - /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ - "run-as"?: string | null; - }; - path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; - }; + query?: never; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Galaxy version information: major/minor version, optional extra info */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserObjectstoreUsage"][]; + "application/json": Record; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Triggers a recalculation of the current user disk usage. */ - recalculate_disk_usage_by_user_id_api_users__user_id__recalculate_disk_usage_put: { + index_api_visualizations_get: { parameters: { + query?: { + /** @description Whether to include deleted visualizations in the result. */ + deleted?: boolean; + /** @description The maximum number of items to return. */ + limit?: number | null; + /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ + offset?: number | null; + user_id?: string | null; + show_own?: boolean; + show_published?: boolean; + show_shared?: boolean; + /** @description Sort visualization index by this specified attribute on the visualization model */ + sort_by?: "create_time" | "title" | "update_time" | "username"; + /** @description Sort in descending order? */ + sort_desc?: boolean; + /** @description A mix of free text and GitHub-style tags used to filter the index operation. + * + * ## Query Structure + * + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). + * + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). + * + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. + * + * ## GitHub-style Tags Available + * + * `title` + * : The visualization's title. + * + * `slug` + * : The visualization's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) + * + * `tag` + * : The visualization's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * + * `user` + * : The visualization's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Visualizations: `title`, `slug`, `tag`, `type`. + * + * */ + search?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The asynchronous task summary to track the task state. */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["AsyncTaskResultSummary"]; + "application/json": components["schemas"]["VisualizationSummaryList"]; }; }; - /** @description The background task was submitted but there is no status tracking ID available. */ - 204: { - content: never; - }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Sends activation email to user. */ - send_activation_email_api_users__user_id__send_activation_email_post: { + create_api_visualizations_post: { parameters: { + query?: { + /** @description The encoded database identifier of the Visualization to import. */ + import_id?: string | null; + }; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The ID of the user. */ - user_id: string; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["VisualizationCreatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": unknown; + "application/json": components["schemas"]["VisualizationCreateResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Set the user's theme choice */ - set_theme_api_users__user_id__theme__theme__put: { + show_api_visualizations__id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user. */ - user_id: string; - /** @description The theme of the GUI */ - theme: string; + /** @description The encoded database identifier of the Visualization. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": string; + "application/json": components["schemas"]["VisualizationShowResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's quota usage summary broken down by quota source */ - get_user_usage_api_users__user_id__usage_get: { + update_api_visualizations__id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; + /** @description The encoded database identifier of the Visualization. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["VisualizationUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserQuotaUsage"][]; + "application/json": components["schemas"]["VisualizationUpdateResponse"] | null; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Return the user's quota usage summary for a given quota source label */ - get_user_usage_for_label_api_users__user_id__usage__label__get: { + disable_link_access_api_visualizations__id__disable_link_access_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The ID of the user to get or 'current'. */ - user_id: string | "current"; - /** @description The label corresponding to the quota source to fetch usage information about. */ - label: string; + /** @description The encoded database identifier of the Visualization. */ + id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserQuotaUsage"] | null; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return Galaxy version information: major/minor version, optional extra info - * @description Return Galaxy version information: major/minor version, optional extra info. - */ - version_api_version_get: { + enable_link_access_api_visualizations__id__enable_link_access_put: { + parameters: { + query?: never; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; + }; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description Galaxy version information: major/minor version, optional extra info */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": Record; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Returns visualizations for the current user. */ - index_api_visualizations_get: { + publish_api_visualizations__id__publish_put: { parameters: { - query?: { - /** @description Whether to include deleted visualizations in the result. */ - deleted?: boolean; - /** @description The maximum number of items to return. */ - limit?: number | null; - /** @description Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item */ - offset?: number | null; - user_id?: string | null; - show_own?: boolean; - show_published?: boolean; - show_shared?: boolean; - /** @description Sort visualization index by this specified attribute on the visualization model */ - sort_by?: "create_time" | "title" | "update_time" | "username"; - /** @description Sort in descending order? */ - sort_desc?: boolean; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. - * - * ## Query Structure - * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). - * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). - * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. - * - * ## GitHub-style Tags Available - * - * `title` - * : The visualization's title. - * - * `slug` - * : The visualization's slug. (The tag `s` can be used a short hand alias for this tag to filter on this attribute.) - * - * `tag` - * : The visualization's tags. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) - * - * `user` - * : The visualization's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) - * - * ## Free Text - * - * Free text search terms will be searched against the following attributes of the - * Visualizations: `title`, `slug`, `tag`, `type`. - */ - search?: string | null; - }; + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The encoded database identifier of the Visualization. */ + id: string; + }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["VisualizationSummaryList"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ - disable_link_access_api_visualizations__id__disable_link_access_put: { + share_with_users_api_visualizations__id__share_with_users_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25953,34 +34769,46 @@ export interface operations { /** @description The encoded database identifier of the Visualization. */ id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ShareWithPayload"]; + }; }; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["ShareWithStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ - enable_link_access_api_visualizations__id__enable_link_access_put: { + sharing_api_visualizations__id__sharing_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -25989,34 +34817,42 @@ export interface operations { /** @description The encoded database identifier of the Visualization. */ id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ - publish_api_visualizations__id__publish_put: { + set_slug_api_visualizations__id__slug_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26025,34 +34861,44 @@ export interface operations { /** @description The encoded database identifier of the Visualization. */ id: string; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["SetSlugPayload"]; + }; }; responses: { /** @description Successful Response */ - 200: { - content: { - "application/json": components["schemas"]["SharingStatus"]; + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ - share_with_users_api_visualizations__id__share_with_users_put: { + unpublish_api_visualizations__id__unpublish_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26061,180 +34907,217 @@ export interface operations { /** @description The encoded database identifier of the Visualization. */ id: string; }; + cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["ShareWithPayload"]; - }; - }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["ShareWithStatus"]; + "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given Visualization. - * @description Return the sharing status of the item. - */ - sharing_api_visualizations__id__sharing_get: { + whoami_api_whoami_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; - }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - /** @description Successful Response */ + /** @description Information about the current authenticated user */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["UserModel"] | null; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ - set_slug_api_visualizations__id__slug_put: { + create_landing_api_workflow_landings_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; - path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; - }; + path?: never; + cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["SetSlugPayload"]; + "application/json": components["schemas"]["CreateWorkflowLandingRequestPayload"]; }; }; responses: { /** @description Successful Response */ - 204: { - content: never; + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["WorkflowLandingRequest"]; + }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ - unpublish_api_visualizations__id__unpublish_put: { + get_landing_api_workflow_landings__uuid__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; path: { - /** @description The encoded database identifier of the Visualization. */ - id: string; + /** @description The UUID used to identify a persisted landing request. */ + uuid: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["SharingStatus"]; + "application/json": components["schemas"]["WorkflowLandingRequest"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Return information about the current authenticated user - * @description Return information about the current authenticated user. - */ - whoami_api_whoami_get: { + claim_landing_api_workflow_landings__uuid__claim_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path: { + /** @description The UUID used to identify a persisted landing request. */ + uuid: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ClaimLandingPayload"] | null; + }; }; responses: { - /** @description Information about the current authenticated user */ + /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { - "application/json": components["schemas"]["UserModel"] | null; + "application/json": components["schemas"]["WorkflowLandingRequest"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Lists stored workflows viewable by the user. - * @description Lists stored workflows viewable by the user. - */ index_api_workflows_get: { parameters: { query?: { @@ -26252,45 +35135,54 @@ export interface operations { sort_desc?: boolean | null; limit?: number | null; offset?: number | null; - /** - * @description A mix of free text and GitHub-style tags used to filter the index operation. + /** @description A mix of free text and GitHub-style tags used to filter the index operation. * - * ## Query Structure + * ## Query Structure * - * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form - * `:` or `:''`. The tag name - * *generally* (but not exclusively) corresponds to the name of an attribute on the model - * being indexed (i.e. a column in the database). + * GitHub-style filter tags (not be confused with Galaxy tags) are tags of the form + * `:` or `:''`. The tag name + * *generally* (but not exclusively) corresponds to the name of an attribute on the model + * being indexed (i.e. a column in the database). * - * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, - * generally a partial match will be used to filter the query (i.e. in terms of the implementation - * this means the database operation `ILIKE` will typically be used). + * If the tag is quoted, the attribute will be filtered exactly. If the tag is unquoted, + * generally a partial match will be used to filter the query (i.e. in terms of the implementation + * this means the database operation `ILIKE` will typically be used). * - * Once the tagged filters are extracted from the search query, the remaining text is just - * used to search various documented attributes of the object. + * Once the tagged filters are extracted from the search query, the remaining text is just + * used to search various documented attributes of the object. * - * ## GitHub-style Tags Available + * ## GitHub-style Tags Available * - * `name` - * : The stored workflow's name. (The tag `n` can be used a short hand alias for this tag to filter on this attribute.) + * `name` + * : The stored workflow's name. (The tag `n` can be used a short hand alias for this tag to filter on this attribute.) * - * `tag` - * : The workflow's tag, if the tag contains a colon an approach will be made to match the key and value of the tag separately. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) + * `tag` + * : The workflow's tag, if the tag contains a colon an approach will be made to match the key and value of the tag separately. (The tag `t` can be used a short hand alias for this tag to filter on this attribute.) * - * `user` - * : The stored workflow's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) + * `user` + * : The stored workflow's owner's username. (The tag `u` can be used a short hand alias for this tag to filter on this attribute.) * - * `is:published` - * : Include only published workflows in the final result. Be sure the query parameter `show_published` is set to `true` if to include all published workflows and not just the requesting user's. + * `is:published` + * : Include only published workflows in the final result. Be sure the query parameter `show_published` is set to `true` if to include all published workflows and not just the requesting user's. * - * `is:share_with_me` - * : Include only workflows shared with the requesting user. Be sure the query parameter `show_shared` is set to `true` if to include shared workflows. + * `is:importable` + * : Include only importable workflows in the final result. * - * ## Free Text + * `is:deleted` + * : Include only deleted workflows in the final result. * - * Free text search terms will be searched against the following attributes of the - * Stored Workflows: `name`, `tag`, `user`. - */ + * `is:shared_with_me` + * : Include only workflows shared with the requesting user. Be sure the query parameter `show_shared` is set to `true` if to include shared workflows. + * + * `is:bookmarked` + * : Include only workflows bookmarked by the requesting user. + * + * ## Free Text + * + * Free text search terms will be searched against the following attributes of the + * Stored Workflows: `name`, `tag`, `user`. + * + * */ search?: string | null; /** @description Set this to true to skip joining workflow step counts and optimize the resulting index query. Response objects will not contain step counts. */ skip_step_counts?: boolean; @@ -26299,29 +35191,40 @@ export interface operations { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description A list with summary stored workflow information per viewable entry. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record[]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get workflows present in the tools panel. */ get_workflow_menu_api_workflows_menu_get: { parameters: { query?: { @@ -26338,29 +35241,40 @@ export interface operations { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; }; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Displays information needed to run a workflow. */ show_workflow_api_workflows__workflow_id__get: { parameters: { query?: { @@ -26378,31 +35292,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["StoredWorkflowDetailed"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Add the deleted flag to a workflow. */ delete_workflow_api_workflows__workflow_id__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26411,29 +35336,39 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get state counts for accessible workflow. */ workflows__invocation_counts: { parameters: { query?: { @@ -26448,34 +35383,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["RootModel_Dict_str__int__"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item inaccessible by a URL link. - * @description Makes this item inaccessible by a URL link and return the current sharing status. - */ disable_link_access_api_workflows__workflow_id__disable_link_access_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26484,34 +35427,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item accessible by a URL link. - * @description Makes this item accessible by a URL link and return the current sharing status. - */ enable_link_access_api_workflows__workflow_id__enable_link_access_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26520,29 +35471,39 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get the list of a user's workflow invocations. */ index_invocations_api_workflows__workflow_id__invocations_get: { parameters: { query?: { @@ -26577,31 +35538,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Schedule the workflow specified by `workflow_id` to run. */ Invoke_workflow_api_workflows__workflow_id__invocations_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26610,6 +35582,7 @@ export interface operations { /** @description The database identifier - UUID or encoded - of the Workflow. */ workflow_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -26619,6 +35592,9 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["WorkflowInvocationResponse"] @@ -26627,33 +35603,33 @@ export interface operations { }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get detailed description of a workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ show_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__get: { parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ + /** @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. */ legacy_job_state?: boolean; }; header?: { @@ -26666,43 +35642,48 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Cancel the specified workflow invocation. - * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ cancel_workflow_invocation_api_workflows__workflow_id__invocations__invocation_id__delete: { parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ + /** @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. */ legacy_job_state?: boolean; }; header?: { @@ -26715,34 +35696,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__jobs_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26753,34 +35742,42 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get JSON summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. - */ show_workflow_invocation_report_api_workflows__workflow_id__invocations__invocation_id__report_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26791,34 +35788,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationReport"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get PDF summarizing invocation for reporting. - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ show_workflow_invocation_report_pdf_api_workflows__workflow_id__invocations__invocation_id__report_pdf_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26829,32 +35834,40 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_step_jobs_summary_api_workflows__workflow_id__invocations__invocation_id__step_jobs_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26865,10 +35878,15 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": ( | components["schemas"]["InvocationStepJobsResponseStepModel"] @@ -26879,24 +35897,27 @@ export interface operations { }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show details of workflow invocation step. - * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. - */ workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26909,34 +35930,42 @@ export interface operations { /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update state of running workflow step invocation. - * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. - */ update_workflow_invocation_step_api_workflows__workflow_id__invocations__invocation_id__steps__step_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26949,6 +35978,7 @@ export interface operations { /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -26958,30 +35988,36 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Makes this item public and accessible by a URL link. - * @description Makes this item publicly available by a URL link and return the current sharing status. - */ publish_api_workflows__workflow_id__publish_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -26990,29 +36026,39 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Updates the workflow stored with the given ID. */ refactor_api_workflows__workflow_id__refactor_put: { parameters: { query?: { @@ -27026,6 +36072,7 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -27035,30 +36082,36 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["RefactorResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Share this item with specific users. - * @description Shares this item with specific users and return the current sharing status. - */ share_with_users_api_workflows__workflow_id__share_with_users_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27067,6 +36120,7 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -27076,30 +36130,36 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ShareWithStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the current sharing status of the given item. - * @description Return the sharing status of the item. - */ sharing_api_workflows__workflow_id__sharing_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27108,34 +36168,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Set a new slug for this shared item. - * @description Sets a new slug to access this item by URL. The new slug must be unique. - */ set_slug_api_workflows__workflow_id__slug_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27144,6 +36212,7 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -27153,25 +36222,34 @@ export interface operations { responses: { /** @description Successful Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tags based on workflow_id */ index_api_workflows__workflow_id__tags_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27179,31 +36257,42 @@ export interface operations { path: { workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ItemTagsListResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Show tag based on workflow_id */ show_api_workflows__workflow_id__tags__tag_name__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27212,31 +36301,42 @@ export interface operations { workflow_id: string; tag_name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Update tag based on workflow_id */ update_api_workflows__workflow_id__tags__tag_name__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27245,6 +36345,7 @@ export interface operations { workflow_id: string; tag_name: string; }; + cookie?: never; }; requestBody: { content: { @@ -27254,27 +36355,36 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Create tag based on workflow_id */ create_api_workflows__workflow_id__tags__tag_name__post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27283,6 +36393,7 @@ export interface operations { workflow_id: string; tag_name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -27292,27 +36403,36 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ItemTagsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Delete tag based on workflow_id */ delete_api_workflows__workflow_id__tags__tag_name__delete: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27321,31 +36441,42 @@ export interface operations { workflow_id: string; tag_name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": boolean; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Remove the deleted flag from a workflow. */ undelete_workflow_api_workflows__workflow_id__undelete_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27354,34 +36485,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Removes this item from the published list. - * @description Removes this item from the published list and return the current sharing status. - */ unpublish_api_workflows__workflow_id__unpublish_put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27390,32 +36529,39 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["SharingStatus"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get the list of a user's workflow invocations. - * @deprecated - */ index_invocations_api_workflows__workflow_id__usage_get: { parameters: { query?: { @@ -27450,34 +36596,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["WorkflowInvocationResponse"][]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Schedule the workflow specified by `workflow_id` to run. - * @deprecated - */ Invoke_workflow_api_workflows__workflow_id__usage_post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27486,6 +36640,7 @@ export interface operations { /** @description The database identifier - UUID or encoded - of the Workflow. */ workflow_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -27495,6 +36650,9 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["WorkflowInvocationResponse"] @@ -27503,34 +36661,33 @@ export interface operations { }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get detailed description of a workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ show_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__get: { parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ + /** @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. */ legacy_job_state?: boolean; }; header?: { @@ -27543,44 +36700,48 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Cancel the specified workflow invocation. - * @deprecated - * @description An alias for `DELETE /api/invocations/{invocation_id}`. `workflow_id` is ignored. - */ cancel_workflow_invocation_api_workflows__workflow_id__usage__invocation_id__delete: { parameters: { query?: { /** @description Include details for individual invocation steps and populate a steps attribute in the resulting dictionary. */ step_details?: boolean; - /** - * @description Populate the invocation step state with the job state instead of the invocation step state. - * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. - * Partially scheduled steps may provide incomplete information and the listed steps outputs - * are not the mapped over step outputs but the individual job outputs. - */ + /** @description Populate the invocation step state with the job state instead of the invocation step state. + * This will also produce one step per job in mapping jobs to mimic the older behavior with respect to collections. + * Partially scheduled steps may provide incomplete information and the listed steps outputs + * are not the mapped over step outputs but the individual job outputs. */ legacy_job_state?: boolean; }; header?: { @@ -27593,35 +36754,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["WorkflowInvocationResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated across all current jobs of the workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_jobs_summary_api_workflows__workflow_id__usage__invocation_id__jobs_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27632,35 +36800,42 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationJobsResponse"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get JSON summarizing invocation for reporting. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/report`. `workflow_id` is ignored. - */ show_workflow_invocation_report_api_workflows__workflow_id__usage__invocation_id__report_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27671,35 +36846,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationReport"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get PDF summarizing invocation for reporting. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/report.pdf`. `workflow_id` is ignored. - */ show_workflow_invocation_report_pdf_api_workflows__workflow_id__usage__invocation_id__report_pdf_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27710,33 +36892,40 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Get job state summary info aggregated per step of the workflow invocation. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/step_jobs_summary`. `workflow_id` is ignored. - */ workflow_invocation_step_jobs_summary_api_workflows__workflow_id__usage__invocation_id__step_jobs_summary_get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27747,10 +36936,15 @@ export interface operations { /** @description The encoded database identifier of the Invocation. */ invocation_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": ( | components["schemas"]["InvocationStepJobsResponseStepModel"] @@ -27761,25 +36955,27 @@ export interface operations { }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Show details of workflow invocation step. - * @deprecated - * @description An alias for `GET /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` and `invocation_id` are ignored. - */ workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27792,35 +36988,42 @@ export interface operations { /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** - * Update state of running workflow step invocation. - * @deprecated - * @description An alias for `PUT /api/invocations/{invocation_id}/steps/{step_id}`. `workflow_id` is ignored. - */ update_workflow_invocation_step_api_workflows__workflow_id__usage__invocation_id__steps__step_id__put: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27833,6 +37036,7 @@ export interface operations { /** @description The encoded database identifier of the WorkflowInvocationStep. */ step_id: string; }; + cookie?: never; }; requestBody: { content: { @@ -27842,25 +37046,33 @@ export interface operations { responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["InvocationStep"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** List all versions of a workflow. */ show_versions_api_workflows__workflow_id__versions_get: { parameters: { query?: { @@ -27874,31 +37086,42 @@ export interface operations { /** @description The encoded database identifier of the Stored Workflow. */ workflow_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27907,31 +37130,42 @@ export interface operations { /** @description The ID of the group */ object_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["DrsObject"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Object */ get_object_ga4gh_drs_v1_objects__object_id__post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27940,31 +37174,42 @@ export interface operations { /** @description The ID of the group */ object_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["DrsObject"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__get: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -27975,31 +37220,42 @@ export interface operations { /** @description The access ID of the access method for objects, unused in Galaxy. */ access_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Get Access Url */ get_access_url_ga4gh_drs_v1_objects__object_id__access__access_id__post: { parameters: { + query?: never; header?: { /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ "run-as"?: string | null; @@ -28010,45 +37266,117 @@ export interface operations { /** @description The access ID of the access method for objects, unused in Galaxy. */ access_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": unknown; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; }; }; - /** Service Info */ service_info_ga4gh_drs_v1_service_info_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Successful Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["Service"]; }; }; /** @description Request Error */ "4XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + /** @description Server Error */ + "5XX": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["MessageExceptionModel"]; + }; + }; + }; + }; + oauth2_callback_oauth2_callback_get: { + parameters: { + query: { + /** @description Base-64 encoded JSON used to route request within Galaxy. */ + state: string; + code?: string | null; + error?: string | null; + }; + header?: { + /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */ + "run-as"?: string | null; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": unknown; + }; + }; + /** @description Request Error */ + "4XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; }; /** @description Server Error */ "5XX": { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["MessageExceptionModel"]; }; diff --git a/client/src/api/tags.ts b/client/src/api/tags.ts index 34e9c70b8d36..2eed2bae0295 100644 --- a/client/src/api/tags.ts +++ b/client/src/api/tags.ts @@ -1,13 +1,18 @@ -import { type components, fetcher } from "@/api/schema"; +import { type components, GalaxyApi } from "@/api"; +import { rethrowSimple } from "@/utils/simple-error"; type TaggableItemClass = components["schemas"]["TaggableItemClass"]; -const putItemTags = fetcher.path("/api/tags").method("put").create(); - export async function updateTags(itemId: string, itemClass: TaggableItemClass, itemTags?: string[]): Promise { - await putItemTags({ - item_id: itemId, - item_class: itemClass, - item_tags: itemTags, + const { error } = await GalaxyApi().PUT("/api/tags", { + body: { + item_id: itemId, + item_class: itemClass, + item_tags: itemTags, + }, }); + + if (error) { + rethrowSimple(error); + } } diff --git a/client/src/api/users.ts b/client/src/api/users.ts index 2b3fca5b279d..a6086985d7a9 100644 --- a/client/src/api/users.ts +++ b/client/src/api/users.ts @@ -1,19 +1,37 @@ -import { fetcher } from "@/api/schema"; - -export const createApiKey = fetcher.path("/api/users/{user_id}/api_key").method("post").create(); -export const deleteUser = fetcher.path("/api/users/{user_id}").method("delete").create(); -export const fetchQuotaUsages = fetcher.path("/api/users/{user_id}/usage").method("get").create(); -export const fetchObjectStoreUsages = fetcher.path("/api/users/{user_id}/objectstore_usage").method("get").create(); -export const recalculateDiskUsage = fetcher.path("/api/users/current/recalculate_disk_usage").method("put").create(); -export const recalculateDiskUsageByUserId = fetcher - .path("/api/users/{user_id}/recalculate_disk_usage") - .method("put") - .create(); -export const sendActivationEmail = fetcher.path("/api/users/{user_id}/send_activation_email").method("post").create(); -export const undeleteUser = fetcher.path("/api/users/deleted/{user_id}/undelete").method("post").create(); - -const getUsers = fetcher.path("/api/users").method("get").create(); -export async function getAllUsers() { - const { data } = await getUsers({}); - return data; +import { GalaxyApi } from "@/api"; +import { toQuotaUsage } from "@/components/User/DiskUsage/Quota/model"; +import { rethrowSimple } from "@/utils/simple-error"; + +export { type QuotaUsage } from "@/components/User/DiskUsage/Quota/model"; + +export async function fetchCurrentUserQuotaUsages() { + const { data, error } = await GalaxyApi().GET("/api/users/{user_id}/usage", { + params: { path: { user_id: "current" } }, + }); + + if (error) { + rethrowSimple(error); + } + + return data.map((usage) => toQuotaUsage(usage)); +} + +export async function fetchCurrentUserQuotaSourceUsage(quotaSourceLabel?: string | null) { + if (!quotaSourceLabel) { + quotaSourceLabel = "__null__"; + } + + const { data, error } = await GalaxyApi().GET("/api/users/{user_id}/usage/{label}", { + params: { path: { user_id: "current", label: quotaSourceLabel } }, + }); + + if (error) { + rethrowSimple(error); + } + + if (data === null) { + return null; + } + + return toQuotaUsage(data); } diff --git a/client/src/api/workflows.ts b/client/src/api/workflows.ts index af3fbd325502..2cc8371d74af 100644 --- a/client/src/api/workflows.ts +++ b/client/src/api/workflows.ts @@ -1,15 +1,7 @@ -import { type components, fetcher } from "@/api/schema"; +import { type components } from "@/api/schema"; export type StoredWorkflowDetailed = components["schemas"]["StoredWorkflowDetailed"]; -export const workflowsFetcher = fetcher.path("/api/workflows").method("get").create(); -export const workflowFetcher = fetcher.path("/api/workflows/{workflow_id}").method("get").create(); - -export const invocationCountsFetcher = fetcher.path("/api/workflows/{workflow_id}/counts").method("get").create(); - -export const sharing = fetcher.path("/api/workflows/{workflow_id}/sharing").method("get").create(); -export const enableLink = fetcher.path("/api/workflows/{workflow_id}/enable_link_access").method("put").create(); - //TODO: replace with generated schema model when available export interface WorkflowSummary { name: string; diff --git a/client/src/app/app.test.js b/client/src/app/app.test.js index ff8e25eaa868..50664b289345 100644 --- a/client/src/app/app.test.js +++ b/client/src/app/app.test.js @@ -1,6 +1,7 @@ import galaxyOptions from "@tests/test-data/bootstrapped"; import { getGalaxyInstance, setGalaxyInstance } from "app"; import Backbone from "backbone"; +import { suppressDebugConsole } from "tests/jest/helpers"; export function setupTestGalaxy(galaxyOptions_ = null) { galaxyOptions_ = galaxyOptions_ || galaxyOptions; @@ -13,6 +14,10 @@ export function setupTestGalaxy(galaxyOptions_ = null) { }); } +// the app console debugs make sense but we just don't want to see them in test +// output. +suppressDebugConsole(); + describe("App base construction/initializiation defaults", () => { beforeEach(() => { setupTestGalaxy(galaxyOptions); diff --git a/client/src/app/monitor.js b/client/src/app/monitor.js index 3de7d0dfd212..81b39097c72f 100644 --- a/client/src/app/monitor.js +++ b/client/src/app/monitor.js @@ -27,7 +27,9 @@ if (!window.Galaxy) { }, }); } else { - console.debug("Skipping, window.Galaxy already exists.", serverPath()); + if (process.env.NODE_ENV != "test") { + console.debug("Skipping, window.Galaxy already exists.", serverPath()); + } } export default window.Galaxy; diff --git a/client/src/components/ActivityBar/ActivityBar.test.js b/client/src/components/ActivityBar/ActivityBar.test.js index 1fbab6c98cad..8d1b7fc8bfb4 100644 --- a/client/src/components/ActivityBar/ActivityBar.test.js +++ b/client/src/components/ActivityBar/ActivityBar.test.js @@ -45,7 +45,7 @@ describe("ActivityBar", () => { beforeEach(async () => { const pinia = createTestingPinia({ stubActions: false }); - activityStore = useActivityStore(); + activityStore = useActivityStore("default"); eventStore = useEventStore(); wrapper = shallowMount(mountTarget, { localVue, diff --git a/client/src/components/ActivityBar/ActivityBar.vue b/client/src/components/ActivityBar/ActivityBar.vue index cde4d7b190ad..5371d14f84fe 100644 --- a/client/src/components/ActivityBar/ActivityBar.vue +++ b/client/src/components/ActivityBar/ActivityBar.vue @@ -1,11 +1,13 @@ diff --git a/client/src/components/ActivityBar/ActivityItem.test.js b/client/src/components/ActivityBar/ActivityItem.test.js index d4486230dda9..c1177158befa 100644 --- a/client/src/components/ActivityBar/ActivityItem.test.js +++ b/client/src/components/ActivityBar/ActivityItem.test.js @@ -1,3 +1,4 @@ +import { createTestingPinia } from "@pinia/testing"; import { mount } from "@vue/test-utils"; import { getLocalVue } from "tests/jest/helpers"; @@ -12,6 +13,7 @@ describe("ActivityItem", () => { wrapper = mount(mountTarget, { propsData: { id: "activity-test-id", + activityBarId: "activity-bar-test-id", icon: "activity-test-icon", indicator: 0, progressPercentage: 0, @@ -20,6 +22,7 @@ describe("ActivityItem", () => { to: null, tooltip: "activity-test-tooltip", }, + pinia: createTestingPinia(), localVue, stubs: { FontAwesomeIcon: true, @@ -28,8 +31,7 @@ describe("ActivityItem", () => { }); it("rendering", async () => { - const reference = wrapper.find("[id='activity-test-id']"); - expect(reference.attributes().id).toBe("activity-test-id"); + const reference = wrapper.find(".activity-item"); expect(reference.text()).toBe("activity-test-title"); expect(reference.find("[icon='activity-test-icon']").exists()).toBeTruthy(); expect(reference.find(".progress").exists()).toBeFalsy(); @@ -45,7 +47,7 @@ describe("ActivityItem", () => { }); it("rendering indicator", async () => { - const reference = wrapper.find("[id='activity-test-id']"); + const reference = wrapper.find(".activity-item"); const indicatorSelector = "[data-description='activity indicator']"; const noindicator = reference.find(indicatorSelector); expect(noindicator.exists()).toBeFalsy(); diff --git a/client/src/components/ActivityBar/ActivityItem.vue b/client/src/components/ActivityBar/ActivityItem.vue index 0586a1657f99..fa7e67d5e8c0 100644 --- a/client/src/components/ActivityBar/ActivityItem.vue +++ b/client/src/components/ActivityBar/ActivityItem.vue @@ -1,7 +1,14 @@