diff --git a/.claude/skills/openapi-overlay-generator/SKILL.md b/.claude/skills/openapi-overlay-generator/SKILL.md index 521f405ed..762ddf14a 100644 --- a/.claude/skills/openapi-overlay-generator/SKILL.md +++ b/.claude/skills/openapi-overlay-generator/SKILL.md @@ -83,7 +83,73 @@ actions: - `offset`: "Number of results to skip for pagination. Default: `0`." - `max`: "Maximum number of results to return. Default: `{value}`." -**Example**: +**CRITICAL - Parameter Array Replacement Pattern**: + +When the comparison overlay contains a `remove: true` action followed by a parameter array `update`, you MUST preserve BOTH actions in your generated overlay: + +1. First action: Remove the entire existing parameters array with `remove: true` +2. Second action: Replace with the complete new array including enriched descriptions + +**Why**: Simply updating individual parameter descriptions will cause duplicates and validation errors. The entire parameters array must be removed before replacement. + +**Example - Comparison overlay shows**: +```yaml +- target: $["paths"]["/data-links/{dataLinkId}/browse"]["get"]["parameters"][*] + remove: true +- target: $["paths"]["/data-links/{dataLinkId}/browse"]["get"]["parameters"] + update: + - name: dataLinkId + in: path + description: Data-link string identifier + required: true + schema: + type: string + - name: path + in: query + description: Resource path to browse + # ... more params +``` + +**Your generated overlay MUST include BOTH actions**: +```yaml +overlay: 1.0.0 +info: + title: Data-links parameters overlay + version: 1.102.0 +actions: + # ===== DATA-LINKS PARAMETERS ===== + + # Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: path + in: query + description: "Resource path to browse. Default: `/` (root directory)." + required: false + schema: + type: string + # ... include ALL parameters from comparison with enriched descriptions +``` + +**DO NOT do this** (updating descriptions without removal): +```yaml +# ❌ WRONG - This will create duplicate parameters and validation errors +- target: "$.paths./data-links/{dataLinkId}/browse.get.parameters[?(@.name=='dataLinkId')].description" + update: "Data-link string identifier." +# Missing the removal action = duplicates! +``` + +**Standard example** (when comparison shows simple description updates, not array replacement): ```yaml overlay: 1.0.0 info: @@ -170,6 +236,12 @@ Fix any errors or warnings before proceeding. ## Critical rules +### Overlay Files +- ✅ NEVER create overlay files with empty actions lists +- ❌ Do not create overlays with only comments and no actual update actions +- ✅ If a feature area has no changes, omit the overlay file entirely +- ❌ Empty overlays will break the workflow automation + ### Summaries - ✅ Sentence case: "List datasets" - ❌ Title case: "List Datasets" @@ -265,13 +337,41 @@ $.paths./datasets.get.responses['200'].description ## Generating overlays from comparison +**CRITICAL - Preserve ALL Actions from Comparison Overlay**: + +Every single action defined in the comparison overlay MUST be preserved in your generated overlay files. No orphaned actions are allowed. + +**Requirements**: +1. **One-to-one mapping**: For each action in the comparison overlay, there must be AT LEAST one corresponding action in the generated overlays +2. **One-to-many mapping**: Some comparison actions will map to TWO generated actions: + - Comparison has `remove: true` followed by `update` → Generate BOTH removal and update actions + - Example: Parameter array replacement requires both remove and update +3. **Verification**: Before finalizing, check that every action in the comparison overlay has a corresponding action in your generated overlays + +**Example**: +```yaml +# Comparison overlay has 2 actions: +- target: $["paths"]["/endpoint"]["get"]["parameters"][*] + remove: true # ← Action 1 +- target: $["paths"]["/endpoint"]["get"]["parameters"] + update: [...] # ← Action 2 + +# Your generated overlay MUST have both: +- target: "$.paths./endpoint.get.parameters[*]" + remove: true # ← Corresponds to Action 1 +- target: "$.paths./endpoint.get.parameters" + update: [...] # ← Corresponds to Action 2 +``` + When analyzing a comparison overlay: -1. **Identify new endpoints**: These need ALL three overlay types (operations, parameters, schemas) -2. **Group by tag/controller**: Create one set of overlay files per resource (datasets, credentials, etc.) -3. **Check for standard parameters**: Use exact standard descriptions -4. **Follow patterns**: Use templates from overlay-patterns.md -5. **Maintain consistency**: Same entities use same phrasing throughout +1. **Count all actions**: Note the total number of actions in the comparison overlay +2. **Identify new endpoints**: These need ALL three overlay types (operations, parameters, schemas) +3. **Group by tag/controller**: Create one set of overlay files per resource (datasets, credentials, etc.) +4. **Check for standard parameters**: Use exact standard descriptions +5. **Follow patterns**: Use templates from overlay-patterns.md +6. **Maintain consistency**: Same entities use same phrasing throughout +7. **Verify completeness**: Ensure every comparison action is represented in your generated overlays ## Quality checklist @@ -316,13 +416,16 @@ Before finalizing overlay files: ## Common mistakes to avoid -1. **Inconsistent parameter descriptions**: Always use standards.md exact wording -2. **Missing periods in descriptions**: Descriptions are sentences -3. **Title case summaries**: Use sentence case only -4. **Invented terminology**: Use established terms only -5. **Missing defaults**: Always specify default values in backticks -6. **Incomplete enum listings**: List all accepted values -7. **Vague descriptions**: Include specifics (max length, format, constraints) +1. **Empty overlay files**: NEVER create overlay files with no action items (only comments). Empty overlays break the workflow automation. +2. **Orphaned comparison actions**: EVERY action in the comparison overlay MUST have a corresponding action in your generated overlays. Check that nothing is missing. +3. **Missing parameter array removal**: When comparison shows `remove: true` + array update, you MUST include BOTH actions. Updating descriptions without removal causes duplicate parameters and validation errors. +4. **Inconsistent parameter descriptions**: Always use standards.md exact wording +5. **Missing periods in descriptions**: Descriptions are sentences +6. **Title case summaries**: Use sentence case only +7. **Invented terminology**: Use established terms only +8. **Missing defaults**: Always specify default values in backticks +9. **Incomplete enum listings**: List all accepted values +10. **Vague descriptions**: Include specifics (max length, format, constraints) ## Working with permanent overlays diff --git a/.claude/skills/openapi-overlay-generator/scripts/README.md b/.claude/skills/openapi-overlay-generator/scripts/README.md index 8a4c29388..bec9df23c 100644 --- a/.claude/skills/openapi-overlay-generator/scripts/README.md +++ b/.claude/skills/openapi-overlay-generator/scripts/README.md @@ -67,26 +67,43 @@ python scripts/check_consistency.py --- -### update_sidebar.py +### update_sidebar_v2.py -**Purpose**: Automatically adds new operation entries to the custom sidebar.js file. +**Purpose**: Automatically adds new operation entries to the custom sidebar.js file with rename detection. **Usage**: ```bash -python scripts/update_sidebar.py +# Basic usage - add new entries only +python scripts/update_sidebar_v2.py + +# Validate existing entries and detect renames +python scripts/update_sidebar_v2.py --validate + +# Auto-fix high-confidence renames (≥80% similarity) +python scripts/update_sidebar_v2.py --auto-fix-renames ``` **What it does**: - Parses existing sidebar structure - Maps new endpoints to sidebar categories by tag - Generates properly formatted sidebar entries +- **Validates existing doc IDs against generated .api.mdx files** +- **Detects renamed files using fuzzy matching and pattern recognition** +- **Recognizes common patterns** (e.g., `-1` → `-with-path` suffix changes) - Creates backup before modifying - Reports entries requiring manual intervention **Output**: -- Updated sidebar.js with new operations +- Updated sidebar.js with new operations and fixed renames - Backup file: sidebar.js.backup -- Console report of changes made +- Console report with validation results and suggestions + +**Rename Detection Features**: +- Uses `difflib.SequenceMatcher` for similarity scoring +- Pattern detection for common rename conventions +- Shows top 3 suggestions with confidence scores +- Auto-fix mode for high-confidence matches (≥80%) +- Helps prevent broken sidebar links when doc IDs change --- @@ -118,8 +135,10 @@ These scripts integrate into the automation workflow as follows: 9. Docusaurus gen-api-docs → Generate MDX files ↓ -10. update_sidebar.py +10. update_sidebar_v2.py → Add new entries to sidebar + → Validate existing entries + → Auto-fix renamed doc IDs ``` --- @@ -162,7 +181,7 @@ To add new validation rules to `check_consistency.py`: ### Extending Sidebar Mapping -To add new tag-to-category mappings in `update_sidebar.py`: +To add new tag-to-category mappings in `update_sidebar_v2.py`: Edit the `tag_to_category` dictionary in `map_tag_to_category()`: ```python @@ -191,7 +210,7 @@ tag_to_category = { **Solution**: Copy the exact standard description from `references/standards.md` -### update_sidebar.py can't find category +### update_sidebar_v2.py can't find category **Cause**: New controller/tag not mapped to existing sidebar category @@ -199,6 +218,16 @@ tag_to_category = { 1. Add mapping in `map_tag_to_category()` function 2. Manually create new category in sidebar.js +### update_sidebar_v2.py reports missing doc IDs + +**Cause**: Doc IDs were renamed during API docs regeneration + +**Solution**: +1. Run with `--validate` to see suggestions +2. Review suggested renames and confidence scores +3. Use `--auto-fix-renames` to apply high-confidence fixes (≥80%) +4. Manually update sidebar for low-confidence matches + ### extract-api-tables.mjs can't find spec **Cause**: Decorated spec not at expected location diff --git a/.claude/skills/openapi-overlay-generator/scripts/update_sidebar.py b/.claude/skills/openapi-overlay-generator/scripts/update_sidebar.py deleted file mode 100644 index 2cfccd69c..000000000 --- a/.claude/skills/openapi-overlay-generator/scripts/update_sidebar.py +++ /dev/null @@ -1,205 +0,0 @@ -#!/usr/bin/env python3 -""" -Updates the custom sidebar.js file with new operation entries based on analysis. -""" - -import sys -import json -import re -from pathlib import Path -from typing import Dict, List - -def parse_sidebar_js(sidebar_path: Path) -> tuple[str, Dict]: - """Parse the sidebar.js file and extract category structure.""" - with open(sidebar_path, 'r') as f: - content = f.read() - - # Extract the items array structure - # This is a simplified parser - assumes consistent formatting - categories = {} - - # Find all category blocks - category_pattern = r'{\s*type:\s*"category",\s*label:\s*"([^"]+)",\s*link:\s*{[^}]+},\s*items:\s*\[(.*?)\]' - - for match in re.finditer(category_pattern, content, re.DOTALL): - category_name = match.group(1) - items_str = match.group(2) - - # Parse items within category - item_pattern = r'{\s*type:\s*"doc",\s*id:\s*"([^"]+)",\s*label:\s*"([^"]+)",\s*className:\s*"([^"]+)"\s*}' - items = [] - - for item_match in re.finditer(item_pattern, items_str): - items.append({ - 'id': item_match.group(1), - 'label': item_match.group(2), - 'className': item_match.group(3) - }) - - categories[category_name] = { - 'items': items, - 'full_match': match.group(0), - 'items_content': items_str - } - - return content, categories - -def generate_sidebar_entry(endpoint_info: Dict) -> str: - """Generate a sidebar entry for a new endpoint.""" - # Convert operation ID to kebab-case for doc ID - operation_id = endpoint_info['operation_id'] - doc_id = re.sub(r'(? str: - """Insert new entries into their respective categories.""" - modified_content = content - - for category_name, entries in new_entries.items(): - if category_name not in categories: - print(f"⚠️ Category '{category_name}' not found in sidebar - manual addition required") - continue - - category_info = categories[category_name] - old_items_content = category_info['items_content'] - - # Generate new item entries - new_item_entries = [generate_sidebar_entry(entry) for entry in entries] - - # Combine with existing items - new_items_content = old_items_content.rstrip() - if new_items_content and not new_items_content.endswith(','): - new_items_content += ',' - - for entry_str in new_item_entries: - new_items_content += '\n' + entry_str + ',' - - # Replace in content - modified_content = modified_content.replace( - category_info['full_match'], - category_info['full_match'].replace(old_items_content, new_items_content) - ) - - return modified_content - -def map_tag_to_category(tag: str) -> str: - """Map API tag to sidebar category name.""" - # This mapping should match your sidebar categories - tag_to_category = { - 'actions': 'Actions', - 'compute-envs': 'Compute environments', - 'credentials': 'Credentials', - 'datasets': 'Datasets', - 'data-links': 'Data-links', - 'pipelines': 'Pipelines', - 'workflows': 'Workflows', - 'orgs': 'Organizations', - 'workspaces': 'Workspaces', - 'teams': 'Teams', - 'users': 'Users', - 'trace': 'Trace', - 'studios': 'Studios', - 'tokens': 'Tokens', - 'labels': 'Labels', - 'avatars': 'Avatars', - 'ga4gh': 'GA4GH', - 'launch': 'Launch', - 'platforms': 'Platforms', - 'service-info': 'Service info', - 'pipeline-secrets': 'Pipeline secrets', - } - - return tag_to_category.get(tag, tag.title()) - -def main(): - if len(sys.argv) < 3: - print("Usage: update_sidebar.py ") - sys.exit(1) - - sidebar_path = Path(sys.argv[1]) - analysis_path = Path(sys.argv[2]) - - if not sidebar_path.exists(): - print(f"❌ Sidebar file not found: {sidebar_path}") - sys.exit(1) - - if not analysis_path.exists(): - print(f"❌ Analysis file not found: {analysis_path}") - sys.exit(1) - - # Load analysis - with open(analysis_path, 'r') as f: - analysis = json.load(f) - - print(f"Updating sidebar with {analysis['summary']['total_new_endpoints']} new endpoints...\n") - - # Parse sidebar - content, categories = parse_sidebar_js(sidebar_path) - - print(f"Found {len(categories)} categories in sidebar:") - for cat_name in categories.keys(): - print(f" - {cat_name}") - print() - - # Group new endpoints by category - new_entries = {} - unknown_categories = [] - - for tag, info in analysis['by_tag'].items(): - if not info['endpoints']: - continue - - category_name = map_tag_to_category(tag) - - if category_name not in categories: - unknown_categories.append((tag, category_name, info['endpoints'])) - continue - - new_entries[category_name] = info['endpoints'] - - # Update sidebar - if new_entries: - modified_content = insert_entries_into_categories(content, categories, new_entries) - - # Write backup - backup_path = sidebar_path.with_suffix('.js.backup') - with open(backup_path, 'w') as f: - f.write(content) - print(f"✅ Created backup: {backup_path}") - - # Write updated sidebar - with open(sidebar_path, 'w') as f: - f.write(modified_content) - print(f"✅ Updated sidebar: {sidebar_path}") - - # Print summary - print(f"\nAdded entries to categories:") - for category_name, entries in new_entries.items(): - print(f" - {category_name}: {len(entries)} new operations") - - # Report unknown categories - if unknown_categories: - print("\n⚠️ MANUAL INTERVENTION REQUIRED:") - print("The following endpoints belong to categories not found in the sidebar:\n") - - for tag, category_name, endpoints in unknown_categories: - print(f"Category: {category_name} (tag: {tag})") - for endpoint in endpoints: - print(f" - {endpoint['method']} {endpoint['endpoint']}") - entry_str = generate_sidebar_entry(endpoint) - print(f" Suggested entry:\n {entry_str}") - print() - - print("You'll need to manually create these categories in the sidebar.") - -if __name__ == '__main__': - main() diff --git a/.claude/skills/openapi-overlay-generator/scripts/update_sidebar_v2.py b/.claude/skills/openapi-overlay-generator/scripts/update_sidebar_v2.py new file mode 100755 index 000000000..1ec8474f3 --- /dev/null +++ b/.claude/skills/openapi-overlay-generator/scripts/update_sidebar_v2.py @@ -0,0 +1,377 @@ +#!/usr/bin/env python3 +""" +Updates the custom sidebar.js file with new operation entries based on analysis. +Enhanced with rename detection to catch when doc IDs change. +""" + +import sys +import json +import re +import argparse +from pathlib import Path +from typing import Dict, List, Tuple +from difflib import SequenceMatcher + +def parse_sidebar_js(sidebar_path: Path) -> tuple[str, Dict, List[str]]: + """Parse the sidebar.js file and extract category structure + all doc IDs.""" + with open(sidebar_path, 'r') as f: + content = f.read() + + # Extract all doc IDs from the sidebar + all_doc_ids = [] + doc_id_pattern = r'type:\s*"doc",\s*id:\s*"([^"]+)"' + for match in re.finditer(doc_id_pattern, content): + all_doc_ids.append(match.group(1)) + + # Extract the items array structure + categories = {} + + # Find all category blocks + category_pattern = r'{\s*type:\s*"category",\s*label:\s*"([^"]+)",\s*link:\s*{[^}]+},\s*items:\s*\[(.*?)\]' + + for match in re.finditer(category_pattern, content, re.DOTALL): + category_name = match.group(1) + items_str = match.group(2) + + # Parse items within category + item_pattern = r'{\s*type:\s*"doc",\s*id:\s*"([^"]+)",\s*label:\s*"([^"]+)",\s*className:\s*"([^"]+)"\s*}' + items = [] + + for item_match in re.finditer(item_pattern, items_str): + items.append({ + 'id': item_match.group(1), + 'label': item_match.group(2), + 'className': item_match.group(3) + }) + + categories[category_name] = { + 'items': items, + 'full_match': match.group(0), + 'items_content': items_str + } + + return content, categories, all_doc_ids + +def get_available_docs(docs_dir: Path) -> List[str]: + """Get list of all available .api.mdx doc files.""" + docs = [] + for mdx_file in docs_dir.glob("*.api.mdx"): + # Remove .api.mdx suffix to get doc ID + doc_id = mdx_file.stem.replace('.api', '') + docs.append(doc_id) + return sorted(docs) + +def find_similarity(str1: str, str2: str) -> float: + """Calculate similarity between two strings (0.0 to 1.0).""" + return SequenceMatcher(None, str1, str2).ratio() + +def detect_rename_patterns(missing_id: str, available_docs: List[str]) -> List[Tuple[str, float, str]]: + """ + Find potential renames for a missing doc ID. + Returns: [(suggested_id, similarity_score, reason), ...] + """ + suggestions = [] + + for doc_id in available_docs: + similarity = find_similarity(missing_id, doc_id) + + # Check for common rename patterns + reason = None + bonus = 0.0 + + # Pattern: "-1" suffix → "-with-path" suffix + if missing_id.endswith('-1') and doc_id == missing_id[:-2] + '-with-path': + reason = "Pattern: '-1' → '-with-path'" + bonus = 0.2 + + # Pattern: "-2" suffix → "-with-path" suffix + elif missing_id.endswith('-2') and doc_id == missing_id[:-2] + '-with-path': + reason = "Pattern: '-2' → '-with-path'" + bonus = 0.2 + + # Pattern: same prefix, different suffix + elif similarity > 0.7: + # Find common prefix + common_prefix = '' + for i, (c1, c2) in enumerate(zip(missing_id, doc_id)): + if c1 == c2: + common_prefix += c1 + else: + break + + if len(common_prefix) > len(missing_id) * 0.7: # 70% common prefix + reason = f"Common prefix: '{common_prefix}'" + + # Add to suggestions if similarity is high enough + adjusted_similarity = similarity + bonus + if adjusted_similarity > 0.6: # Threshold + suggestions.append((doc_id, adjusted_similarity, reason or "High similarity")) + + # Sort by similarity score (descending) + suggestions.sort(key=lambda x: x[1], reverse=True) + + return suggestions[:3] # Top 3 suggestions + +def validate_sidebar_docs(all_doc_ids: List[str], available_docs: List[str]) -> Dict: + """ + Validate that all sidebar doc IDs exist as generated docs. + Returns: { + 'valid': [...], + 'missing': [...], + 'suggestions': {missing_id: [(suggested_id, score, reason), ...]} + } + """ + available_set = set(available_docs) + valid = [] + missing = [] + suggestions = {} + + for doc_id in all_doc_ids: + # Skip info/* pages as they're manually maintained + if doc_id.startswith('info/'): + continue + + if doc_id in available_set: + valid.append(doc_id) + else: + missing.append(doc_id) + # Find suggestions for missing docs + doc_suggestions = detect_rename_patterns(doc_id, available_docs) + if doc_suggestions: + suggestions[doc_id] = doc_suggestions + + return { + 'valid': valid, + 'missing': missing, + 'suggestions': suggestions + } + +def apply_renames(content: str, renames: Dict[str, str]) -> str: + """Apply doc ID renames to sidebar content.""" + modified_content = content + + for old_id, new_id in renames.items(): + # Replace within doc entries: id: "old-id" → id: "new-id" + pattern = rf'(id:\s*")({re.escape(old_id)})(")' + replacement = rf'\1{new_id}\3' + modified_content = re.sub(pattern, replacement, modified_content) + + return modified_content + +def generate_sidebar_entry(endpoint_info: Dict) -> str: + """Generate a sidebar entry for a new endpoint.""" + # Convert operation ID to kebab-case for doc ID + operation_id = endpoint_info['operation_id'] + doc_id = re.sub(r'(? str: + """Insert new entries into their respective categories.""" + modified_content = content + + for category_name, entries in new_entries.items(): + if category_name not in categories: + print(f"⚠️ Category '{category_name}' not found in sidebar - manual addition required") + continue + + category_info = categories[category_name] + old_items_content = category_info['items_content'] + + # Generate new item entries + new_item_entries = [generate_sidebar_entry(entry) for entry in entries] + + # Combine with existing items + new_items_content = old_items_content.rstrip() + if new_items_content and not new_items_content.endswith(','): + new_items_content += ',' + + for entry_str in new_item_entries: + new_items_content += '\n' + entry_str + ',' + + # Replace in content + modified_content = modified_content.replace( + category_info['full_match'], + category_info['full_match'].replace(old_items_content, new_items_content) + ) + + return modified_content + +def map_tag_to_category(tag: str) -> str: + """Map API tag to sidebar category name.""" + tag_to_category = { + 'actions': 'Actions', + 'compute-envs': 'Compute', + 'credentials': 'Credentials', + 'datasets': 'Datasets', + 'data-links': 'Data Explorer', + 'pipelines': 'Pipelines', + 'workflows': 'Pipeline runs (workflows)', + 'orgs': 'Organizations', + 'workspaces': 'Workspaces', + 'teams': 'Teams', + 'users': 'Users', + 'trace': 'Workflow trace', + 'studios': 'Studios', + 'tokens': 'Tokens', + 'labels': 'Labels', + 'avatars': 'Avatars', + 'ga4gh': 'GA4GH-WES', + 'launch': 'Launch', + 'platforms': 'Platforms', + 'service-info': 'Service info', + 'pipeline-secrets': 'Secrets', + } + + return tag_to_category.get(tag, tag.title()) + +def main(): + parser = argparse.ArgumentParser( + description='Update sidebar.js with new API operations and detect renamed docs' + ) + parser.add_argument('sidebar', help='Path to sidebar.js file') + parser.add_argument('analysis', help='Path to analysis.json file') + parser.add_argument('--validate', action='store_true', + help='Validate existing sidebar entries against generated docs') + parser.add_argument('--auto-fix-renames', action='store_true', + help='Automatically fix detected renames (uses best match)') + parser.add_argument('--docs-dir', help='Path to docs directory (default: ../docs)', + default=None) + + args = parser.parse_args() + + sidebar_path = Path(args.sidebar) + analysis_path = Path(args.analysis) + + # Determine docs directory + if args.docs_dir: + docs_dir = Path(args.docs_dir) + else: + # Default: sidebar is in docs/sidebar/sidebar.js, docs are in docs/ + docs_dir = sidebar_path.parent.parent + + if not sidebar_path.exists(): + print(f"❌ Sidebar file not found: {sidebar_path}") + sys.exit(1) + + if not analysis_path.exists(): + print(f"❌ Analysis file not found: {analysis_path}") + sys.exit(1) + + # Load analysis + with open(analysis_path, 'r') as f: + analysis = json.load(f) + + # Parse sidebar + content, categories, all_doc_ids = parse_sidebar_js(sidebar_path) + + # Validate existing entries if requested + if args.validate or args.auto_fix_renames: + print("\n🔍 Validating existing sidebar entries...\n") + + available_docs = get_available_docs(docs_dir) + validation = validate_sidebar_docs(all_doc_ids, available_docs) + + print(f"✅ Found {len(validation['valid'])} valid doc IDs") + + if validation['missing']: + print(f"\n⚠️ MISSING DOC IDs ({len(validation['missing'])}):\n") + + renames_to_apply = {} + + for missing_id in validation['missing']: + suggestions = validation['suggestions'].get(missing_id, []) + + if suggestions: + best_match, score, reason = suggestions[0] + print(f" • {missing_id}") + print(f" → Suggestion: {best_match} ({score*100:.0f}% match - {reason})") + + if args.auto_fix_renames and score >= 0.8: # High confidence threshold + renames_to_apply[missing_id] = best_match + print(f" ✓ Will auto-fix") + + # Show other suggestions + for alt_match, alt_score, alt_reason in suggestions[1:]: + print(f" Alternative: {alt_match} ({alt_score*100:.0f}% match)") + else: + print(f" • {missing_id}") + print(f" → No suggestions found") + + print() + + if args.auto_fix_renames and renames_to_apply: + print(f"\n🔧 Applying {len(renames_to_apply)} renames...\n") + content = apply_renames(content, renames_to_apply) + + for old_id, new_id in renames_to_apply.items(): + print(f" ✓ {old_id} → {new_id}") + elif not args.auto_fix_renames and validation['suggestions']: + print("\n💡 Run with --auto-fix-renames to apply high-confidence renames automatically.\n") + + # Add new entries (existing functionality) + print(f"\n📝 Processing {analysis.get('summary', {}).get('total_new_endpoints', 0)} new endpoints...\n") + + # Group new endpoints by category + new_entries = {} + unknown_categories = [] + + for tag, info in analysis.get('by_tag', {}).items(): + if not info.get('endpoints'): + continue + + category_name = map_tag_to_category(tag) + + if category_name not in categories: + unknown_categories.append((tag, category_name, info['endpoints'])) + continue + + new_entries[category_name] = info['endpoints'] + + # Update sidebar with new entries + if new_entries: + content = insert_entries_into_categories(content, categories, new_entries) + + print(f"Added entries to categories:") + for category_name, entries in new_entries.items(): + print(f" • {category_name}: {len(entries)} new operations") + + # Write updated sidebar + if args.validate or args.auto_fix_renames or new_entries: + # Create backup + backup_path = sidebar_path.with_suffix('.js.backup') + with open(backup_path, 'w') as f: + with open(sidebar_path, 'r') as orig: + f.write(orig.read()) + print(f"\n✅ Created backup: {backup_path}") + + # Write updated sidebar + with open(sidebar_path, 'w') as f: + f.write(content) + print(f"✅ Updated sidebar: {sidebar_path}") + + # Report unknown categories + if unknown_categories: + print("\n⚠️ MANUAL INTERVENTION REQUIRED:") + print("The following endpoints belong to categories not found in the sidebar:\n") + + for tag, category_name, endpoints in unknown_categories: + print(f"Category: {category_name} (tag: {tag})") + for endpoint in endpoints: + print(f" • {endpoint['method']} {endpoint['endpoint']}") + entry_str = generate_sidebar_entry(endpoint) + print(f" Suggested entry:\n {entry_str}") + print() + + print("You'll need to manually create these categories in the sidebar.") + +if __name__ == '__main__': + main() diff --git a/.github/workflows/apply-overlays-and-regenerate.yml b/.github/workflows/apply-overlays-and-regenerate.yml index 1f8d800ea..9d0d77e2e 100644 --- a/.github/workflows/apply-overlays-and-regenerate.yml +++ b/.github/workflows/apply-overlays-and-regenerate.yml @@ -23,10 +23,30 @@ jobs: github.event_name == 'workflow_dispatch' steps: + - name: Get PR branch name + id: pr_branch + uses: actions/github-script@v7 + with: + script: | + let branchName; + if (context.eventName === 'pull_request') { + branchName = context.payload.pull_request.head.ref; + } else { + // workflow_dispatch - get branch from PR number + const pr = await github.rest.pulls.get({ + owner: context.repo.owner, + repo: context.repo.repo, + pull_number: ${{ github.event.inputs.pr_number }} + }); + branchName = pr.data.head.ref; + } + core.setOutput('branch', branchName); + return branchName; + - name: Checkout PR branch uses: actions/checkout@v4 with: - ref: ${{ github.head_ref || format('refs/pull/{0}/head', github.event.inputs.pr_number) }} + ref: ${{ steps.pr_branch.outputs.branch }} - name: Set up Python uses: actions/setup-python@v5 @@ -56,12 +76,27 @@ jobs: run: | cd platform-api-docs/scripts/specs - # Find the latest base spec (highest version number) - support both .yaml and .yml - LATEST_SPEC=$(ls -t seqera-api-*.yaml seqera-api-*.yml 2>/dev/null | head -n 1) + # Find the latest base spec (highest version number) - exclude decorated specs + # Only match files like seqera-api-1.102.0.yaml (version numbers starting with digit) + # Support both .yaml and .yml extensions + # Sort by version number (not modification time) + LATEST_SPEC=$(ls seqera-api-[0-9]*.yaml seqera-api-[0-9]*.yml 2>/dev/null | \ + sed -E 's/seqera-api-([0-9.]+)\.ya?ml/\1 &/' | \ + sort -t. -k1,1n -k2,2n -k3,3n | \ + tail -n 1 | \ + cut -d' ' -f2) + + if [ -z "$LATEST_SPEC" ]; then + echo "❌ Error: No base spec file found (pattern: seqera-api-[0-9]*.{yaml,yml})" + echo "Files in directory:" + ls -la + exit 1 + fi + VERSION=$(echo "$LATEST_SPEC" | sed -E 's/seqera-api-(.*)\.ya?ml/\1/') echo "api_version=$VERSION" >> $GITHUB_OUTPUT - echo "Detected API version: $VERSION" + echo "Detected API version: $VERSION from file: $LATEST_SPEC" - name: Extract overlay files from markdown run: | @@ -86,8 +121,9 @@ jobs: content = md_file.read_text() # Pattern to match yaml/yml code blocks with optional filename labels - # Looks for: ```yaml or ```yml, optionally preceded by filename comment - pattern = r'(?:```(?:yaml|yml)\s*\n)([^`]+)(?:```)' + # Looks for: ```yaml or ```yml, then content until closing ``` + # Uses non-greedy match and looks for ``` at start of line + pattern = r'```(?:yaml|yml)\s*\n(.*?)\n```' # Also try to find filenames mentioned before code blocks # Pattern: "filename.yaml" or **filename.yaml** or @@ -101,12 +137,13 @@ jobs: for block in blocks: yaml_content = block.group(1).strip() - # Look backwards from this block to find a filename + # Look backwards from this block to find a filename (use the LAST/closest match) text_before = content[current_pos:block.start()] - filename_match = re.search(filename_pattern, text_before, re.MULTILINE | re.IGNORECASE) + filename_matches = re.findall(filename_pattern, text_before, re.MULTILINE | re.IGNORECASE) - if filename_match: - filename = filename_match.group(1) + if filename_matches: + # Take the last (closest) filename match + filename = filename_matches[-1] # Normalize to .yaml extension filename = re.sub(r'\.yml$', '.yaml', filename) @@ -131,6 +168,11 @@ jobs: run: | cd platform-api-docs/scripts/specs + # List extracted overlay files for debugging + echo "=== Extracted overlay files ===" + ls -la *-overlay-${{ steps.version.outputs.api_version }}.yaml 2>/dev/null || echo "No .yaml overlays found" + ls -la *-overlay-${{ steps.version.outputs.api_version }}.yml 2>/dev/null || echo "No .yml overlays found" + # Create consolidated overlay cat > all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml <<'EOF' overlay: 1.0.0 @@ -143,28 +185,63 @@ jobs: # Append version-specific overlays echo " # ===== VERSION ${{ steps.version.outputs.api_version }} OVERLAYS =====" >> all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml + # Track how many files we process + OVERLAY_COUNT=0 + # Find and append all version-specific overlay files - support both .yaml and .yml for overlay in *-overlay-${{ steps.version.outputs.api_version }}.yaml *-overlay-${{ steps.version.outputs.api_version }}.yml; do if [ -f "$overlay" ] && [ "$overlay" != "all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml" ]; then echo "Adding $overlay to consolidated file" sed -n '/^actions:/,$ p' "$overlay" | tail -n +2 >> all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml + OVERLAY_COUNT=$((OVERLAY_COUNT + 1)) fi done - echo "✅ Created consolidated overlay" + echo "✅ Consolidated $OVERLAY_COUNT overlay files" + + # Show first 30 lines of consolidated file for debugging + echo "=== First 30 lines of consolidated overlay ===" + head -n 30 all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml + + # Count action items + ACTION_COUNT=$(grep -c ' - target:' all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml || echo "0") + echo "✅ Total action items: $ACTION_COUNT" + + - name: Upload overlay artifacts on failure + if: failure() + uses: actions/upload-artifact@v4 + with: + name: overlay-files-${{ steps.version.outputs.api_version }} + path: | + platform-api-docs/scripts/specs/*-overlay-${{ steps.version.outputs.api_version }}.yaml + platform-api-docs/scripts/specs/*-overlay-${{ steps.version.outputs.api_version }}.yml + retention-days: 7 + if-no-files-found: warn - name: Apply overlays to decorated spec run: | cd platform-api-docs/scripts/specs + # Detect decorated spec extension + if [ -f "seqera-api-latest-decorated.yaml" ]; then + DECORATED_SPEC="seqera-api-latest-decorated.yaml" + NEW_SPEC="seqera-api-latest-decorated-new.yaml" + elif [ -f "seqera-api-latest-decorated.yml" ]; then + DECORATED_SPEC="seqera-api-latest-decorated.yml" + NEW_SPEC="seqera-api-latest-decorated-new.yml" + else + echo "❌ Error: seqera-api-latest-decorated.yaml/yml not found" + exit 1 + fi + # Apply consolidated overlay speakeasy overlay apply \ - -s seqera-api-latest-decorated.yaml \ + -s "$DECORATED_SPEC" \ -o all-changes-overlay-${{ steps.version.outputs.api_version }}.yaml \ - > seqera-api-latest-decorated-new.yaml + > "$NEW_SPEC" # Replace old decorated spec - mv seqera-api-latest-decorated-new.yaml seqera-api-latest-decorated.yaml + mv "$NEW_SPEC" "$DECORATED_SPEC" echo "✅ Applied overlays to decorated spec" @@ -172,9 +249,59 @@ jobs: run: | cd platform-api-docs/scripts/specs - speakeasy validate openapi -s seqera-api-latest-decorated.yaml + # Detect decorated spec extension + if [ -f "seqera-api-latest-decorated.yaml" ]; then + DECORATED_SPEC="seqera-api-latest-decorated.yaml" + elif [ -f "seqera-api-latest-decorated.yml" ]; then + DECORATED_SPEC="seqera-api-latest-decorated.yml" + else + echo "❌ Error: seqera-api-latest-decorated.yaml/yml not found" + exit 1 + fi + + # Run validation and capture output to file to avoid overwhelming logs + echo "Running OpenAPI validation..." + if speakeasy validate openapi -s "$DECORATED_SPEC" > validation-output.txt 2>&1; then + echo "✅ Decorated spec is valid" + # Show summary of any hints + HINT_COUNT=$(grep -c "validation hint:" validation-output.txt 2>/dev/null || echo "0") + echo " ($HINT_COUNT hints suppressed - mostly missing examples)" + else + echo "⚠️ Validation completed with issues" + + # Check for actual errors vs just hints + ERROR_COUNT=$(grep -c "ERROR" validation-output.txt 2>/dev/null || echo "0") + WARN_COUNT=$(grep -c "WARN" validation-output.txt 2>/dev/null || echo "0") + HINT_COUNT=$(grep -c "validation hint:" validation-output.txt 2>/dev/null || echo "0") + + echo " Errors: $ERROR_COUNT" + echo " Warnings: $WARN_COUNT" + echo " Hints: $HINT_COUNT" + + # Show actual errors if any + if [ "$ERROR_COUNT" -gt 0 ]; then + echo "" + echo "Errors found:" + grep "ERROR" validation-output.txt | head -20 + exit 1 + fi + + # If only hints/warnings, continue (non-critical) + echo " No critical errors - continuing workflow" + fi - echo "✅ Decorated spec is valid" + # Clean up + rm -f validation-output.txt + + - name: Update info page version + run: | + INFO_PAGE="platform-api-docs/docs/info/seqera-api.info.mdx" + + # Update the version badge in the info page + sed -i.bak 's/children={"Version: [0-9.]*"}/children={"Version: ${{ steps.version.outputs.api_version }}"}/' "$INFO_PAGE" + rm -f "${INFO_PAGE}.bak" + + echo "✅ Updated info page version to ${{ steps.version.outputs.api_version }}" - name: Generate parameter tables run: | @@ -186,15 +313,23 @@ jobs: - name: Clean existing API docs run: | - npx docusaurus clean-api-docs all + npx docusaurus clean-api-docs platform echo "✅ Cleaned existing API docs" + env: + EXCLUDE_MULTIQC: true + EXCLUDE_FUSION: true + EXCLUDE_WAVE: true - name: Generate new API docs run: | - npx docusaurus gen-api-docs all + npx docusaurus gen-api-docs platform echo "✅ Generated new API documentation" + env: + EXCLUDE_MULTIQC: true + EXCLUDE_FUSION: true + EXCLUDE_WAVE: true - name: Update sidebar with new operations run: | @@ -204,7 +339,7 @@ jobs: ANALYSIS_FILE=$(ls -t *-analysis.json 2>/dev/null | head -n 1) if [ -n "$ANALYSIS_FILE" ]; then - python ../../../openapi-overlay-generator/scripts/update_sidebar.py \ + python ../../../.claude/skills/openapi-overlay-generator/scripts/update_sidebar_v2.py \ ../../docs/sidebar/sidebar.js \ "$ANALYSIS_FILE" @@ -256,8 +391,25 @@ jobs: run: | cd platform-api-docs/scripts/specs - # Keep only the latest 2 base specs - support both .yaml and .yml - ls -t seqera-api-*.yaml seqera-api-*.yml 2>/dev/null | tail -n +3 | xargs -r rm + # Keep only the latest 2 base specs (by version number) - support both .yaml and .yml + # Exclude decorated specs, sort by semantic version, delete all but newest 2 + BASE_SPECS=$(ls seqera-api-[0-9]*.yaml seqera-api-[0-9]*.yml 2>/dev/null | \ + sed -E 's/seqera-api-([0-9.]+)\.ya?ml/\1 &/' | \ + sort -t. -k1,1n -k2,2n -k3,3n | \ + cut -d' ' -f2) + + if [ -n "$BASE_SPECS" ]; then + SPECS_TO_DELETE=$(echo "$BASE_SPECS" | head -n -2) + if [ -n "$SPECS_TO_DELETE" ]; then + echo "Deleting old base specs:" + echo "$SPECS_TO_DELETE" + echo "$SPECS_TO_DELETE" | xargs rm + else + echo "No old base specs to delete (keeping latest 2)" + fi + else + echo "No base specs found" + fi echo "✅ Cleaned up old base specs" diff --git a/netlify.toml b/netlify.toml index 39f5d9aa0..9df314beb 100644 --- a/netlify.toml +++ b/netlify.toml @@ -18,8 +18,15 @@ [context.deploy-preview.build.environment] INCLUDE_NEXT="true" - EXCLUDE_PLATFORM_API="true" - EXCLUDE_PLATFORM_OPENAPI="true" + EXCLUDE_CHANGELOG="true" + EXCLUDE_PLATFORM_ENTERPRISE="true" + EXCLUDE_PLATFORM_CLOUD="true" + EXCLUDE_PLATFORM_API="false" + EXCLUDE_PLATFORM_CLI="true" + EXCLUDE_PLATFORM_OPENAPI="false" + EXCLUDE_MULTIQC="true" + EXCLUDE_FUSION="true" + EXCLUDE_WAVE="true" # Asset and image routing handled by Edge Function # See .netlify/edge-functions/asset-proxy.js diff --git a/platform-api-docs/docs/add-labels-to-actions.ParamsDetails.json b/platform-api-docs/docs/add-labels-to-actions.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-actions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/add-labels-to-actions.RequestSchema.json b/platform-api-docs/docs/add-labels-to-actions.RequestSchema.json new file mode 100644 index 000000000..d1359d3e1 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-actions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels add request","content":{"application/json":{"schema":{"type":"object","properties":{"actionIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateActionLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/add-labels-to-actions.StatusCodes.json b/platform-api-docs/docs/add-labels-to-actions.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-actions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/add-labels-to-actions.api.mdx b/platform-api-docs/docs/add-labels-to-actions.api.mdx index a806a20eb..5582a65e1 100644 --- a/platform-api-docs/docs/add-labels-to-actions.api.mdx +++ b/platform-api-docs/docs/add-labels-to-actions.api.mdx @@ -5,9 +5,9 @@ description: "Adds the given list of labels to the given pipeline actions. Exist sidebar_label: "Add labels to actions" hide_title: true hide_table_of_contents: true -api: eJy1VVFPGzEM/itRnkvbbWzS+rSCmISGBoJOPFR9cO/cNpC7hCTXUp3632cnd/RKEexlL4hzPtuf7c9uLQMsvRxNpYY5ai9nPZmjz5yyQZlSjuQ4z70IKxRLtcZSaOWDMAuR4CKYzptVFrUqUUDGzr4vLp4JrsplCweHwjr06NaY92VPGosOGHyZp1xXETgx4xSCIBYcFBjQMc1alvRB0I1xj95ChuTYk4qZPlXotvI1//sWKMqqQKcyoXIsg1oodAT22QoLkKNahq3lwKoMuIxPC+MKCMn07VTudtQbh5TFhzOTb9nnMNVVU2SeiwZHUTJDAcvAaLBWqyyWO3jw7FIf5zfzB8zY0TpuTlDoo2+WuuQ7UHAOuGAVsOjafXDUcyLcS1P9N693CqdAQQXNqLH3JlMQMA0olXzbVBuRXLpySPMMrsJo8JZGmer4PDw9btz1L3EifhvR9oqcTodf3sC1ahGlCQK0NhvKw0k9ZpVTYRslcoakMzeuwoo+Zzw20s/KsMKsiUOxwG9y0Ah1kOQ5oMmxJFidjdoqpwm3CsH60WAAVvUzbaq87/GJqPSVOdLbXXwRNxoC91GcM16Mby4lE2l53vHYU0e6bF+GwRlbdfL3PILIkv752U7oYRNi/Syn2702L56hsDyvA+FMW2XMusKYDmc73qCFifmbOTdlMO+PKuR+qQx9A+YhUlIOdti9bs9I80pHhS3Mj/0DEeHWpzyf+t+/9ods46kVEPelWX+6FJ0TBC/H4oBpvV++/3zGmqkFfA4Dq4HOEbGO1deN1qZyT7I5tT3JeqNZrFiUhKjrOXj84/Rux+Z0z1iFufIw17xSC9Ae3ynzg2v3Js9H3B4d1DXoipFRtGtwivPHbSK6CDlFY2LJ9TylP5lw9L3v0bk72MSb67sJ67m5pIXJ2cfBhoz8l3Lzz0PqGQGirabelcsKloxNMVn9cLg8r5YlMm2PX7ntMKSGR8TEPGJJTW97Efib6FLwvwUudP0= +api: eJy1VcFOGzEQ/RVrzksSKOphTw2ISqiooELVQ5TDZD1JDF7b2F4gWu2/V2PvkoQg6KWXKLHfeN6beTNpIeIqQDkDjQvSAeYFSAqVVy4qa6CEqZRBxDWJlXoiI7QKUdilyHAR7c6dU460MiSw4uAwEhcvKkRlVgMcPQnnKZB/IjmCAqwjjwy+lDnXVQLe2Wl+Agpw6LGmSJ5ptmCwJijh2fqH4LCiSwkFKGb62JDfwFv+fwagME1NXlVCSTJRLRV5KCBUa6oRyhbixvHDykRapaul9TXGfPT1FLpuXoCnx4ZCPLNywzH7qa56kVKKHgcFVNZEMpHR6JxWVZI7vg8c0h7mt4t7qjjQeS5OVBRSbJWrFHag6D2yYBWp3j0P0Suzgq4rclf/LeoD4V0BUUXNqGkItlIYKTcoS/7Vq01Ilq48SSijbygdBGdNyDpOJqeHhbv+IY7ETyuGWnUFnE6+vIMb3CKMjQK1ts8kk85AVeNV3CSLnBF68tMmrqGczbltNcW1ZYc5m5rikO9g3Bt1nO05RslmSu7s3dZ4DSWsY3ShHI/RqVGlbSNHgR7J40jZA7/dphtxozFyHcU548X05hKYyMDzltueK7LL9rUZnHFwJ/9eJBAU/ZfvQ4fun2PSz3b6tfXmxQvWjvu1Z5zZ4Iz5rjFmk3nHE7S0KX/f514G8/5MIddLVRR6MDcRq2T4/ert1oxqVDo5bGm/bS+6Arj0Oc/x6HhyMprwIbetxjQw/fxPpdzZQfi6Lfaottvp+897rG9bpJc4dhqVYdZJftubbQZbkv2uLYANNy9gza4sZ9C2Cwz02+uu4+O80NiGUgVcaJ6pJepAH8j8ZN29y/OBNgcb9Ql1w8jk2if0ivOncSpgTSjJJ2I59DynP7rj17exB/tubxRvrm/v2ND9Kq2t5BiPz1CkzxLS/0OuWdnmsxY0mlWDK8bmN9n+uD89b6YlMR22n9nsMGzbjLizD2S6DoZaRP4N3bzrur/7wnUi sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds the given list of labels to the given pipeline actions. Existing labels are id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/add-labels-to-pipelines.ParamsDetails.json b/platform-api-docs/docs/add-labels-to-pipelines.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-pipelines.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/add-labels-to-pipelines.RequestSchema.json b/platform-api-docs/docs/add-labels-to-pipelines.RequestSchema.json new file mode 100644 index 000000000..6993fddc6 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-pipelines.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels add request","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineIds":{"type":"array","items":{"type":"integer","format":"int64"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociatePipelineLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/add-labels-to-pipelines.StatusCodes.json b/platform-api-docs/docs/add-labels-to-pipelines.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-pipelines.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/add-labels-to-pipelines.api.mdx b/platform-api-docs/docs/add-labels-to-pipelines.api.mdx index 75cb405b4..b86c63e89 100644 --- a/platform-api-docs/docs/add-labels-to-pipelines.api.mdx +++ b/platform-api-docs/docs/add-labels-to-pipelines.api.mdx @@ -5,9 +5,9 @@ description: "Adds the given list of labels to the given pipelines. Existing lab sidebar_label: "Add labels to pipelines" hide_title: true hide_table_of_contents: true -api: eJy1VcFu2zAM/RVB59TJtm7Aclo6dECxYg3aDDsUPTAWk6iVLVWSkwZG/n2kbDdOU6wDhl2KWnoiHx8fmVpGWAY5vpUG5miCvBtIhSH32kVtSzmWE6WCiCsUS73GUhgdorAL0cBFtL07px0aXWLIxPkT4XS57HDgUTiPAf0aVSYH0jr0wCkuVJPkMgFndtoFIZADDwVG9MywliV9EHhj/UNwkCM9HUjNJB8r9Fv5kvqvDijKqkCvc6EVllEvNHoCh3yFBchxLePWcWBdRlymq4X1BcTm6NOp3O1IFo+UJcQzq7b85jDVZVumUqLFUZTcUsAyMhqcMzpPBQ/vAz+pj/Pb+T3m/NB5lidqEoFuO1kvVOiBwXvgknXEIvxdEYOmyf8chwJFHQ2jJiHYXEPErm2NENetBgnLgmiP1OfoK0wHwdkyNNW9H50ey3n1XZyIH1Z0CtKj09GHV3Cdi0RpowBj7IbycNKAeeV13CbjnCH5z0+quKLPO24muWpl2XnOplY54Ds5fLbwsDHukDrKVmHfti6svCHkKkYXxsMhOJ3lxlYqC/hIZDJtj3x4k27E1EBkLcVXxovJ9EIylY7pDduh0aTP97khnLFzLX/PE4hOmn++dV2638SkANvseu/Z8ycoHPfshaFuR3d9X9DnjodqYVPqts1tBUz5reJYKp1jaMHcQcjTDBwK15eLxkCbZLCF/bK/ICKsepPnXfb5YzbiM25ZAWmE2o1A66O3kFxvgxxwrfcT+b/WWturiE9x6AzQciLCqfC69dit7PNrt+5Ass+oESu2I2Hqeg4Bf3qz2/Fxs9/YfUoHmBsepgWYgH+o8I3t9yrTB9weLdg1mIqRyaxr8JrzpzkiugiKojGx5unXJv3JjKPv3x6tv4MZnF7dzNjH7WYtrOI3HjZ0yH8pN/9g8Os0HumsJu3KZQVLxjYx2fVwODQvhiQx7RZfue0xJMETYmYfsCTROy0ifxNdCv4bZcR4gQ== +api: eJy1VcFu2zAM/RWBZzdJt2IHn5YWHRCsWIO2ww5BDozFJGplSZXktoHhfx8o243TFOuAYZcgkR7Fx8dHpoaImwD5AjSuSAdYZiApFF65qKyBHKZSBhG3JDbqiYzQKkRh16KFi2gHd0450spQGInLFxWiMpseh56E8xTIP5EcQQbWkUdOMZNtkqsEvLPz/hHIwKHHkiJ5ZliDwZIgh2frH4LDgmYSMlBM8rEiv4O31H/1QGGqkrwqhJJkolor8pBBKLZUIuQ1xJ3jh5WJtElXa+tLjO3RlzNommUGnh4rCvHcyh3HHKa66sqUUnQ4yKCwJpKJjEbntCpSweP7wCH1cX67uqeCA51neaKiwLe9rDMZBmD0HrlkFakMf1dE1jb5n99pMogqakZNQ7CFwkh921ohbjoNEpYFUZ4k5NFXlA6Csya01X2anB3Lef1dnIgfVvQKNhmcTT6/g+tdJIyNArW2zyRTpYGKyqu4S8Y5J/Tkp1XcQr5YcjNLilvLznM2tcoh38H41cLj1rhjlGyy5NvOhZXXkMM2Rhfy8RidGhXaVnIU6JE8jpQ98uFtuhFzjZG1FBeMF9P5DJhKz/SW7dBqMuT72hDO2LuWf68SCLLuy7e+S/fPMSnANrvZe/byBUvHPXtjqMVkOfTFYrJseKjWNqXu2txVwJQ/Ko6lUgWFDswdxCLNwKFwQ7moRKWTwdb26/6iyYBVb/Ocjk4nn0YTPuSelZhmqFsJUykHG8kNVsgB2Xo/kv9rr3XNivQSx06jMkw4VV53JlvAkF+3djNgoy0z2LIf8wXU9QoD/fS6afi4XXBsP6kCrjRP0xp1oD9U+MH6e5fpA+2ONuwT6oqRya1P6BXnT4OUwZZQkk/E2tCLNv3JHb++jz3afwdDOL++vWMjd6u1tJJjPD5Dlj5zSP8YHJ3mI53VoNFsKtwwtn2TbY+HU/NmShLTfvOZ3YBhXbeIO/tApmmg1yLyb2iWTdP8BmBqeKY= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds the given list of labels to the given pipelines. Existing labels are preser id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/add-labels-to-workflows.ParamsDetails.json b/platform-api-docs/docs/add-labels-to-workflows.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-workflows.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/add-labels-to-workflows.RequestSchema.json b/platform-api-docs/docs/add-labels-to-workflows.RequestSchema.json new file mode 100644 index 000000000..5cb274f8d --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-workflows.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels add request","content":{"application/json":{"schema":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateWorkflowLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/add-labels-to-workflows.StatusCodes.json b/platform-api-docs/docs/add-labels-to-workflows.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/add-labels-to-workflows.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/add-labels-to-workflows.api.mdx b/platform-api-docs/docs/add-labels-to-workflows.api.mdx index 077c2d201..c6f6baf40 100644 --- a/platform-api-docs/docs/add-labels-to-workflows.api.mdx +++ b/platform-api-docs/docs/add-labels-to-workflows.api.mdx @@ -5,9 +5,9 @@ description: "Adds the given list of labels to the given workflows. Existing lab sidebar_label: "Add labels to workflows" hide_title: true hide_table_of_contents: true -api: eJy1VcFOGzEQ/RXL55CkLa3UnBoQlVBRQZCKQ5TDZHeSGLxrY3sTolX+vTPeNdkQBL30glj7zcybN8+TWgZYejmaSg1z1F7OejJHnzllgzKlHMlxnnsRViiWao2l0MoHYRaigYtgOncb4x4X2mx8X1w8E06Vy4QDh8I69OjWmPdlTxqLDrjEZd4UuYrAiblPSQhkwUGBAR0zrGVJHwTmMt5ChhTak4pJPlXotvI19fsEFGVVoFOZUDmWQS0UOgL7bIUFyFEtw9ZyYlUGXMarhXEFhObo26nc7UgWh1TFhzOTbznmsNRV22aeixZHWTJDCcvAaLBWqyw2PHjwHFIf1zfzB8w40DqWJyj0fJtkvcx9BwzOAbesAhbdcx8c6U6Ue81I/y3qndYpUVBBM2rsvckUBExDatq+bTuOWG5fOaSpBldhPPDWlL7p5fPw9Fi861/iRPw2IulFQafDL2/gkmdEaYIATQSoDhf1mFVOhW20yRmS29y4Civ6nPHoyEMrwz6zJg7GAt/JQVJ20Lh0QONjX7BJW8tVThNwFYL1o8EArOpn2lR53+MTcekrc2S6u3gjbjQEllKcM16Mby4lM0lE73j2jSRdui/z4IrJovw9jyA6af75mYb0sAlRAPbU7d6gF89QWB7ZK/dMkz1mXXdMh7MdP6SFiQzaYbeNMPOPemTFVIa+BfMcIYu+P9SvqxpZX+los4X5sb8gIix+U+dT//vX/pDPeHAFxGfTbgFaGZ0ltOlsjQOu9f4V/q9V1o4s4HMYWA20kIhwbLxunTZ9mYLspUXbk+w2msOKPUmQup6Dxz9O73Z83Kw09mCuPMw1v6gFaI/vNPjBwnuT6CNuj3bqGnTFyGjZNTjF9eNjIroIOWVjYk3oeVP+ZMLZ97FHG+/gId5c303Yze0yLUzOMQ5YIP5Ltfk3gqPjI4lnNWlXLitYMrbJyd6Hw6fz6qlEpmn7ldsOQxI8IibmEUsSPWkR+JvoUvK/d4h2EA== +api: eJy1VcFO4zAQ/RVrzqYtLNpDTlsQK6FFCwJWHKoepvG0NTixsR1KFeXfV+MkNKUI9rKXqrXfeN68eTOtIeIqQDYDgwsyAeYSFIXcaxe1LSGDqVJBxDWJlX6hUhgdorBL0cJFtIO7jfVPS2M3YSQuXnWIulz1OPQknKdA/oXUCCRYRx45xaVqk1wl4L196B8BCQ49FhTJM8MaSiwIMuA0wWFOlwokaCb5XJHfwnvqDz1QlFVBXudCKyqjXmryICHkayoQshri1vHDuoy0SldL6wuM7dH3U2iauQRPzxWFeGbVlmP2U111ZSolOhxIyG0ZqYyMRueMzlPB48fAIfVhfrt4pJwDnWd5oqbAt72slyoMwOg9csk6UjE8D9HrcgVNI9uW/lvUJ6U3EqKOhlHTEGyuMVLfpLbs267ihOXytScFWfQVpYPgbBnaWk4mp4fiXf8SR+K3Fb1ejYTTybcPcL1nRGmjQGPshlSqNFBeeR23ySZnhJ78tIpryGZzbl1BcW3ZZ86mxjjkOxj3yo5bl45RsaOSSTvLVd5ABusYXcjGY3R6lBtbqVGgZ/I40vbAdHfpRtwYjCylOGe8mN5cAjPpid5x71tJhnTf+sEZe4vy70UCgey+/Oyb9LiJSQD21O3OoBevWDhu2Tv3zHp7zIfumE3mDQ/S0iYGXbO7Qpj5VzWyYjqn0IG5j5gn3+/rN1SNCtQm2Wxpf+wuGgksfpvneHQ8ORlN+JA7V2Cam24NTJUabKHNYG3ska13Y/i/dlnXs0ivcewM6pIJp8rrzmqztzaA7DetBLbbXMKaTZnNoK4XGOiPN03Dx+1OYxMqHXBheKSWaAJ9UuAXG+9Dok+0PViqL2gqRibPvqDXnD9Nk4Q1oSKfiLWh5236o3t+fRd7sPL2JvHm+u6e7dxt08IqjvHIAvFnBulPgqPTlKSzGgyWqwpXjG3fZPPj/uy8m5XEtF9/5XbAsK5bxL19orJpoNci8m9o5k3T/AVvnHY1 sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds the given list of labels to the given workflows. Existing labels are preser id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/apply-labels-to-actions.ParamsDetails.json b/platform-api-docs/docs/apply-labels-to-actions.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-actions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/apply-labels-to-actions.RequestSchema.json b/platform-api-docs/docs/apply-labels-to-actions.RequestSchema.json new file mode 100644 index 000000000..931dee450 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-actions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels apply request","content":{"application/json":{"schema":{"type":"object","properties":{"actionIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateActionLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/apply-labels-to-actions.StatusCodes.json b/platform-api-docs/docs/apply-labels-to-actions.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-actions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/apply-labels-to-actions.api.mdx b/platform-api-docs/docs/apply-labels-to-actions.api.mdx index 4b2f20c60..bdb408fe5 100644 --- a/platform-api-docs/docs/apply-labels-to-actions.api.mdx +++ b/platform-api-docs/docs/apply-labels-to-actions.api.mdx @@ -5,9 +5,9 @@ description: "Applies the given list of labels to the given pipeline actions. Ex sidebar_label: "Replace action labels" hide_title: true hide_table_of_contents: true -api: eJzNVc1OGzEQfhXL55CkLa3UnBoQlVBRQZCqhygSzu4kMXhtY3sTVqtIfYg+YZ+kM/Yu2RAEPfaC2PE3f998M6l5EEvPR1OuxByU57Mez8FnTtogjeYjPrZWSfAsrIAt5Ro0U9IHZhYsebBgOm9WWlBSAxMZ+fs+O3tEuNTLFi4cMAdWiQxy9ufXbyZ1psocOuHmwKwDD26NEKnZbXw6z/1tn/e4seAEBT/Pm/Kqi+g6MeOUFEFWOFFAAEe91VzjB4I3xt17i5nRtccltfdQgqv486Z/tkCmywKczJjMQQe5kOAQ7LMVFIKPah4qS4GlDrCMTwvjChGS6dMx326RUAeYxYcTk1fks5/qoqGF+mANEuNkBkPqQHh6kllseXDnyak+rMDM7yAjR+uIoIAji75ZYsp3oMI5QS3LAEXX7oPDOWHJPd4S/g9er7SOgYIMilBj700mRYA0otT0ddNtRFLr0gHONLgSosFbHGbq4/3w+JC6y2/siH03rOUKnY6HH17AtYph2gQmlDIbzENJPWSlk6GKIjkB1KYbl2GFnzMaHCpoZUhl1sShWEFvfNCIe5AkO4izI1mQYhvFlU4hchWC9aMBImQ/U6bM+x4esJi+NAeau4kv7EqJQEyyU8Kz8dU5p1LaSm9o8ImTbr1P46CMrULpex5BaEn/fG1ndLcJkQES1PVOn2ePorA0sT3pTFttzLrSmA5nW9qihYn5m0k3bVDdb3VIfMkMb0sC0xgxKQXbZ6/LGapeqqixhfmye8BCiPqU513/88f+kGw0t0LEjWlOwHU6Pc19ao7O80rr3fr9f/evGXSAxzDAMHjFsNFIWN0IdNrMjvp6ajCJFAe4Ii0jpq7nwsMPp7ZbMqdDSNLNpRdzRZu4EMrDK9y8cSZfrPQeqoNLvBaqJGRU+lo4SfnjEmK5IHKMRoUl19OU/mhC0Xe+B1dyb4GvLm8mtATNCS5MTj5ObNBIfzE3/bIk1hAQbTWyp5elWBI2xaSVEfsb92zDYqXtzdRVp0IkPCIm5h40kt5yEegby8XgfwEVAp+u +api: eJzNVcFuEzEQ/RVrztsklIrDnkhRkSoQVG0RhygSk91J4tZru7Y3abRaiY/gC/kSNLaXJg0qHLlEif3GM+/Nm0kHAVceyhkoXJDyMC+gJl85aYM0GkqYWqskeRHWJFZyQ1oo6YMwS5EiRDB7d1ZaUlKTwIrj/UhcPEofpF4NcHQkHFmFFdXi5/cfQupKtTXtPbcgYR15chuqhdTiW7y6rP23ERRgLDnkxy/rXN7uYwy9NdOUFAqw6LChQI65daCxIShha9y9t1jRZQ0FSKb30JLbwXPSXweg0G1DTlZC1qSDXEpyUICv1tQglB2EneWHpQ60ildL4xoM6ejNGfT9vABHDy35cG7qHcccpvqYZWEeIiOhgMroQDownq9kFSmP7zwHdccVmMUdVRxoHQsUJPkYWyWl/B4UnUOmLAM1++c+OKlX0PcFDIL/Q9QL1PsCggyKUVPvTSUxUGpRIn2d2UYkU5eOaiiDaykeeGu0TzxOJ2fH0n3+IE7EJyMGrfoCziav/4AbHCO0CQKVMluqI09PVetk2EWTnBM6ctM2rKGczblxDYW1YZdZE5tike9gnM09TpYdx96xLdix2XGtU1DCOgTry/EYrRxVyrT1yNMDORxJc+S5m3gjrhQGVlK8Y7yYXl0ClzJUesONT5rs1/u7HZxxcCj/XkQQFPnL+6FHd9sQFWBDXT/58+IRG8sdO7DObPDGfN8as8m85ylampg/dzrT4Lr/xpD1khX5DOY2YhUtf6jevmbUoFTRY0vz9umiL4ClT3lejV5NTkcTPuTGNRhHJu+A67R78oLKW+d5qd3T/P1/CzB3OtBjGFuFUjPRqFiXHTrLzWNevwkml84LWLOZyxl03QI9fXGq7/k4bUL2bi09LhSP4hKVpxe0+cue/GOl97Q7WsUbVC0jo9U36CTnj1NYwJqwJhcLS6HvUvqTW379KfZoTR5M8NXnm1uegryDG1NzjMMtFPGzhPjXklQru3TWgUK9anHF2PQmzwwejtyzEYuVDktT7/Yq7LqEuDX3pPseBi0C/4Z+3vf9LymFn9M= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Applies the given list of labels to the given pipeline actions. Existing labels id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/apply-labels-to-pipelines.ParamsDetails.json b/platform-api-docs/docs/apply-labels-to-pipelines.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-pipelines.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/apply-labels-to-pipelines.RequestSchema.json b/platform-api-docs/docs/apply-labels-to-pipelines.RequestSchema.json new file mode 100644 index 000000000..f8b164e3a --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-pipelines.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels apply request","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineIds":{"type":"array","items":{"type":"integer","format":"int64"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociatePipelineLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/apply-labels-to-pipelines.StatusCodes.json b/platform-api-docs/docs/apply-labels-to-pipelines.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-pipelines.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx b/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx index c5ba41988..a441eecf6 100644 --- a/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx +++ b/platform-api-docs/docs/apply-labels-to-pipelines.api.mdx @@ -5,9 +5,9 @@ description: "Applies the given list of labels to the given pipelines. Existing sidebar_label: "Replace pipeline labels" hide_title: true hide_table_of_contents: true -api: eJzNVc1uGjEQfhXLZwK0TSuVU0mUSlGjBiVUPaBIMbsDOPHaju2FoBVSH6JP2CfpjL0LC0RNpV56Qdj+5u+bb2YrHsTc88GEKzEF5fldh+fgMydtkEbzAR9aqyR4FhbA5nIJminpAzMzlixYMK03Ky0oqcF32cUz4qSeNzjhgDmwSmSQs18/fjKpM1Xm0PIzBWYdeHBLhEjN7uPTZe7vu7zDjQUnKKvLvM5rfRVNx2bUhEWYFU4UEMBRWRXXeED4yrhHbzE2Gne4pMqeSnBrfljv9wbIdFmAkxmTOeggZxIcgn22gELwQcXD2pJjqQPM49PMuEKEdPXhlG82yKUDjOLDmcnXZLMf6qomhiphNRL9ZAZd6kB4epJZLLr34MmoOs7ATB8gI0PriKKA3aLXphVIXwssnBNUtAxQ+L8ro8ObNvybH3QUZFCEGnpvMikCNI1LVNzUHEQsESIdYK+DKyFeeGu0T9W97Z8eE3r9hZ2wr4Y1DKLRaf/dC7hGSUybwIRSZoVxKKiHrHQyrKN0zgA164ZlWODxjtqJuloYUp81sVVW0BvvbWXfS2LuxZ6SXEjLtRJLpxC7CMH6QQ8RspspU+ZdD0+YTleaIy3exhc2UiIQm+yc8Gw4uuSUTJPrLQkisdLOeNsSitgol87TCMKb9Odz06eHVYgckNBudrq9eBaFpa4dSGrSv2srA48bGqyZiaHrRtcVUMqvFUdUyQw3TQJTD0UWp2CfuDZdOAhSRYnNzKfdAyZCrKc4b7of33f7dEdNK0Qconor3KR9tF1b9S46zLXazeR/tA/r9gZ4Dj10gzsNa4xcVbUwJ9uOUUnb2pI4sXsLUjGiqmoqPHxzarOh67QYSbK59GKqaAZnQnn4Ay2vrM0Xc32E9dFmXgpVEjIqfCmcpPhx/DBdEDl6o8SS6XkKfzIm7zvbo625N7qj69sxib9eyYXJycaJFV7SL8ambw1Zx5mKdxWyp+elmBM2+aRREfuTdjBZMdNmX+p1K0MkPCLG5hE0kt5wEeiM6aLz3xtNozI= +api: eJzNVU1v2zAM/SsCz26SdsUOPq0tOiBYsQZthx2CAGVsJlErS6okJw0MA/sR+4X7JQNlO5/FOmCXXYJEfJTI9x6ZCgLOPaRjUDgl5WGSQE4+c9IGaTSkcGGtkuRFWJCYyyVpoaQPwsxEkyGC2YlZaUlJTb4nrl+lD1LPOxw6Eo6swoxy8evHTyF1psqcdu6ZkrCOPLkl5UJq8RhDw9w/9iABY8khVzXM27rWNzH1wYy6ZyEBiw4LCuS4rQo0FgQprIx79hYzGuaQgOTOXkpyazjs93sHFLosyMlMyJx0kDNJDhLw2YIKhLSCsLZ8sdSB5jE0M67A0Bx9PIe6niTg6KUkHy5Nvuac/aduWmK4E9EiIYHM6EA6MJ5DMotN9588J1XHFZjpE2WcaB1TFCR5jnZSDHO/A0bnkJuWgQr/d20k0Mnwb/fUCQQZFKMuvDeZxECdcA0Vdy0HEcuESEc5pMGVFA+8Ndo33Z0Nzo8Jvf0iTsRXIzoG6wTOBx/ewHVOEtoEgUqZFeWxU09Z6WRYR+tcEjpyF2VYQDqesJwFhYVh91kTpbLIMehvbN9vzNyPmrJd2MutE0unIIVFCNan/T5a2cuUKfOepxdy2JPmyIv3MSJGCgOzKa4YLy5GQ+Biulrv2RANK7sVbyThFzvn8u9pBEHSfvnc6fS0CpEDNtrd1rfXr1hYVu3AUuPBZNcZ48Gk5sGamfh0K3TbAZf8XnNMlczIt2DWELM4BfvE7dJFBUoVLTYzn7aBOgFmvXnntHc6OOsN+JBVKzBOUbsW7pqFtNlb7TI6LLbaDuV/tBBbfQO9hr5VKDX3GMmqWmeON5JxS5veGndOEliwjdMxVNUUPX1zqq75uNmM7NlcepwqHsIZKk9/oOWdvflmrc+0PlrNS1QlI6PFl+gkvx/nL4EFYU4uFtakXjXPnzzw7dvco7W5N7uj2/sHdn+7kwuTc47DFSTxM4X4Z8PZcajiWQUK9bzEOWObO3lWcH/UDkYrVtotTL3eqbCqGsSDeSZd19BxEfg31JO6rn8DM9OjVw== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Applies the given list of labels to the given pipelines. Existing labels are rep id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/apply-labels-to-workflows.ParamsDetails.json b/platform-api-docs/docs/apply-labels-to-workflows.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-workflows.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/apply-labels-to-workflows.RequestSchema.json b/platform-api-docs/docs/apply-labels-to-workflows.RequestSchema.json new file mode 100644 index 000000000..5636d7f3a --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-workflows.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels apply request","content":{"application/json":{"schema":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateWorkflowLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/apply-labels-to-workflows.StatusCodes.json b/platform-api-docs/docs/apply-labels-to-workflows.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/apply-labels-to-workflows.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/apply-labels-to-workflows.api.mdx b/platform-api-docs/docs/apply-labels-to-workflows.api.mdx index 3a3ff6a58..2bbd1d06d 100644 --- a/platform-api-docs/docs/apply-labels-to-workflows.api.mdx +++ b/platform-api-docs/docs/apply-labels-to-workflows.api.mdx @@ -5,9 +5,9 @@ description: "Applies the given list of labels to the given workflows. Existing sidebar_label: "Replace workflow labels" hide_title: true hide_table_of_contents: true -api: eJzNVcFOGzEQ/RXL55CkLa3UnBoQlVBRQZCKQxQJZ3eSGLxrY3sD0SpSP4Iv7Jd0xl4nmwRBj70g1n7jefPmzaTmXswdH4y5ElNQjk86PAeXWWm81CUf8KExSoJjfgFsLpdQMiWdZ3rGYgTzunX3pO3DTOkn12Vnz4iT5TzhhAVmwSiRQc7+/H5hssxUlUPrnSkwY8GBXSJEluwuXJ3n7q7LO1wbsIJYnecNr9VFCB3p25QWYUZYUYAHS2XVvMQPhBMxZzA3Bne4pMoeK7Arvl/vbQKysirAyozJHEovZxIsgl22gELwQc39ytDDsvQwD1czbQvh49GXY75eo5YWMIvzJzpfUcxuqotGGKqENUh8J9P4ZOkJT1cyC0X37h0F1YcM9PQeMgo0liTy2C26Ta1A+VpgYa2goqWHon3uvMVeIekOT6L/Q9QbxeNDXnpFqKFzOpPCQ2pTLPy6qThgqXxpATvrbQXhwBlduljLx/7xoXyXP9gR+6lZ0guDjvufXsEl37BSeyYUEsA8lNRBVlnpV8EoJ4AOtcPKL/BzQs1DFy00ec3o0Bgj6I73krK96NxeaCB5g4zb2K6yCqEL740b9BAhu5nSVd518IhsulIfGO8m3LArJTyJyU4Jz4ZX55y4JKo31P0oSpvwpiOUMdmUvqcBhCfxn++pTfdPPkhArrremvTsWRSGmrbnn3EyyKTtj3F/sqZhmunAoGl3Uwgxf69GUkxmuF0imDopsuD8Xf3aqqH5pQpGm+lv2wskQuLHPB+6Xz93+3RGrStEGJxmE1zHHbRZVc3+2edab+fwP9qBTZc9PPsePoN7DGsMWtWNPcebxvEO35QWLYrNW5CVEVTXU+Hgl1XrNR3HXUjGzaUTU0WDOBPKwRuqvLMpX6X6AKuDZbwUqiJk8PlSWEn5wwwiXRA5vkbEYuhpTH80ote3sQeLcmd+ry5vRjQCzRYudE4xVpBE9Bdz088LRYfJCmc1qlfOKzEnbHyTBkbsztvefAWmaWmWqxZDFDwgRvoBShQ9aeHpG+ni438Bl1qgwQ== +api: eJzNVc1u2zAMfhWBZzdJu2IHn9YWHRCsWIs2Qw9BgDI2k6iVJVWSkwaGgT3EnnBPMlC281t0O+4SJCIp8fshU0HAuYd0DAqnpDxMEsjJZ07aII2GFC6sVZK8CAsSc7kkLZT0QZiZaCpEMDuxlXEvM2VWvieu36QPUs+7PHQkHFmFGeXi989fQupMlTnt3DMlYR15ckvKhdTiKYaGuX/qQQLGkkPuapi3fa1vYunIPHbPQgIWHRYUyDGsCjQWBClwY95iRsMcEpCM7LUkt4ZDvI9dotBlQU5mQuakg5xJcpCAzxZUIKQVhLXli6UONI+hmXEFhubo8znU9SQBR68l+XBp8jXX7D910xLDSESbCQlkRgfSgfM5JLMIuv/suag67sBMnynjQuuYoiDJc7STYpj7nWR0Dhm0DFTsnvvgpJ5DXSfQkf4PVR+ArxMIMijOuvDeZBIDdTI1wO9bxDGX4UtHOaTBlRQPvDXaN1jOBufH9N1+EyfiuxEdX3UC54NP7+R1vhHaBIFKmRXlEamnrHQyrKNRLgkduYsyLCAdT1i8gsLCsNesicJY5Bj0O2b7jXP7UUD2Bhu3tV3pFKSwCMH6tN9HK3uZMmXe8/RKDnvSHBnvIUbEncLAZIorzhcXd0PgXrpWH1j9hpTdhjeK8IudTfn3NCZB0n752sn0vAqRAnbV/dak129YWBbtwD/jziCTXX+MB5Oah2lmYget3C0Q7vxvGJkxmZFvk1lJzKLz9/nbZY0KlCoabWa+bAN1Akx+885p73Rw1hvwIWtXYJycdhXcN0tos6vaBXTYbLUdxP9oCbYyB3oLfatQasYYyapaf443ykECG2iNRycJLNjL6RiqaoqefjhV13zcLEN2bi49ThVP4gyVpw9Y+cuqfLfVF1ofbeMlqpIzo9GX6CS/H4cwgQVhTi421pReNc+fjPj2be3Rptwb4LvbhxHPQLuGC5NzjUOmiD9TiP8vXB1HK55VoFDPS5xzbnMnTwzuD9zBgMVOu62p1zsdVlWTMTIvpOsaOi4C/4Z6Utf1H61OoOY= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Applies the given list of labels to the given workflows. Existing labels are rep id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/cancel-workflow.ParamsDetails.json b/platform-api-docs/docs/cancel-workflow.ParamsDetails.json new file mode 100644 index 000000000..8f12b84ca --- /dev/null +++ b/platform-api-docs/docs/cancel-workflow.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","description":"Cancel on the Platform side even if it cannot be cancelled on the CE provider side","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/cancel-workflow.RequestSchema.json b/platform-api-docs/docs/cancel-workflow.RequestSchema.json new file mode 100644 index 000000000..6672aa144 --- /dev/null +++ b/platform-api-docs/docs/cancel-workflow.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","title":"EmptyBodyRequest"}}}}} diff --git a/platform-api-docs/docs/cancel-workflow.StatusCodes.json b/platform-api-docs/docs/cancel-workflow.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/cancel-workflow.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/cancel-workflow.api.mdx b/platform-api-docs/docs/cancel-workflow.api.mdx index 474353565..457eabf86 100644 --- a/platform-api-docs/docs/cancel-workflow.api.mdx +++ b/platform-api-docs/docs/cancel-workflow.api.mdx @@ -5,9 +5,9 @@ description: "Cancels the workflow execution identified by the given `workflowId sidebar_label: "Cancel workflow" hide_title: true hide_table_of_contents: true -api: eJy1VVFP2zAQ/iuWnzaptN3WTVqfBhWT0KSBCtMeUCXc5NoanNjYTksV5b/vznFIQ6vCpO0FGue7u+8+f3cpuRdLx8e3fKPtw0LpjeOzHk/BJVYaL3XOx3wi8gSUY34FrIExeIKkIACTKeReLiSkbL4NoKVcQ87uGuxFetfnPa4NWEERF+lz0t8Rgq+NsCIDD5bolDzHB4S1ORAiiY0RfsVfUmzyMOetzJctJ4tQC4+FtIBVvS2gx12ygkzwccn91lCROohXVa9T1xmRQFv4sQC7PVg5AFleZGBl0q29V0vmHpbh1ULbTPj66MuoUx1fJXC8bq0fQ/1J8SslPOVjDqszIPnlgknPEpHn2rM50C8MUHhLMWZyzozVawywIewQ27nWCkSO5Ga1juD8mU63BEk0tpJ7+imMUTIJlzu4d8Sv3M+l5/eQeKzipVd0cJ4Zv6Vs0zoxVkERsIwzOnfgKPbjcET/ur1f/mAn7KdmDQMMGg2H+7gzkbJIGsu+mW/rl1uegXNiCTQUL9tA8dDRXtZEG+AhV7UdW6vtNPYX2x0NPx3osJkVRrcnFFob+RDc4dhZ6bdhSM5AWLCnBU7E+HZGd4QTtNI0X0aHpsO0jPmgmaNB2U5UNag9QRcPdt1MXmEVRqy8N248GAgj+4nSRdp38Iik+lLvefE6vGlNOCE8O7264ESpYXxNAtdi7fJ+1osqNh4M3gsgPKl/fG/G5X7jgxJ0cdPWkudPIjOkclnR4Cx0SB2FjwyJ0mvkSQqZgItgco1Igmu6wuzKgcaRKkzyQn9rXyARUrWu86H/9XN/SGd0NZkIpovzHod5027DDsedWftXyzhq7uHJD4wSuGiQWGiwjJ5pPwkIH3f2cLQN3u2KXIbQspwLB7+sqio6rlcWmSmVTswVzdJCKAdHGntlkR4k/ADbvV29FqogJKd9+vby/2WfHiHdrPiW7owerCS+fyndu2ncWO/Z0Q/hQTrxUOTbXTa72sZ7r2aIXoHA/gK/GjCpWZzcUJo2wd6GpduoI06TBIw/it1dZFeX1ze0BOJXJ9MpxVhBtqS/gawOqoTdEs5KrkS+LMJC5nVOWhmiu3FebJjQ1UE50N4BcaMfIEeLN+p4eiZhquoPfA03lA== +api: eJy1VcFu2zgQ/RViTruAarvdYA86bRJkgaBAGyQp9hAY6Jga20wokiGpOIbAfy+GkiI7NtwusHtJZGo48+bNm6cWIq4ClA+wsf5pqe0mwLyAioL0ykVlDZRwiUaSDiKuSQxhgl5JNhwgVEUmqqWiSiy2OWilXsiI70PsdfV9AgVYRx75xnX1lvSfPgQKcOixpkie4bRgsCYoYcwBBShG4zCu4T3EIY8I0SuzGjF5KMDTc6M8VVBG31ABQa6pRihbiFvHRbpLkFKxVzc4lDQWfm7Ib49WzoHCNDV5JfdrH9RSJtIqv1paX2Psjv4826u+tF7S6bodf8KazPiNxsj5RFAVCWL61VKoKCQaY6NYED9J0pqq4c7llXDevqiKfL52DO3CWk1oIKV5xyOFeGGrLYdIayKZyI/onFYyD3f6GBhfe5jLLh5JRiggqqj54Kp2ccvZbrvEkFJKXCY4awIFvvtpdsb/9nv/+ll8EF+sGBCkAs5ms8O4C6xEDxqKX8c76uUBagoBV8RL8b4N51nRUXVAh8Bjqho79t76276/vt2z2R9HOhx2RfD0UGu7oSqnCiQbr+I2L8kFoSd/3sQ1lA9znlFNcW15v5zNTedtKWE67NG0HTcqTTtN8ODJvwyb13gNJaxjdKGcTtGpidS2qSaBnsnjRNkDLd7lN6MILzlenN9cA0MaEN8xwR1Zu7jf+OKKgwaz9nIQFP3D38O6PG5iZoIHdztK8uoVa8cst4kXZ2lz6p74HiFD+hl4pkJJCn0wqwZlVs0+Mbt0UI1K501e2r/GF6kAZrWr83HycfZpMuNDnk2NWXX9wvfbvBntcA/kzrL9V27ckx7pNU6dRmUYWO6w7UUzfhOggHLPiHvdzAtYs8zKB2jbBQb65nVKfNx5FqupUgEXmpdpiTrQicZ+4qRHAT/R9sCsX1A3HAlsqL9e/n8x1BOgB48f4c75h1eM919S99ttb1m/i5NfwqNw+kM02100u9z2c0/zVMCasCKf8XUBlx2KD/ecZkxwYLE8je7GuZTk4snYXSe7+Xp3zy7Qf3ZqW/EdjyxL/pvB2sxKNpd81oJGs2qyI0OXkz0D9y3nncXkro7S0bZdxL19IpPSGzuRfzMxKf0A7vI3uQ== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Cancels the workflow execution identified by the given `workflowId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-action.ParamsDetails.json b/platform-api-docs/docs/create-action.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/create-action.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-action.RequestSchema.json b/platform-api-docs/docs/create-action.RequestSchema.json new file mode 100644 index 000000000..f20c3e196 --- /dev/null +++ b/platform-api-docs/docs/create-action.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Action create request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"source":{"type":"string","enum":["github","tower"],"x-enum-varnames":["github","tower"],"title":"Action.Source"},"launch":{"type":"object","properties":{"id":{"type":"string","description":"Launch configuration identifier."},"computeEnvId":{"type":"string","description":"Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted."},"runName":{"type":"string","description":"Custom run name for the workflow execution."},"pipeline":{"type":"string","description":"Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)."},"workDir":{"type":"string","description":"Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted."},"revision":{"type":"string","description":"Git revision, branch, or tag to use."},"sessionId":{"type":"string","description":"Nextflow session identifier for resuming failed runs."},"configProfiles":{"type":"array","items":{"type":"string"},"description":"Array of Nextflow configuration profile names to apply."},"userSecrets":{"type":"array","items":{"type":"string"},"description":"Array of user secrets to make available to the pipeline."},"workspaceSecrets":{"type":"array","items":{"type":"string"},"description":"Array of workspace secrets to make available to the pipeline."},"configText":{"type":"string","description":"Nextflow configuration as text (overrides config files)."},"towerConfig":{"type":"string","description":"Platform-specific configuration options."},"paramsText":{"type":"string","description":"Pipeline parameters in JSON or YAML format."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"mainScript":{"type":"string","description":"Alternative main script filename. Default: `main.nf`."},"entryName":{"type":"string","description":"Workflow entry point name when using Nextflow DSL2."},"schemaName":{"type":"string","description":"Name of the pipeline schema to use."},"resume":{"type":"boolean","description":"Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)."},"pullLatest":{"type":"boolean","description":"Pull the latest version of the pipeline from the repository."},"stubRun":{"type":"boolean","description":"Execute a stub run for testing (processes return dummy results)."},"optimizationId":{"type":"string","description":"Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"optimizationTargets":{"type":"string","description":"Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to each pipeline run."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"launchContainer":{"type":"string","description":"Container image to use for the Nextflow launcher."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the launch configuration was created."}},"title":"WorkflowLaunchRequest"}},"title":"CreateActionRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-action.StatusCodes.json b/platform-api-docs/docs/create-action.StatusCodes.json new file mode 100644 index 000000000..5060724d0 --- /dev/null +++ b/platform-api-docs/docs/create-action.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"actionId":{"type":"string"}},"title":"CreateActionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-action.api.mdx b/platform-api-docs/docs/create-action.api.mdx index 67a5d97bb..425b95e2a 100644 --- a/platform-api-docs/docs/create-action.api.mdx +++ b/platform-api-docs/docs/create-action.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new pipeline action. Append `?workspaceId` to associate sidebar_label: "Create action" hide_title: true hide_table_of_contents: true -api: eJzFWG1v2zYQ/iuE9qUDIjvN2r3ky5am3ZAtbYM4xbAFAUJLJ5uNJGokZdcz/N93R4oSZSuxOxTblzYWj/fGu+de1pHhMx2d3kY8MUKWOro7ilLQiRIV/Y5Oo3MF3IBmnJWwZJWoIBclMEc/YmdVBWXK7n9cSvWgK57ARXrPjGRca5kIvMrM3JOzpTBz+3smFoA//Z1RdBTJChQnqou0FXtmr+FhxRUvwIAiZddRiT+QKJCJNILU/asGtYq2jfjdE7KyLkCJhIkUSiMyAQqJdTKHgken68isKmIsSgMze5RJVXDjPn37Itps0EEKUIo2r2S6ojt9UU5lllj9WUOKjBKJPEtDF3hV5SKxto4/arq13lVBTj9CQhcrRZ4xAjSdOstbKm2UKGfRBm2QtUoGjo4iQJvpiWfo/HqKH4xcom1oyKeYzuIFV8RWDxMZYXJoDRtNnByUmPO6TOb7VRbpkFZ9r11aXgydlIlZ7eIgeKMRyUtkUdUG3pSLiwM4njtqBuVCKFkWyCpgyJZzUC4025Beijxnqsagfg0Zr3OjKY7bGGOVEgVXK5YMcc6YLIQxkFpVkcu7wYfa0bLWRhYkldETMAw3qxRJzXK5ZPAJkto6nvh6XfczvvJWKaikFkai4h+uL9kzGM1GR+x+bkylT8dj994jtGlcwidDMmMhx3PIc3n/tRVKurwWar9MyjKWCoVBQOIqjsnu/NyaQ4mlCkgtMGQiJ2DBc3SCQtf1HD/k5mVfwrbXYSG0cPn0tKa/CMM89RGbKo7Bd8TI93xGsmsNlqMGrRtE2sfyXeM91twJg41eVYGuC7zIMo5mp/TkuglrivkrJa07AkFcKU5QJgwUejDnt5CH6JnMWKtKP50qJ8IGmvUw4dDK6oD2qgkgZpkvogCxQz9YfiSo4A9YAhZoOJ+iAvglTLw2yGyafUE1utT9PF2c227Qi5/x7H1fc5SFJ+yZXIBSGAq6IXBB7xLLQuy5/XxAQufcUDGKdQUJhlWyJVFaQhdStlrqwwxogaIrsZil7NfJ+3eUEH+cvb1krgg61gqu63JiGexnfpam2Di4L+hnbho8AyuDHF9msasjngpRlvJQIsFCPlDCtC7GAE4wuUCP2ASA3V4hcnBsPhDgTEwQ6ljou2ce3VKZ6JGGv7CzGCGqVd6HSS7rdOwEj3m6wPyH9Cu0LUZ+secXN/zca9HXL2M6z9DLjGO12TWNzfkCLPblQLj2f1hacHG4mTnaUmIIotZ0z1tMYU5A02L6Kbun81GZ3VshCI5qdViR/L0thnQHnYBVxJVLrC4lok0vSl5PLk8ceNuW6jARREWQ0WsIHIOwHlgQD9lNpcyBlzv83pQWXRw9ccC/DFdmoLCzTGEHQIJzrg3TdUKRkNW5D4omBq4dL96xwIf7zABIOJoUO62+cv/FPPYMKRKaWK/z/JLafnOArVdI3OhPNxgini2A2+5s7exaEvdOpp5iYh3iVZdBlFd4x3ZNtmFCqRQCz7osQrSvVcnSuihW9hVyH9yEk4X4u5009kXG+4D+8f60SdOu6XLtOAulHfpW3mFxeHlMhWQhYLlrxQ1Xs37FfLwlLnisgZAesYXlAl8LXylkhh2Q5fafW4TlGPKL9JDC//h09mgrYLmzi9e6GU3FrKS/APOhC1Dq/YnHHHj6q5yeV/V+qd+c7GJJXUwR31Hq+dUHTTgvE+tv39y3UEWC2Ec5DaW+hQIT4+3030h2d71Eiy2PiaT6W8CMT1eYPaNunMN2xCBMwwHtfkvKcC6aQYOTuyId42aIS9ETbrYfzL3WQKKLMVhgR+wNfkQsLSqH/g54BqbHJfZgbgqn6WDTDbK+nLiZ87qZ0EOKcPnQnW/c5I/TB6puVA2uIFTYdbm+/eT4eHcf8P63Lzf8uy3KEGo9rr3Tj9RHkhdDGr7CiPgXe4rOF7cRvojGELDrgict8IRPGvBGKal2NP9mwLd+ZcRKaWzYL1GfjR3ckloJs7LboleAM6Y6q80cf97RBgf73LmkNRM1QHa9RGfR2G/BiIFa+G1TrXI89FDHKzGysNbh3U6MTuwJ8z07Oyd6dnZ1EZF0r9yEfOn8EqrYuoYk+u2ULYuWCL+4P372ufJx6cKX3ui62029+cSpi+y2Rl2a+WVRt+7pljm0ruko+0uX7nu74eg+dcuJ7lu7OwhutlN6oE83Z4ei+4PxrT+62xpYw4PdOTI8DSe7TlBvDgvsCaao4GtvAAq+98eD7iDspsOlXNv+Bm4IOtbQYa7pJMjpt2buS9s/uZ/bDU7HaLBp6I67Cnx7fLdVBY8H6tPxQM0IakUI9AiNJy/i4+/ikx9unr88ffn89OT70fF3z/+0cSvKTNqwb/K/yR5Kl32JRWkqsOdriAm8MIeJWT9pw1RFF4vc1tBM/tQdoCJN54pnz0c/vBwd+7Gv4GWQRc6qZqW9reG6A9D/bnXe4AVtHKj1EqXd6ZAD1g209Rb8cwI9/LReT7mGDyrfbOizW50T4KVC0/iCD5fxXMMTJu5ZrA8q9gCrnd39guc1UVp8XHAlSL5Faxd4FFuomLt67sTHN8S9u7tTrjZH/sYZzlSVeZI2rApX7yc3BLPNgr+QKd1RfEnZiP+ini6byKFUCunbGrOhnNW2ukWOJwU372P6FoZbq3y7W64CDfFxLMWNfIASH8j7zdBvVBeZ/wOdFRlr +api: eJzFWFlvHLkR/isE98UB5pLWm83OSyLLTqCNbAuSjEUiCFBNd/U0bTbZ5jGjyWD++6LIPjiHpPHC2DxJ0yzWxaqvjjV3MLd8eschc0Iry+8HPEebGVHTbz7l5wbBoWXAFC5ZLWqUQiGL9CN2Vteocvbw96U2X2wNGV7kD8xpBtbqTIBD5sqWnC2FK8PvuVigYt2dER9wXaMBorrIO7Fn4Rof8BoMVOjQkLJrrqBCPuWJTD7ggtT96tGs+K4Rv7WETPkKjciYyFE5UQg0fMBtVmIFfLrmblUTY6EczsNRoU0FLn7662u+2dwPuMGvHq17o/MV3dkWFVVmWdCfNaR8wDOtHCpHF6CupciCrePPlm6t91XQs8+Y0cXakGecQEun0fKOyjoj1JxvBtxqb7IDRwOOylf0xHPhSj/jA+70Eg299OOQzoYLMMTWHiZywknsDBvdRDmbAZfgVVa+rLLID2m17bXLwItlWhVi7mMcJG80InmZrmrv8J1aXBzB8TxSM1QLYbSqULmEIVuWaGJodiG9FFIy49WIvcUCvHSW4riLMVYbUYFZsewQ54LpSjiHeVDVePXh4EPtaemt0xVJZfQErNAmKEVSC6mXDB8x88HxxLfV9WXGV61VBmtthdNmxT5dX7JXOJqPBuyhdK620/E4vvco09VY4aMjmUOhxyVKqR/+EoSSLm+FeVkmZRnLhcEsiKvBlY2fO3MosUyFeQCGQkgCFoPMOm0w33b8ITcvtyXseh0XwoqYT89r+i/hWEs9YDMDKisHjHwPc5LtLQaOFq1tEOkllh8a77HmThps9KoGra+EmrMChMScntw2YU0xf2V0cEciCIwBgjLhsLIHc34HeYie6YJ1qmynUx1FhEALHiYcWgUdvEVzg5lB910UIHbMRn4kqIIvyGABQsJMIn1JE68LspBm31GNPnW/TZfotlt8dN/w7Nu+BsscPjr2Si/QGJGjbQhi0MfEChB7Hj4fkdASHBWjoa0xE4XIdiTqQBhDKlRLe5wBHVD0JZYJxX69+fiBEuI/Z+8vWSyCkbXBa69uAoOXmZ/lOQMWvzBXgmvwDIMMcrwqhrGOtFS1EZSHmgm10F8oYToX10ZnaC3aEbtBZHdXBhmonNXauiFBaGRh71+16JbrzI4sfkUDI6HHdevDTGqfj6PgMeQLUBnmP9QGh6DyYctv2PCLr0Vfv4/pUDg0DKQ8YBorYYEB+yQSrv0/LK1AHG+mdGgUOLFARvdaiynMCWg6TJ+yBzofqeIhCEHlzOq4IvlbVwzpDqu1UC6Wy2WJinm7FSVvby5PI3iHluo4EURFkLHVEEQGaT0IIJ6ym2ktEdQev3cqoEukJw4GrQPjDhR2VhhdBcESrGPWZxQJhZdtUDQxcB15Qc/CePWNAZBBVuIwavVD/DOEYcuQIqGJdS/lJbX97ghbr7yUjf50gy3QhAK4687Ozr4lie/k/Ozaq2O8GjOI8sr5WeiaQsOE1lEIvOqzyKDzRrHcV9UqvIJsg5twshL/6yaNlyLjY0L/dH/apGnfdMV2nKXSjn2r1mHD9PKYCslC4HLfilsw8+2K+XRLXMHQIiG9w5xJYR29UsqMucjtT7dIwgzlRX5M4X96OnuyFQjc2cVb24ymYq7oP4Ss7AOUen/iUSLkv+rZee1flvrj6T6W+GqGhqSeX32yhPM6C/5um/sOqkgQ+6xnqdT3WGmzej/7I5Lj3VZiwJanRFL9rXAOs5VDO+rHuXOtHAiFR7T7HSkTFcyxwcl9kZFxM8Tl4DDO9gdzrzOQ6IZOVLgn9lZUhKVVHdE/As+B6XEJtpnCaTrY9INsW07izHndTOgpRbp86M83cfIXhlR3xmMsCLVWNvbtp5PJ/j7g47+/3/AftyiHUOtp7aN+pP5mwF8f0vAN5H9kT9H74o5XaC3MMawLnrWgJXzWgHfGaLOn+Y8HfNuujJjSLoT9EvPAymLmjXCrsC16g2DQnHlX8undPW1wKnSlpjUTNUBhvURnfNxuwYiBWbTbJm8kn/IW6qAWowBrPd7txehNOGFtz87OiZ6dXV1wkt4qd0O+jH5JVexcQxLb7VQoi4GID5p//tnmyudlDF96o+t+N/XuEaiL7LdGfZq1y6J+3dMvc2hd01NuL136792Go//ULyf6b93uILnZTemJPv2cnYreHozv2qP7nYE1PdifI9PTdLLrBW3NYYk9yRSVfN0agJLv2+NBf5B20+lSrmt/EzckHWvqsNh0EuRst2bxS9c/xZ+7DU7P6GDT0B/3Ffhucr9TBScH6tPkQM1IakUK9Px0cvp6OPl5ePrL7clP059Opqd/G01+PvlviFuhCh3Cvsn/JnsoXV5KLEpTkaFtiAm8IAvgtZ20aapiBUKGGlrof/QHmwFvOlc+5Sejk8npaNLOfRWoJI2iWc1Oe1fFdY+gf97uvAEMWjlQ7yVUWOqQB9YNtm1t+EtCvekdX69nYPGTkZsNfY67c0K8XFiaX3I+LUBafMbEFzbrBxX7gqu95f0CpCfKAJALMILkB7iOkUfBdbdurp5H8cNb4t7f3atXm0F74yzLsHbP0qZl4erjzS3hbLPhr3ROdwwsKR1hSXrGdCKHUi2kb2suQc19KG888qTohm1Q3wHxYFXb76pVouF6HSlu9RdUmw1v/eboN9/cbzab3wEwwRmQ sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new pipeline action. Append `?workspaceId` to associate the action wit id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-avatar.RequestSchema.json b/platform-api-docs/docs/create-avatar.RequestSchema.json new file mode 100644 index 000000000..ef1c14bde --- /dev/null +++ b/platform-api-docs/docs/create-avatar.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Image file request","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image":{"type":"string","format":"binary"}}},"encoding":{"image":{"contentType":"application/octet-stream"}}}}}} diff --git a/platform-api-docs/docs/create-avatar.StatusCodes.json b/platform-api-docs/docs/create-avatar.StatusCodes.json new file mode 100644 index 000000000..4b0f7ffcc --- /dev/null +++ b/platform-api-docs/docs/create-avatar.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"avatar":{"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"}},"title":"Avatar"},"url":{"type":"string"}},"title":"CreateAvatarResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-avatar.api.mdx b/platform-api-docs/docs/create-avatar.api.mdx index b995dc107..73f33de0a 100644 --- a/platform-api-docs/docs/create-avatar.api.mdx +++ b/platform-api-docs/docs/create-avatar.api.mdx @@ -5,9 +5,9 @@ description: "Create the avatar image" sidebar_label: "Create the avatar image" hide_title: true hide_table_of_contents: true -api: eJyVVcFu2zAM/RVDZydpu+2wnJYWGxBsQIu1PQU9MDabKLUlVaLbBoH/faTktE4TpN1NkR7Jx8dHZ6MIFkGNZwqegMAHdZcr69ADaWumpRqrC49AOInPKlceHxsMdG7LtRpvVImh8NoJmrHTGhaY3esKsw7HEYU1hIYEXTcVaQeeRvfW14OSc8p1KJZYxxOtHXIeO19hIbHOCxnSGORVS/oeLJDXZsEwyQZcQc21Ab9WbdvmCk1hS3nvR3ZkblICcK7SRex1ZAtCGnBKhFoSSAqPwVkTUvWzk5P9ji9/73bYz7gKAvl8e2kEn5ChjFrCyx80C1qq8dlZ/k4S5s7iYppdeVQywQ1I1yhBFQS6deX/BHEUaaoE15mEbxpf7cf3oX1X/e1UVkn0r4d0PofysKWOCy4h2kszM1VjCOKCu/wDfbfAow389N7uM/9ywCHbbcqMpQyqyj4zH4EHLBqvifdotlHnCB79pJF5zu5aJrmbJgmW0RKz5JMseTpnurS0sqnORnEcSA412m60FPJP6EOsEyejlkQujEcjcHpYVLYphwEfmedQW/W+8nV8ya4qIJl/diH4bHI1VcJy28S1aJ7067fyKqFUFCoRJpsaQXyTDr+2zlo9UxRHm3sbwzu9OxZS9iOC0q4uMHRgMQsU0Sy7zfdbZr9oeZOyP94emIgol+qcDr9/G57InShdQ/SagRqPjmeH66schC80chVo01uXNLmdb/FSZspXm80cAt76qm3lmhfBi2/4+ARew1w0YttwAELJusqoH3AtzNKuDOInT+BVIwQOfYrbfBs0KQp01IPvrZnM/tV5V5fXNzLK7k+htqXESOKYN387JpKw6413Xojkuycw6x4LViEibuwDGlYi7+iS/GZKvIX/AMxiWXI= +api: eJyVVU1P40AM/SuRz9MPunvKaQvaldCuBFrgVPXgJqaZkmSGGQeoovnvK09SSD9U2FsaP9vPz89pC4xrD+kC8AUZnYelAmPJIWtTX+eQwpUjZJrHMChw9NyQ50uTbyFtISefOW0FDSlcV7im5FGXlPQ4UJCZmqlmQVdNydqi48mjcdUoR0Z57bOCqvjEW0uQglltKJNc64QMa/IS1VJ+APPsdL0GBVINGVJY6RrdFkIICqjOTC7xYWZP5r4rgNaWOouzTkzGxCPPjrCSAlLCkbem9l332XR6PPHN7/0JhxU3XiBfH69bwRdkyKOW+PaH6jUXkM5m6kCSoCBHpm53+VnJBDdiXZEklej5web/kxQUsOZScL1JgoLGlcf5Q+jQVX97laET/fspnS8xP22p84JLinYyzAIq8l5csFSf6LsDnh3gp3PmmPm3Ew7ZXVNSG06wLM0r5bGUp6xxmreQLlq4JHTk5o3sc7EMS3VQphMs4YKSzidJ52kFFXFh5FKtieJYlBow2V20NHIv5HzsEzcDBbP16WSCVo+z0jT52NMzORxrA4ed72IkuS2RZf/JleCT+e01CMvdEHeieaffcJR3CaWjUIkwudQIAtU//No5a/PKURxdP5qY3uvds5C2nxGUcXVGvgeLWTCLZtkffjgyVaglJm1/fASCAlGu63MxvpjOxlN5KVJXGM1WY0Vn97NH9l0Ppjee2BJ1PbiXbnV7H+NClpouoG1X6OnBlSHI6+eGnBhnqeAFncaViLRYBgUFYU4u7vqJtsKsO5ZR/OYJvGyEwKlvcVC7pHmWkeUB/OjOZPnv1ru9ubuXXfb/CpXJJUcKx7rq47EjifvmODBDJN+HsN4OWLRth7g3T1SHAKqny/IbwjKE8A/UylmX sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Create the avatar image id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-compute-env.ParamsDetails.json b/platform-api-docs/docs/create-compute-env.ParamsDetails.json new file mode 100644 index 000000000..d91071126 --- /dev/null +++ b/platform-api-docs/docs/create-compute-env.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, creates compute environment in a user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-compute-env.RequestSchema.json b/platform-api-docs/docs/create-compute-env.RequestSchema.json new file mode 100644 index 000000000..88d0d710d --- /dev/null +++ b/platform-api-docs/docs/create-compute-env.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Compute environment create request","content":{"application/json":{"schema":{"type":"object","properties":{"computeEnv":{"type":"object","properties":{"credentialsId":{"type":"string","description":"Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)."},"orgId":{"type":"integer","format":"int64","readOnly":true,"description":"Organization numeric identifier (read-only, set by system)."},"workspaceId":{"type":"integer","format":"int64","readOnly":true,"description":"Workspace numeric identifier (read-only, set by system)."},"id":{"maxLength":22,"type":"string","readOnly":true,"description":"Compute environment alphanumeric identifier (read-only, generated by system)."},"name":{"maxLength":100,"type":"string","description":"Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters."},"description":{"maxLength":2000,"type":"string","description":"Description of the compute environment. Maximum length: 2000 characters."},"platform":{"maxLength":25,"type":"string","description":"Compute platform provider.","enum":["aws-batch","aws-cloud","google-batch","google-cloud","azure-batch","azure-cloud","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform","moab-platform","local-platform","seqeracompute-platform"]},"config":{"description":"Platform-specific configuration. Structure depends on the selected platform.","type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp (read-only, set by system)."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp (read-only, updated by system)."},"lastUsed":{"type":"string","format":"date-time","readOnly":true,"description":"Last usage timestamp (read-only, updated by system)."},"deleted":{"type":"boolean","readOnly":true,"description":"Deletion status flag (read-only, updated by system)."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"}],"description":"Current status of the compute environment (read-only).","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]},"message":{"maxLength":4096,"type":"string"},"primary":{"type":"boolean","readOnly":true}},"required":["config","name","platform"],"title":"ComputeEnv_ComputeConfig_","description":"Compute environment configuration object."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to the compute environment."}},"required":["computeEnv"],"title":"CreateComputeEnvRequest"},"examples":{"AwsBatchForge":{"description":"A minimal AWS Batch Forge compute environment with Wave and Fusion enabled.","value":{"computeEnv":{"name":"aws-batch-ce","platform":"aws-batch","credentialsId":"your-aws-credentials-id","description":"Minimal AWS Batch Forge compute environment with Wave, Fusion, and fast instance storage enabled","config":{"region":"eu-west-2","forge":{"type":"SPOT","minCpus":"0","maxCpus":"100"},"workDir":"s3://your-bucket/work","waveEnabled":"true","fusion2Enabled":"true","nvnmeStorageEnabled":"true"}}}},"AwsCloud":{"description":"Minimal AWS Cloud compute environment with default instance type and AMI","value":{"computeEnv":{"name":"aws-cloud-ce","description":"Minimal AWS Cloud compute environment with default instance type and AMI","platform":"aws-cloud","credentialsId":"your-aws-credentials-id","config":{"region":"eu-west-2","workDir":"s3://your-bucket/work"}}}},"GoogleBatch":{"description":"Minimal Google Cloud Batch compute environment with Wave and Fusion enabled","value":{"computeEnv":{"name":"google-batch-ce","description":"Minimal Google Cloud Batch compute environment with Wave and Fusion enabled","platform":"google-batch","credentialsId":"your-google-credentials-id","config":{"location":"europe-west2","workDir":"gs://your-bucket/work","spot":true,"waveEnabled":true,"fusion2Enabled":true}}}},"GoogleCloud":{"description":"Minimal Google Cloud compute environment with default instance type and image ID","value":{"computeEnv":{"name":"google-cloud-ce","description":"Minimal Google Cloud compute environment with default instance type and image ID","platform":"google-cloud","credentialsId":"your-google-credentials-id","config":{"region":"europe-west2","workDir":"gs://your-bucket/work"}}}},"AzureBatchForge":{"description":"Minimal Azure Batch Forge compute environment with Wave and Fusion enabled","value":{"computeEnv":{"name":"azure-batch-ce","description":"Minimal Azure Batch Forge compute environment with Wave and Fusion enabled","platform":"azure-batch","credentialsId":"your-azure-credentials-id","config":{"region":"eastus","workDir":"az://your-storage-account/work","forge":{"vmCount":50,"autoScale":true},"waveEnabled":true,"fusion2Enabled":true}}}},"AwsEks":{"description":"Minimal AWS EKS compute environment with Fusion storage","value":{"computeEnv":{"name":"aws-eks-ce","description":"Minimal AWS EKS compute environment with Fusion storage","platform":"eks-platform","credentialsId":"your-aws-credentials-id","config":{"region":"eu-west-2","workDir":"s3://your-bucket/work","clusterName":"your-cluster-name","namespace":"your-namespace","headServiceAccount":"your-service-account","waveEnabled":"true","fusion2Enabled":"true"}}}},"GoogleGke":{"description":"Minimal Google Kubernetes Engine compute environment with Fusion storage","value":{"computeEnv":{"name":"gke-ce","description":"Minimal Google Kubernetes Engine compute environment with Fusion storage","platform":"gke-platform","credentialsId":"your-google-credentials-id","config":{"region":"europe-west2","workDir":"gs://your-bucket/work","clusterName":"your-cluster-name","namespace":"your-namespace","headServiceAccount":"your-service-account","waveEnabled":"true","fusion2Enabled":"true"}}}},"Kubernetes":{"description":"Minimal Kubernetes compute environment with persistent volume storage","value":{"computeEnv":{"name":"k8s-ce","description":"Minimal Kubernetes compute environment with persistent volume storage","platform":"k8s-platform","credentialsId":"your-k8s-credentials-id","config":{"workDir":"/workspace","server":"https://your-k8s-api-server:6443","sslCert":"-----BEGIN CERTIFICATE-----\nYOUR_CERTIFICATE\n-----END CERTIFICATE-----","namespace":"your-namespace","headServiceAccount":"your-service-account","storageClaimName":"your-storage-claim","storageMountPath":"/workspace"}}}}}}},"required":true}} diff --git a/platform-api-docs/docs/create-compute-env.StatusCodes.json b/platform-api-docs/docs/create-compute-env.StatusCodes.json new file mode 100644 index 000000000..d18f36d2d --- /dev/null +++ b/platform-api-docs/docs/create-compute-env.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"computeEnvId":{"type":"string"}},"title":"CreateComputeEnvResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-compute-env.api.mdx b/platform-api-docs/docs/create-compute-env.api.mdx index 91f496ca5..b48f00263 100644 --- a/platform-api-docs/docs/create-compute-env.api.mdx +++ b/platform-api-docs/docs/create-compute-env.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new compute environment. Append `?workspaceId` to create sidebar_label: "Create compute environment" hide_title: true hide_table_of_contents: true -api: eJztfWtz28aS9l9BKbV17CqR9C2ps/6yL0XRPtyINleUncp6XSJIDikcgQCDASQxLv33ty8zwOBCEqTkxKYnVUlEADPTc+t+uqe758tR7M7l0etPR5NwsUxi0RDBjTz6fHw0FXISecvYC4Oj10edSLixkI7rBOLWUd868K0XhcFCBHHTaS+XIpg6o/+6DaNruXQnojcdOXHoTKisE1/lCjheALWl30KdQSzu4ubR8VG4FJGLDfemadMdbrIb3MAHSzdyFyIWEVL+5SiAH/Ch0S584yHZfyQiWh0VO/Nb2miQLETkTRxvChR5M09ETac3c8KFF8dieqxIl1UdZvoTKSKTdDm5Egv36PWXo3i1RKI8eDUXEbyahdHCjfnRL6+O7u9hkCMBFMr4JJyusExhzCsaVWOpykGt1HYQY2l3ufS9CQ1c698Sq/hSpicc/1tMsOAywmGOPSHx7SQbXviF1XuRmPK6CGbeHArQKEM5342xK5VPNnysXkGnt1AC7eJkuL7E6U8Jl3HkBfPSXHayz41ZdKDRyklzE1iG8BEPU9M5555KR9x5MoYGnIkfJlMHaLqB6qLWvwYdxyCp6QyFcD7xmjRffH5yFcdL+brVmoYT2ZTiD1jDTS9s6SFouEuvxdPXMMo9bR7dw4qP5rnOrl01uGTc6fvAh/USR4koDsf7aO4G3p/Uu4rV7TzB4o0Qyh87UsTOeOXIlYzFgukwt9AjULNpo20jxSMKFu7dmQjm8dXR6xcvjktrYXPzVRvI9ZdX7hZq5iJABiSmRZqY0eSoev7sWZmsPBkfAg92q4OFaV0iI6zkoP1ExshMJCxFJ5w5zxtQe47iY2fqyqtjB2pJAliechJGUNkV8MMJskOiMtd6fgifbaf2NPuFNKwn1r3zFsnC8anu1w7WXaQk3f4FMn4uEyGgh8hu3FvZGLvx5Aqe4d+0HeHveRjOfdHwvRnQ54lgAtwifaoLqJ+6jPtnEmUv+Zd+d/1P2TC4k7jO/ZxfC/NnMs/9lH4C+9l44MuZ+dP1Y9eLzCeL0B3nCoQT189VSfxCy2Czrs3jUavnO/V1W+cKY1HsWbnvf21fHzDLf1vPy2hLbTj9RSqOaFcpSVrCCwMtaeRSTICrTRz+MomUsBsCk5zEMD7OVCBWkw7scdzgUvggioHf6QYRymwW0ygpTr1ou4BGGeBMQcZO4jBaOUs3viIuKOEnylsULtFCTD0UqFjrzA9vnZnnC8VDInGeBEOqcXtr7ekUUBk/ga65MQh2MUkQw3nc12DW8N0kmFzpr5aRh0w5hA9uwmsk6R2AOaICugx8Rgot9gcwdC5g3GUo40aUBKqKGsKfFmSLG2650xsXGNj0J+hbA+pr6Poaqj6WNvj0cbruzmCMQZD4FV1zrtwbZvE+IOrp39JTQ7AY/XSjyEXw7oH8ldshrBbOm0epa2CBGzfy3LHPopkIuXH9ZN9KqCzVcgVQwqhkHIa+cIPyhAFeX8FMeTKrBJYhLtJ0mrAq59/hWG18YguPVLWW6lA77rT74xzsVwCeB+Q4/xMxvBf7gjgVchgYj4+qmRIAqRwsidQg6FObsgphEOBSxHZSlrd1D3j4p+ub/TSYILaLetJKrfPCV8R39l3jmtgG19XAunh9Tz0kcuEFLjC97b3QjNzBz5xc4TJqdiXwbehYKiuYmUNNT5slhHxfRYzaRqt3rEbn34Ocg/FCKhHD5UQe9kMtgz68yA90hQAB/vN+Rgr7I4mWdPJu8zJGSbWJD3haRP+QjgRYCqOEE6LwvALbY+RyjjuWoU/yFoUTsj1DQXMW+CExSRr62wj4keNOkHtaAfWDCKgD4UP8Za29dZruptsrERliA8ZGPtLuyZnapmLmJn5MkmGkWMCIqEYb27tawv0DfJmq2cPhv3A0A2aGWC3ackigBuFUSWqY7XpV/wu+pKqh5t7AcafTCLqAGnK51mUYxVvNJy9flNpAirFs0znlwXjtjF68GKWY4n8SUQedXFwpY4NS3//AYgWmiIbLKY6JYjU5ZMDbElUGA3Xs0Xhlw9Dm7ZUHTS69pfC9gAGIAwzakcmYV0PT6cDCguUV3ogo8qawmtAUg9WkpfK6DRK6cO+IyKH3p9hn+JH0hbJqBMliDMRCJ4i6bHsCXUymxlPcSQmlQP8LRJhI3NTZBD5/9iybwf8Ox++pObkTD1Ethlw0NSJVo0QUpu4ctKl/rWtwHWqE7UhmNGeUp3VEswO7mXmWxyvHpKCRTl0FrNQgoT2GnrqT+C3MqGKk98dfCsJ/R6iksQvjSQQ+OTypuKmhghfwkNU9Dkr3gH8+35uGJAOjtn8bOif4cCtQzc8tGircubigj6pmB6DDBK3F6ZJCTheJdacXpc9vQHwuhKyx+lQtZRXrZOioWnCoF2ECi+MJsztgQS0Ucy0Uz69beF7kAv+M6PdoL/3k4ZsuEnNlnd7CA2HO+FsFQ0DohkkE6MG59QAtjoU6EZs6T0Rz3gTWlciGcAHDPVd92018mYuEe8P8HVkuIJ8A0bdatFAU10Wwc81Zjafn7bfdd6nVS6P4ng9TCZOh3tfFgTJZInoQ00sZzuJb4NktprCFYvTGE7dPDbJ7gYwRL65f17kV1nkB6geXYLW0iv50EmbPmy/ufDeai/wsgEw5D/0a7eFXTvv8HS6xeeTCcp7Bom3An/C/qdNr9x1YggtPSpKI8NU63gIcXsOZek1j3ZFuHnvZ7Qyd2JXXBVy0AyKrmvv1rFYJ3681UBt4vO8N3PiqhoECkb6qCvvWOevx6vB91m5Ss45iNunhYqXuYZXoH0KJVuu6s0zkPvD8XQrJO4MPEvsZkhzdvKZVo32xAF22P96nYS6rG8TlvXb/HuP6W4i5O17F6vzC4stDwpfAxWAjdQP8WWcc+Evn02+8/RQ7XL/BsPanpvo4A7VLsAI5S5CHv9i98TdU0DR/rm2f23hqOMYUKF9DW3ADK2bISHlnAt997IsMXSi8bZBQpp+tWeH8bRQmyxpOQsitfiMBfBbOJQhKKKZ8hFTHHKhNHpKtj2dyGLhLeRXGddT/wnJJi25ZLK154k1FS+rPn26fOejQXJQPsBkivcGXhRFUlo+m88n4pu6YmZ6NrVQ1/In+2yBSGsYnmvk9RV+xcEHufxrn5DWDnFtRQKxM4bs88Zr10IID/c8PV3n8oUxacvupe7wGrGvvmeHg/QX8BLRediromfC96Yzgo5EiRzpJQOfwUQJf4yIIg8ZULLBXJvKHCRhhE1m5fKnhMoyzj50n0Dtyj5Qxr0lQavaV/n0vIMMcyX5yh8CVBYO65QRx4d7t3aSyBe7a5HyZ7MwC3w4+GKNMuGEs27AAhxPXXycV85aEtda8lHSJ5nq0FeDKboi7JcwvtQ76//WmXjnvwpheuDzPtx7g/zV72zP0yofYNDrhYuE2pEBfX0R5vnKKQxh2K/LrkpY0DxuhtGGMZearTVvlpDu8uHzTw+2i/7wcnL9/e94dDnsfu/AYV/plpz1od3oXv1++H1z0+r3/7Z7qN4PzXqdb9b60807RVXmBO9y5gv3OXIQNJzK/v8hdGkZq5YRJTAwl1TlzkreK4hHxl2zjZpXir9FGmrlsfvvybC5AFNfyw01Abi+cdr/n9E6xG4lkPZclFjK8AicxjpCQt555QXLXeIHadgPZ/cL7E7cats96zkKIWOaWqDYG/UNSu9rtSXk7mYdLWMpHVh6jJIb9AFXfAJoxnBzbC/dP+JVvHqs1XYkz8xOgTzxCYWS9nNQZoo+DDo4N1heIGLVh+IoqkMkYnjxkt5yp3YFtqNpI2ZUhdpuGPqN9FsFMCRcWYQg9j8idFIeAmDkUZZpg3UVevCKI9Rik6QoV+uqdEoVTgfYKVGkFfTUDSXmLOmyUkJsIzjyCtCj0qRd6JvCwDfibO4MJZ0wh7/po99w+D2+GdzQJZ2SmVdbSZegp9g0V1TsSLNRjMMJM6YLK9j2O2lC9hCqRX7890eZb0LjF++AUeIp2+6171jPFMgxvDOPqlQiqgx6kKsArX0xe/CpWA7fOiTLO3rVAD0AvSg9oDT8KYuwnyeT6cXaCm8Hy4UtnzPWq9jylM66T4CB7T0CMXO87dZk9vjhVDJk3w4PNYl0BhrL0dZ7cPGeYNfamAwHzCKrNfC/6NfLRsnYZeRM60XXzMuLYcTEkaJk2pplpJoW4KBtM3DgvsZtFwEg2/SAkscByAxqH3en5zPeTKMJFKLEUVwzrcSwQRJMbKwsAOoSERZCRVTiP/Q/WWcVMchzHLttFRwRhGFT3zbAEf6DSOrKgq8NNCnUAW9TV1ORmxQoMdobrztDcM9v/7iaERz+JcNQ3BlXthVdn6BTEwCX1FcgqgfCTMIz35QNYlsE1sQEkOa3/2OAKYiLrWhsUzsprmNoeiScV2B+Y/zRCjj09xqtMgdWhepnpdNQS8aQFVOC/Ta57xKsKiCSkoN03yMnFafvwNy5fMsPRhwt3hQIENhlHxi1cfwY7GOnDD/O6fYWKQaaRrAO5DhYmGHT4pktwDWhdtBi5QdEWQ7zWVNwAT4Dtz5YJ6FODKlVGkuZVvPCVkcSNtKdE/T1xngRlIya6ubzh2gyjksRlNdlsyyJ4nmOEmcaGI7eAEfebaeUw3kGFNoZsACsi1JBVrkRrtPjl1c6bvn3e/+WV8+Rt5N54cRiYe8PoD5N1XLQTHjM11TriPieQva2nj3lvE1pqqZsJm5ym5xrh7GKKz5DEwDDGqJPswtJIEZQ+loaNZy79zH33adkurU7Fs5Oy4/IjdG/IBcAYHg5v6blD1s4dnRz+cg8Ae+B3+Ad+mw58D8TKbk/37One4Z/uwXLFhVsHnedkkCqnlZq6Xl+5OpT7l+HehUpd5PrawQuwX42Fn6sTixBsUsJjfRsNF1pZ66eOZWdeBLom1ahqo4DtscAkAz6ZrZU9jaBgezJBBa27cD1/O9VDLoRmC1LrBBYj8IOOPWzMYBmXM9ruBKz6LppnFa7SQxA8b2AdUzeakiddbghcPQgFlzDTJlrbcAyqnDIasK2XDIKsWghHZQKBXwZWRqGjvI0AYGlVLlWCPvabzqcPYxiuxDm7GGabgXh7k8ETKQ6Kj9AuaVHrshXKxlTAbvDlTwnVcQlz/dRRy2eZjH3MG0DfKp91pVM2EeHhOU5D8BY2VT0XVFUhls6ZcCPq3Mf+Brqm8GnDV582bhYmgT9hwNelsl0DYfhTjRzpAZ0Pp+3CCMG0qKNMXJHAXXW4b9N5ry3dxyA0kUs0wls84Zqwlqn6qV0t3RsYF2I6pOHNEooljqA2IOLBikZ+DT/OIRoUiE9B/0YF/u1ezj9YUi/QcarO67WmA7W7wdwLMh+GpjNaTtMNNEo3Bu4izNuAJu/cPvr5mfP2RJsMzW30N6otzCofUW0xQ/NNv2x8/H0oLft7MG7H/RZMWjD5Q4DJbZrfzgCGGcjHPhtZNYIZKu57efpCXt68VGBxHQSlV8wEa/qUcau6kOFS9rGv/cjojLfWybAXxQmARVUkq1UBZ5mM089rmciJNrOUrmnhBiDSpz2Kz4xXdSrDoMqGK6U3R2SgKlCpk+JVidZCCx3fgz/qtNMv1jyhotrWX8jcpRwAf6tMWLWmhbNw7rRBHq6gFmmknlMtLMLA46QkuvYL3BT1DoOVXT5OGSlipFyDbPl0Y7cT+ipCvxtM6aBme/WnUA62li7oCFWSXSy062K+9vPErzUsxbrx5F2PCVTtwMqO9aA8AI/kxdS1qPDOWS96TMtu3102u6CerS6H9LLJ/7ssnwU/DNdod+8csql4SCZZM5VQ2ST79tdueoKyQ5oEVcmvyZj8MoxEhAcLlKzl9xAsv2jsEDVWWm5ls5MPtAua1Ifzs1SSawJXsJcbmNELwxlRUVYyXUq/I6IaAzocnjkT3BXkJEZQ0JAqQocs6YwBpE/jM5NK3sRpNkASIDv1My1F/DVNeJXFlhmoSamHIxP2DnN2pJ2algVrkuGlVxHInYvPX0sVIvPHJUnNgAbqmm3i4lX7vDxoaV5O9TGsTvIbLZ8d1/MSh1X2k2q4YdSl1hsHKHR811vUAwcDNNdIzNP6kVR8KsoogU7nXYnbkd1CufI1i+PYUXsiRs/qhio0Us6U5K7jjM5hSn7DPBuAqFYjbSVc6OwUqgVyL6kX7tdnlxIM+lOWkGXaIW20mFCX1vTGXD2tlGhmidMOKiSMuAujFk6hWnoJbMv3JivF9/C4XfE3goKZU28YXMqE+kuC9NZd4R+BuCFTz6a3n8spKe8aWG0DNEfas9vqN9TBQdqrAdGtNwo8Hy7F5IFeHjBmaSzymig0bcWFOR+SAA+jEbsBo8MkwFxYF5hoNMYw0dh0xkX93Zs6ilLn93b/DGZR5w0EtSwicyzxxhE6XL0emebtx+lhleeh5hTQ+7+jf9Y2c1i2ma8VjFortPsvikYtB6MexKl7YRkorJnhQFNd2/Dy8zeQfMYalC3T2oFp1TCd1j1jx2RXplVCHYE3MBakQcfZnBGC3tZDucUqqW91jNFbTeX36WUJpTMnk8LKE6jqDww3ulKiIGWz0WFaDDu+cYNLapbazREilSFPeLyekjDhnlPis/VuF5tYFzro19hNH2QxZPSRDm0LftfkaJ2L48o3OFkmA9N2V3/8eKQAAhiZs8kGTi4Ve/hfVBJZ6ZXxSs3DI/nmSHl16gK0qBM7pA6LMH5nSmVUZPM4mc/TkDZ51Vvkw0/WaQKptzS7MejQIK6a7dpYdR/A/j6L4RQLOz76hDtPnjVe8hqPozDBRMRXsFQ0zZNwuXoA0VgcdYcsdzmow4PIuwFg2OZ8kTU3xZILGYkmBeZqB9HzJAgdEAKY5tKH11Ln9RwLfwcngK1BVOuCb7mhFPThH7wF0tCxpjXx/hgmXqtAfbcKFHRjJi8wO1uNJfruzdBhLcqJqQjf3sAZtbV9T9VZM2QNq1xkNsVylJrVWw5Lb7GOMFW0yR2PTYYU3rqiWPkqt+A0JzUG9aM0Cap8FLXLYRxqWWPmb4wELIMFBwfiPoctNU20y0G6yNOs6OSuUsO/ZdBJfVvSvcVpCupVMEy/5VMTw3cb6jYlQxpUJhbIHWtsXj2scZq5OnJmie+vGn8krs/xxJGYiQgvneIg6E8f+4brs2qptqOxKtjQBeXTY+oQpvygaEz9Aqoa4VHWzLs7Ng/rtnIEGAf5IwxETd61iyNHdu+U6aKKOS6/BwfVR8qhsA7+r02ksCkd0h65fjnr6osKDbiY3Xc3T8FyFltdb/yyiXdQJYuvGuuAFrK6GXLKCWw0IZ+Uq/4Cz7Y4zStUunc2NHr8k3Lba3BcdUNZMBrUNXjoPc2c2MlsQ9Vju5yOfiw44QJhb6R+m4nIqoiHryIeiLJktRGrjRy+NvKVsqk+JCLMjUAIxYJdM4w8FKWUecjJSmnfHxxBtrbmvbNe5e4mWhe9+cCcMzmMM84dhOiUMwWAw8Fno/ny5agQgobu0gp15NDWIApxKbajmgeNo16+4Igy1usWOHONicyAy0uJdLicif/2Che+8nlSUXRpsicdushhimnqFMorCK2QJ48IwmR+VcyEDxUammgdAMd6qHaOz/K1+O5EEL99IqGYL1QOPu0M+0iZ9IYVGfTM/HhaRTaSqh1S/GDhfl5DPxviG3v/oEXSFkl/00ja3j9o7x+09w/a+wft/YP2/sHDtC7w/YMYpFaFU20gpwWe3xfwtIGcNpBzX5JsIKcN5LSBnDaQ0wZyWrxtAzmtH/JXDOQEFh67XlSpdLXplTM4GdoTAquoHaqidhAMwZ4Q2BMCe0JgTwjsCYE9IThUjYVPCHw5qwSrvZO+czZ8Y5GqRaoWqVqkapGqRaoWqVqk+p0g1STw4jdhdAZtxtUOzdAAm03pm4px5G8uXHl9LsjmV/2NxcSHh4n5fphSOi6+zIAeW28ZC22/ZWhbO9RZ3R2Su3UO45oTOcqy6wxgq26vi/MvLeHbLbIM7wDDKgt5tNbfPK/DR8oH+vnLnE0ojs4JTrYLm7nLb/O3kOmb1HkwCmmknGmCva08QKaCyl9gMwO4WVys6sSFpzfI4Ge5uKRsdMtHzybhqqwJVrILaF7RBTQsLhadgmvNHieVH/spFzDp++0KoB2OsYQBxsEDXq7uojtmzh7hDEtM4EGFywANa05BJbsowLpCoDaPwlu+07lwlxz8j0PlnqF2EzhJkMbF45dDfF8/AA+LNDT9ej0bnaSgKE/C9hPvg1PBjiM1qqdPdU16UVHniOh1vgowZlPB/ITFqYpvPBfz3vRhGRZ0pCRyAfgqd5FOEez9SXQXbrSOw2sRnGpZuF0J1VtUaTLD9tChKsyYLc05cqD7hXLx4ZHA3CLvg07qtVPmDu3cApmaI8/qyYyvQfmG/X7QoaDo98MdQQ5a6v82bLV+QHAJVoxIdYiuBb2HBHptIPp+98N9J/bBHe5BCxKfrlVl2FVlSuFLcl3nU+n6Nb4kbb/kL5m+laZ/0fU+ddw4didXmXnCRDvIBI9TnJSOZ8kNO8yVQvAwTBMG7hsETF3T/agMBuZo8E74XQRY1M7XzbkXU3Oi0h54SaeXEDtZEiXpfMKrZiMHNunSeeWg5XmvZcJfNdSznxgtNDA9lPm8YQin7QmiHyG3vbJx4+V15wIdmKHPSljvYJ1D9B1h5icXEBgl7iX7nAJ9SjC/+KczBaCAk8z7JHXungCZrUSmKTC352e3MvyQZPieTExcV8eHtSn5ltP9dWhvC7Rmsx/GbGaDzGyQ2b4k2SAzG2Rmg8xskJkNMrMo3waZlZmxDTKztwXa2wJ/SKb1iLcFZmZFGoFdbwXE4qZRQ98MuOXWvzpXB+56M6Bx8Z/vzYBSD28zkKYVRl2Thq8d/f5bN6Gsm0h4hXc57nJUfb/pNsHtXEgsoFfjyjP/+33u9rvfeMXd/eab6+43XURHRuQdLpa733hD3H29697uH+G2tsdh9ztimv3wSD02tOE6qvtNF0tZoXVgQgurSubV53ofAthaDjo866uMbJCUNYkfqEn8IFQvGyRlg6RskJQNkrJBUjac/3AR62dCraBkF/ww0OhxskfUkjoFu1iti1woRWkgo4vWXkBX+pzP4B7ivd49GaqTPHaKohO/J8zt8NAOpVwLpfPrVuruSb/VGfw3Yx5Zb+dSKCQLSKHbZUBCaG/5dTcS7ia9zEXCvWH2jhxXn9ql9w5NcV0EO9ec1Xh63n7bfZfd96qwYM+HqYTJUO/rwsDU6/BShrP4Flh2iylsoRS98cTtU4Ps3gNvaqyiP52E2fPmizsfTQj5WQCRch76NdrDr+i6IFhi88iF5TzD6w/nEd+v2Gv3i5cHrWMtwOA1mqnXNNYd6eb55suhE7vyugCLdgBkVXO/9Zjpaw3UBhbve/VcCvCr1A8Z72I96/Hq8H1WbjwdwqOYzQMdUK0OfQg69Nc6tN24pv/aM9vj8qGthZeHBC9tkNCaIKEbWDEqmGRnAt997IsMXaReZykJZfrZmPV1bsg8EFMfz+QwcJfyKozraP+F5ZIW3bJYWvPEm4qW1J8/3T5zO4exK8NH0/lkfLP3DdscYkX/bRAplUEzOrBayBTn5DUD078NpSj67DC+yxOvWQ8tOND//HCVxx/KoiW3B9DHa8C69qAcDt5fwE9A68jICrjWhO9NZwQfjRQ50kkCiryJEj4sdsKgMRUL7FXuclcohk1k5fKlhsswu5cdtAEf/VwpKEfF4HnBvtK/7wVklyPZn14qipF3a6PFtU1w7yaVKXDXJh980S3jhrFsb4nXz1sS1hrzUtIlWuvRVkBR/eJuiQkRsHW6kXZDr5x3YUwvXJ5n8q9cs7c9Q698WET+YoFBbeS9DYPuezKmoEt0kxZTp6SRqvuNEaUNYywzX23aKifd4cXlmx5uF/3n5eD8/dvz7nDY+9iFx7jSLzvtQbvTu/j98v3gotfv/W/3VL8ZnPc63ar3pZ13KjCoDXe4cwX7nbkIG05k+fLkCYzUygmTmBiK6SSfSd4qikfEX7KNm1VKrrUbaeay+e3Ls4nOFXVu4lUewe1+D4NjjdgElljI8AqcxDhBQt565gXJXeMFatsNZPcL70/catg+6zkLIVSeDL1EtTHoH5LaVTcQM0bPny1hKR9ZeYySGPYDVH2DXvBZ/gUd65VrHqtlmJBvUeobmRlZLyd1hujjoKNvKlY3A8NX7H5NtxM/ZLecqd2BbajaSNmVIXabhj6jfRbBTAkXFmEIPY+OHaXOEDOHosol/JFuSdakyYrbkkM89cPDHFBpBX01A0l5izpslFAeE/M+ZeyFngk8awP+hg7jE8YU8m6NV0qRoDfDO5qEMzLTKmvpMvQU+4aK6p0IFuoxGGGmdEFl+55GbageLw9Xd4fvm4AllQ4q/QVbWlPjKiZhqZGAZe+b1/OXrqec+/YkmVw/zk7IfLec4UtnzPWq9jylM66T4HjlO4iR673vfE/t8cWpYsi8GR5sFusKMJSlr/Pk5jnDrLE3HQiYR1Bt5nvRr5GPlrXLCGM3KONBTkYcY7SQiwZG1ZhmppkU4qJsMHHjvMRuFgEj2fSDkMQCyw1oHHan5zPfT6KIgkmwFFcM63EsKNcBvE+voCfIaZBVOI79DxUUMpMdOjzYZbvoLFmBuHW6b4Yl+AOV1pEF3TtYpiQU83UAW9TV1ORmxQoMdobrztDcM9v/7iaERz+J0DkSDKraC6/O0CmIgUvqK5BVAuEnYRjvywewLINrYgNIclr/scEVxETWtTZsjLzCkwrsD4b7RSCCQJzLNC1IqsA2nfZyKYJpZjodtUQ8aQEV+G+T6x7xqgIiCSmkruLo4+K0ffibI9hgB9KHC5dSZsEmwzIu/PZnsIORPvwwr9tXqBhkGsk6kOtgYYJBh2+6BNcwjrjFyA2KthjitabiBngCbH+2TECfGlSpMpI0r+KFr4wkbqQdJervifMkqIjWgWl4w7UZRiUV9rbRIsJ5WExGmGlsOHIY+uk308phvIMKbQzZAFZEqCGrXInWaPHLq503ffu8/8sr58nbyL3x4jAw94bRHybruGgn5Nx0a3TEfU4ge1tPH/POJoXsbGTnmZ5rhLOLKb7aC1ydZBeWRoqgjCRu5tJ/Qk5wYeCvKmKhaqaryLs0kG3zWw+HeCRst84msBbgbTLT7OGDwKfBpr6+zuvAe+Dpuq43ftnEbDgJZkvIabSu9pcsFDT10trKO8UE1dTcy4q1JuQTZ3pqLDBql4+fodK9rbT0OE2Exfwe6kaKRIO6Bg+9p2mPnQ9At0o2Be2yl9xYMBAkQY3U24NoexB9ICc89mTZniwf/snyVzrlfQgkdiMQQrHgpBMGPi6Z8pGTldzRHnw8tLbmva1xuZAJlXGGJNQj6sI5jDPOKcZaFS4AnJ+fwUNnNF++HGlrmpepswp15NAW4HNciu2oBqxDzDPq5QuOyJPOzDeeR2bA5aVEOlz2ELy9woWv/EKJ/CRIjVDHGoyQVStV6ei8A1ohrU0EYTK/KnroQYXGsUAdADekL7VZJNMjfXciiN8+kVDMF+psQKf5eiQL/7DCsm/a7dVph2ns/RvVMVaYvoY6ZjOd2kyntQ3JNtOphYt/eabTLzaphk2qsY0Sm1TDJtWwrPurJtUo8WHtE8ZZEr9xPryecxbbUr1jyJ2GTzxhRv6UlBXjIhrDmI4H95Hra3P6JnaM3gA1ppysw2UHt9159ZZDXlJlc05j+QYny2RgZlOpP348Up3Bh3RylIcrmcTrnTT0+ePsEK1EZDoLwfOGVFdmNV6pedggpDaSrspp74ZN0myNBQQtE1Mqo9yoQabNU/+5teKvfIKkLUHsWaiNHlx1c2dxWXb1hMKOjwfQzpNnjZe8xkELTqAT8gqWiqZ5g5StQzQWx8MD0hyadQVz1aZYciEjqQUsAlSJnSdBCGof+gS6PryWOofIAyV73VM9bii1reMfhVvpbPqdH+TExuZ7/Y7PqTYA39JEvRk6nPTVidnshMOlsnfJ9K6iTXC5qspFlgK97BJnwfUhgWt7jFZNm9zxlochHWOsyDE/f8mDWLien+W/wggClCYsPLXtW2UE1K4hcahljZksIhKwDBbsiYj7HLbUNOFkXcamTA/t6RBhO+UYAqFPHNK9xece9SoYpt/ywRie1ChsAHWbkiH1YBML5I41Nq8e1jjNkhU5s8T3V40/Etdn5+VIzESEBjl1x9zHvnEEpVrK1gdx4yan0CV3SLW1aOG0dMGGLiifHlOHML6IXD/1C6hqhDdvzLy7Y9MLaCtHwAtIf4SBqMm7UuXYtMVWPMw78tk71S0U/z6guL1T3d6pbu9Ut3eq17Hr2DvVv+Frruyd6lYbt9r436ONH4hlz96p/jXuVM/Uwt5J3zkbvrEXK1h18lDVyQPhhPZiBXuxgr1YwV6sYC9WyCzFSeDFoM+fQZtxtb0AGuDzdfqm2pEUvrlw5fW5oHPh6m+s0nhISiNe4WBG1fhJtLAQ2EJgC4EtBLYQ2EJgC4EtBP5OILAFpgcMTH9NxpQulwInv4uQb+u782MjTXat3t7F3MrmHA7QLsjFD+dnqS+PJnAVJlHj+p+ygXgHHe+Ue4+UfkdEdVxNh2fOBHfFLD1SyR+x8E1SGmtR4gx8ZlLJ8p/hNJ6DL91JDXZn1JCWIgGonVQNtGJIXYUmRybvGu7oX2s0XXSwrfA5NERgDtmspQrZ6+OSpGYgzaqnEBcuXrXPy4Om93NHfQyrk4J8vFJKz3qnebDKflINN4y61HrjY7eO73qLerB7gBngJWZw+EjpZagoA0xCsK7E7ciRmSrtQvXiOHZ0uj688KKhCo2UJkPJD53ROUzJb6ih9N1gNdJpdhYa16sWKKqh3i1s/SyqQYHxZdohnTBnQl1a0xtz9bRSopklTpVvSNn1ZRACDuOXwLbQc0TxPYxh+aY9XgZprzKPF3ZCnKI7co1AvE3Jd2HM0isi11wOpiMrYc6HJMDDaMS3M2Ae+8CLYV1A5YhkQYuQZXc8Ranze7t/BrMYJZyDSsZuRNmkiTeOMAXR65zb/+P0sMp7THMK6P3f0T8LsA8JYNtAv+/YAlhYBgprZjjQdHvZ8DIfF6EuZfl1mAKOHQ4CrJ5m9TSrp1k9zeppVk+zeprV06yeZvU0q6dZPc3qaY+lp323etJ2dcIyrYNjWjWSdO5+KRCNAGPdemj2Ql0mbho1qB9bo+XqBLXhIfWaqCOTys1Zgd/+2rX2FmtvsfYWa2+x9hZrb7H2FmtvsfYWa2+xqou1t1h7i7W3WHuLZVp/sb0FjSamVULlFWxgxFTDwdt/9rLDmFVqG8x2E8tWO82uNpjjnYw0HwLvxnUw0EWn2bXBsdY0c6CmmYOAADY41gbH2uBYGxxrg2NtcOyhwv1CcGwb9qQXOYOToUWnFp1adGrRqUWnFp1adGrRqUWnFp3+3ei0H7pji0stLrW41OJSi0stLrW41OJSi0stLv1bcGnuE2onuwBtCvuiw3eXVQ11yiHwu0bsUcP5JVPyZFQ3Czr4tYzdxRIv4gVRF0KRY1iUMbIuRp1aCsv4w3L6iDScQY1OQlWuIYNfTitJkY9Mh0QH5p3IUPflVS6uzS3q6/zQdTNOgDX67rxOi/x5VbeL7ZW0lrVfai/kznm3fdF79xY+aX9s987aJ2dd+Pu0e9ZVj7vn5+/Pu6fwV+/dx/ZZ7/SovGZhXTeHTCWu6KL7bBSRVyz3Wgn6Kr/ZbCyemp7Sa2gsE3Zc/9PPKIMBFLl8/SeI0jMRzNHD/NWz//yl6GBNkspbuNGqxrSbYiQbn8vc9r4scaJOxXjkUTizc7UVxsKvd0FjNaL45RUv5RwvxBpweqh2vKWRgL+U3jxIIxzKVJZZ4iTt9NGx+cNcN8TWstHBK9RgC5Ij4J2L2hP1oX0rs5shy173bQdkL0yLTzF1+Utby6NJftJ0RRvifnXRm7o/tHlkyDSD5FRcHrm3kq8Sa0yQt6RS2niDvc20CbwK7YjigPAD40XDm5Zmv79PP45VJ/ja0hnys/SKbB2bofpHE6HVQe13dySSxi2MeuPFkXETrlo3w8H7C3gMA8x+x0fPjgi1ql+AFI9Mp9Aj+VKHPY2TybWIW3TfesFb7gj3x1HZzU4/D26gi+oKtcJLFJfHuCA6qEeW14I5gvTJ+rHTF9Nn94lDl2kM2/1erYVAuiwvhK9GRWGFUZM7rbAtE75t6njAOSiUluT6MVeRo9zh/BW0dTfg1mHnu93NLfg1aTEG32x43firbzZMQXoJPE4CwnGaiPw8zGX1FpLLMNZyO7ed+FFxM7EMyiZvy4bJDdgeqxUqmeMFjnVncOveeUSCytO4cRttn0ZjJ+00iYp74WWRmwRayj6MWyX3E2jb2Vh2OeZGRvYYlJisLGt2LTOjT2pNAt0onxt+9089/EoCNlS4pt5MqZxLbyr/+VnuJm8d7rDLRgOx1L2Wm4UShfyvGzs1ZIrmWjJIXMttEmi3Jo1ZwroNO8RfJnMKXvzckA5uVaq1EcrM77MH1SG+/JWKydPLYTdkYrLTt9cbNq7iXUbUcOql/zgzP78WNXjnQ9o3eSY0tm0ZfD2e+W0vhmyI16+GimQYpfEvhyfXXQqYXmDDUnho48Y6wJa2rQOiZv0iyCabJldPkU6+cFRKnOAuvQa/ff3Lq1cvj4zcCUcN/Oek+7b3zul0zy96b3qd9kWXnv5f8Pv7D+eXxuP/C+hF991p6ePHXEDlSPujnBiioPOjqpB2c0Tu+R9Tn1byKAKqwkDycnsB2ldp1b3/lUc8VtZhMn8z6mz9W3KglZxciYW73UacLbiqG71zFo6SJs90qm3yqorSE3fqRErj34Fk08agbTeft+WTMYw86zvRjaIwKlH+smKMoWa2xgShSmIA9NxTUPkkibx4Rda3E+FGImonOL2fyMi7EPFViJsFz2yRSDX1ZiqHdD9IqiSJfGNjwH5oEnjNzlbLZ3L0xhmoraogdHvQI6ucpnCIA8qDY9KZjg+2iKTQZ2jnoo/gCf/xRpuR/n0bU89xopT95iScrrpsvymzrSLbSG2Tip+tOUNIH68zuaQ8hlkYJT9QhT5nQYZZPfkzQqNZ3JfBmsc9pWZcFOyqqrL/DsfnoZ97kx5MFl8Yp6P5hxWVTHxPMYn0kYGh0pHJeXUYz/M+D6XW2JbzrCLW+1nhrOnTl9IsKeGUr1RD5fQEhrjX59pweo0JiF/54fxtFGL6DWPtFJwdjCMBqn4YuEt5FeIdtKrVLXauZ4aVC/6eL5MCFZ6xEgprjQLdhzFwCDFfIZ/rDi8u3/SwflJK88v+ZjnJP5DJGOR1oU69a6nnhXczeddXUinrtrx7V5gpeMTHzNCfqQdMTor3gT6MSA8EJi9+FauBm19ZxOFOCJQV2hZjeQK9vU5rHnvTgYgmsFyI3eIKmkmWDmkbs8LOhwelDvB+Kww6P2wvvEJ5ICIM45QGMZEVC8GN9AlzoVY3WvzyqrKl6u1+r5bPFEQFyPYJzf+X+9xZgvFtZqX/9Ay/8YJZSCtPX27L7Br58zZOrvCGVB+jyHQnJDLzUsKUDSA1PXyHzf6/7AWe3iLso3aeN//z5+Yz7R+1cAMDX/LcVYHHIrlfMhmuSknHdQJxW3le4LSXS4H5T/4rxT296YjSKXGLeNBgQlUvgNrSbyn7Fux6NNmrPYw/0dHIo/hsGpEvSsKmpxEsYT+zGw0+//Jl7ErxIfLv7/ExyK+IhTdsEbUiZiCqiqd4Zl9/S2kKQPBE3sTxSMLNPBHlHYYmalSqkDh1D/2GtvbsWiBXMUbNYMMk4vUZNqEO5siIrqFTXLTDpDdoWWdlS7ALXR24BOBesYw3fmuim8H7IXK7MeAAAl/hFMtE7i2eksF/gc7jozBz8qBnX2CnBPOEtw/XibjCzcOSAgwxTzndYGVQCBNLX1yE1yKAydXjFuNvIBcq//9pcoDX +api: eJztfX1v2zi291chPLi4DWA7adod7O0/9zqO2/VO0vqJ0xZ7e4uYlmhbE0nUkFQSt+h3f3AOSYl6cSw76c6k1QKDbSzxVeQ5v/P+taPoUnZefep4PEpSxXosvpGdz92Oz6QngkQFPO686gwFo4pJQknMbol5l7D4JhA8jlis+mSQJCz2yey/b7m4lgn12NifEcWJh22JWhUakCAmlGTvEo/Hit2pfqfb4QkTFAYe+9nQQz3kKL7pdDsJFTRiigmY+ddOTCPWedVxxu10OwFM+4+UiXWnvJiP2aBxGjEReCTwWayCRcBEn4wXhEeBUszvmqnLugXr+aeSCXfq0luxiHZefe2odQKTCmLFlkx0up0FFxFV+qdfX3a+ffvc7Qj2R8qkOuH+GtqU9rxmULOXpl2n28GxYwWtaZKEgYcbd/i7hC6+VufD578zDxomArZZBUzCUy/f3u3vCobbRUMJHyh7XSoRxMvKbg/z1519JgsuareVpmoFL+mF9MkF+yMNBJOE3QVSBfGSeCFPfZIIfhP4TBz+YzIkzpT6ZMoY+aRPjfvg87OVUol8dXjoc0/2JfuDCdoP+GESUgUfp0eT4FBvcM9pd9DvfOt2uFgWFrvxu8JHpf67OFx3XimRsvJ2vBNLGgdfcHU15488g+Y9HofrLpFMkfmayLVULNLzcA/5I8zmvquwbSoBziCid2csXqpV59XxcbdyFu4fvu6I0zBZ0S2zWbIYSATzy3PSpKAwq+dHR9VpFafxPg7+SBmBxngugVTV0rjzVCq47jKQivAFed57fnRUmHGX+FSuuoQLksY+E9LjghFvRQX1gGDhLAujF7fwaPtsT/O/YA6bJ0vvgiiNSIh9vyLQd3km9uyXp/G3bZOwX852kN1HoIIsTiPgKfRW9uZUeatOF/+NN7fT7Sw5X4Yse2T+tE/pl1TkD/Vf9tn132Uvm3O3w64Lfy6vmftnuiz8KcNURO4PoVy4f9JQ0UC4v0SczgsNuEfDQpdIRCzrzB58/oaEeREsq1R9YqmNTJgXLAKP6DdTYQjeVInUU6lgxGfAUSXhMX5kyULmwZm348BW30+qgVqcBmI7kQY6QPxAME9xsSYJVSu8CVJxeJ8AgRER8wMgqtDrIuS3ZBGEzJwjwS7SeIo9bh9t4PuEEv0LUSuqCLtjXgqcNtBrjRe9kKaxt7JvJSKAi8lJEN/wa5jSW3ancBaJ4B6TklnSPxGM0NgnCZeqJ9LYdNGAAeApO9QDH1L/hsYe839JBOvR2O/Z/nqmP01x4NfHWTpdKCYIDcOapZEVvdHXPGSK+X/KSh3i4qyTCkEBYgWKRXI7eLAE+v5dGjn84IaKgM5DTZ5xIjc0TPftBNtiLytGXRY65zxkNK5+sCQJ10StApl3ojge0uwzQVfkdz7Hfg01eKSuLWX/nc/hpn3TmDEQzAcCi7tpN+Rzt6MCFTKkzkBSRvHNB9NvhevU7o6E4YHTm1tYx1aQy5rZDTMat/XQB/BPGroLc6gejAvwdW0OduktJDT7Hmo72Z7uqwd96QPtBzDJKIip4g1opKXcBF4jhcZVqEQl84FwZ/xRU++Axwf9Ciz6VjcZc2/Wb7V0U3ze7UQ0SWCWwLgLbArWYY7BOafz4kbXcAwahu8WKEc9Ei+pA3XQGIh2xmL24BrTn5Ff1C76r84pHp8+GDEXe9dzaXQUz/SZyIENYJpsCL2fALqgWxDl3zbiTu8lE5msMJ3+oySzWhqOgmmYSgWgGBgOl6rZAP/gUuEAXJDxhFDfF0xKC/adfjXnibnPzNkSaqtU+OK4esim/yDQ1gjlcQyUKl7WLYScsgVNQ/WKzI6PZxkj/X8pa8KS8bVczpLpHDQtONQ2fvrgETaxVCCld9hsGnxh+2yfFbTiNJozAZ8JutZ31qMxmTPyB/TvE6oIjxlRQZRjkH/y+TvsSe50Ubhuk8mrds/0kqW0xxqIOF1Sxf6xaaxN8GS8ICiz513bMalgJOvXRx2fu6fOGVnQULKZBi6WKw3mUoEM+kYEvqEQ37pfS9xmR95smaUGMMBpCwDGwAhHcisx4BbdPm10++3bNxC6c4WDg4IGH6fkBH7cCoWKHxNkX7pkl/hS3edIBPPgAmRnCGikYJuUopXXb3iYRkw2OG6mlyqIP5kS0wvsbcTTWJFnmly9IrNDYDmHIMy/OgQOSoOYCfx7thcCfvgtE2xplF5bCN3HKdHvktsVE6DxljwVHpPkNghDIKlaU+uTZ6y/7HfJLJU9RqXqPTdr241vuIdErwZJNpJXkcYxcJCMYfhwLuKde857PL0YvBm9zRQpFomOwzCFj2GeNwVnMk2AezP/SvKFuqWCHeoZHvIbJm4CdnvgTHscSwUgbvO5Lpyw4TEJTAst+NTNP/sIi+f947uQiiUrfoV/8vkFDxuMB2+RwcVbOGJLQWNFFkHMeksBZ9cn48E5SZgwDA4P/Wa+nuG7ZkND38IOD6scDadEUXldAoo74J26b7+Ztho08L026h6iHgYTqlYNRGDQC5quYG3Ds7E+HWGooW+mODDEJrNZ1ML1VnH4UygOzbkeJqncB16/zWD1cPJewjq5Z3Hn1st0ziIu1ufzvXA9trUDwvHeeH+7cP4itqTztTIq8RZQPmlA2e3c0hs2iuHPJgvXb5JPH/V9M/Rv842C3g9qRaVuZ5EC0T7effDX2BDVpcYsunF8PcaBY2AvzXzD3OKbOGJTDY13nuDbD+cshxMGYDtTqM5fa3z48o3gadJA9wjk6SNy3DO+lGQJzaxaQy+MhHwpfyQ1tv6S05gmcsVVE8m+dFyyplsOy+EyDXx2KO3rB9u/3IKLJasaQTUmeg0PSztoVAx98sl5p+meuT5Mh5ks+AtNFY+oCrxeYaweX+gXeplwcUDMuyBPGYxTlAoKngqxVotobFdchyU7ePZ8loR8XcQeQcLCIAZesU0OVRuAurWyTyfvLjtdQOpVv62xC937ZDYaHs/MdCRJYzTrijRRAZwHHvd8FsGqXNQv+2QGQ+Ttiq2mCVf5y+RZyG/RJ0oqfTyjIN6X858HMSrWkO+jgwEcMuZvs09F9G7vIY0ub9chl0m6MzV8M3nv7DJihrkcpIpPPRpu4ohFLcJGnV02dUloTEBPACe7x+4SGvs4uh/I6/tWRd5yhQ+o/s63gVptuuaBI1M+RJ8x5FFEe5KBgx8gvND42QAEu2XFc4lHWm8bIrSpgjbL9X1X5WQ0vbx6PYbrYv95Nbl49+ZiNJ2OP4w6XbxMV8PBZDAcX/7r6t3kcnw+/t/RqX0yuRgPR3XPKzfvFPwTI7jhZMVvDRXRShNZvF+oP6VCrAlPFRKUTN4sMOG6Gc+QvuQXN+8U/prdO2fdtnh99deM6HKjFqvwuVKpeEQG52MyPoVlpFLLuJp5AcErURJ0oJqD8IG09SyI07veMUjaPaD8UfAFrhqMr2WciDElC0fU0ur/lDiu9aIxzjOu8ya0CoGUK2DKgt8wn9wwIR2/qUFEv/C4NDx063on5qqnQMIKfY2qE6/JFn2YDGFvoL+YKWMGxQ5kOo+ZeshtOTO3A8YwvaGgKzksG7c+n/tC8Igw6q0IVysm0EMNtgCJecw0FZPMS0Wg1oi2HmNqtkMDxManOEOfga4CxFmGby0CwW5BfhUpOiGg4YTHSvAQV2G/BBi6iBJ0sQg8DS/k3TnoPLd/h9fTO/wIZ6iiNZrShAeGfC/kXTPTXKkfhxDmAtdC3u1rSrqnexl8ga9F3pxY1W3CJXsXn7KQWU/CphYdH9poeOMoVlcsrvd0lqaBPvnMO/6NrSe0iQEWvt41A4eyQOTmUg90Exnlvj1JvevHuQk0R+jTF2Su+zXjBUZe3MTB2VyehNy73vfT5br48qfS6Pl+eHA/WzeAocp9ybOb5xpmzQN/woTHYkWXD7JiWl6biMBjuKlFHtElFOIAkmwwS0xzLqSbamUJVUWO3S8DRtTnxxzZguYbzCdprIJQ0/1UCDiEElrpjgNJ5gxANHpFagbAfISczrRc1vn86Og/tPjKFlK7hu9yXWwYAMQ+jF5PK/CHLRp5wo+sB3upDzI+td00pGblDhxyBufOEeJzvf/u2oRHt0IQ844zq0EUNNk6AzHgSH2HaVVA+Annal86AG01uEYyAFPO+u86VIF5sqniweCsooRpdZFgpYD1KJKHxSBMAd/4TIC18Tm52nR2yJR3yDwJ//V13zN9qoJYIwXrZYIOJmQQKia0r0Yg9YsRXQMDSUMTDhPRcJHG6OYGLxbF/BoRA7Uk+QIKCyx9YHor+xThWt/j0aFGbqPh9FBDvEOf3bAQxGatpGCe7GGnRubvr1QUGn0JFdYfovmduEjjqgITHPxe694c/ZKEY+Xdr9ZCeF4ghLnEBjsXcZ+F/azzQCKFLEtjQAagI0QNeeeGtYro15c7X/rBxfmvL8mzN4LeBIrH7t1w1qOn1S2rDLt6NvUy4j7Wx/FWy2PRtQSPWuZTorVP/oVFOLuo4XMkMXGUMcaKXToaGYKyJun5unD0c+fQg6pO2ljEcysZ+DEUIiIcV4Y3+DtBLeeO3gz/dlN/a9n78S1791l2fxDtemvGa814P6AZLxEcTmoT7F1gOqadFVma+nMV+jCOXY7jFohsgobWdesLjxuc9EKf0ARBkeEWm8fo0dlBUVHo6w3KnGQWgZBK92h6wwjPOQMP7xCV0kZbhkBv4Hkgfo0iGoQNHPp1I1BKoNDGoBlCG3DZ0aoKzdQKKtmdYNM5BeWrQU12C+LnPejDp8JHH7nCFlC7CSVnL1fj2VgtPD61KgGtyUV1n3XyNsH98dJFwsBljB8R84kV1DIR58N5n3x6P09jlZKzy2l+GZCY9zVaQrHAEA68JYc4ujzksuczRYNQ/pJiH1ehkgfEHJ8knYcQaIzvomdzJjH2Ab+BlabH9BV2BTlKPp0ylpAzRgUu7sP5PfPyGUt6oXm1dxO5E/wFgoWujGZaHmDskNk5RPnD96eD0g4FkmRGTRqG6yw2tE/eWT12l0yRSvT4LdivPC1DmnVaJ0p6Q4MQiQ7Kb4sUA08FCxmV7MFiRPEMP46JbM65Og0kqune7OXWAy3tAZ1nwro9azZ6aRQvgzh3VuiTWeJnF2iWXQy4RRDoDQrtwj362xF5c2IVgu41+hOFEk0q9xVK3Ehs170afn4aIsn+jojbUX0LFVuo+GNCxW2C3M7wRFOMD+daQWrxydTQ1qvTY3l188JAwU0AEx9pEtfQNUyPahs5nmEfzq07GNpnG1l1A6FSGlqTbt6rgcUynWevN1Jv49zcVraniMZ0yfwx5kFR6yadQXhij0oZLIHvmw5MJhW1rsy1NMIwDFjcSC44L/fsYVOrpy8l8jF+fB9r89dsCt/kSzKIabhWgSedXFFmhIjHgc5PYXu/hEvRzJBrdOoqo5yAgAoDaq0lVXTIQxO7PYp9NLJs7/6UKkq8rCFhpqV2j7AeiMXeL9Kw0baU+warud2TkC+J4Kmym/IAtFHkS9esxrNmM69xtbLnNOmPYiXWV1N82Nf/d1W14z4MtVg37bIy1c0KU1WmvvltlBk6doiVN538ls7RfcJJEvbDgqBWZ/sj6GxBa8EanLTCyda+OElIY0beX5xlTNtOcM1T0YPkTBBxCBKvYd9ShkMmmuQ5mJ4RD24F+nIhzHMYCLNRRbEheSgYw2/uLJ1YeyDoyCt2WmfWCklpluYoD/9yAJKR82YupJ0WFEI7DS1LaiHHmc4eo54JZgffDOM9XIm3LswKUPfjTsl8AQvCLdmEw2vueXXTsox85uVEaPfOqom3mV/39d/lL2bgntOXOW86pGAY0iBqhgMmoHeRkFziA8rq2FQDAjSiUwnXUXtv6s43HI4uMXdCgQN0zzSaGZ9H9KohswtG/Y8iUOycxuuZVfdFNoGDGQG9QJpF5J1rzw+IyzMqjSRbkNU+eLikDatxT89hNmlNEv0hyB4aXJd2jfvE0w9JwsPAWxu6B1ZxQ98Q9eW+tzy+kimuFxnpLV3DP2IGxOhzNd3cXQ8a9m4optqQTXowLHmSzXuCM7NXYcL9acK8B7pbJNzPAoI3hIJZhSv32RRZNBcz7Y8LnotxoNYzTCKoIFZTuV6xIH0HPjEzJf8anJ8RmeWDk4oK1Jwi9ZuB59OrmauJfpwV1rkAWlqQcP/PWF+rWXnimpXvFQLaKKD63xQDWg0B/SFM4KXvbuBjDu0KwtafnsalVfG2hOg+QtRAmdnUpn25KioPjMm5B5EVPTQf69wK+LQZGC13iWtroh7eqrz+luUbr9h43BnWuqFVMuoYzYmNadLQ4C+u9siUQ7v5FWRk/5nerwOk/3rlmOVrsxfDfaQIvNkb3I73shxf+Ug20JKTMnolF4KeigN6STpxNWjN90/v1HDy3slajEpn9FDYw52hdpK1Tg4vzXd4JFcXKVenlEWNAm2MdQaCXXxsY8KA5+lymcV/ydU4KsZqbEyoaV2LtVeAjaPRXWtFMnR9zv29PNZPoTEJwYGaPDvqvdBnXAmeQk7YFeeZNtnjyfoBk4bmgO/zvNGpZBMR3FDFBjrJYcNLkehGTnZEBnmywzV5FnPC7iCmjYZkPDFKr5DOWbiDTX1rxNGmSFU9UIbT4B/6CmRxVv1W0fpzKFpbmefJyjzdTryQl5DGrMERfft6SrRURBQ20ZlHVxTSP1gtm+mzYXwXdBnlmr1qSFcrhzxxOaR1Nambm9zRWjHF4M81RpLXudVmmZMh5B3YR1zn42dd9hS3zMXNbCiYx6NIh87BxU4E91Nr1M9OdZb5Gh1CGniQTIaZ90h2mXQQf7MOptm72ljh+D5/mAxdVpCFXLEIyGGD22q3FZGFyUO9SMNw3fsjpaGOthVswQSLbYjwpw/njuuwGamxo65p2LMN5UEXFwQJMTBW0T54dXg4AwvSIrjrujayrSTgn3wuf4aNaEisNrhK5EV6XhXz5z4J985HSiawCdpvzChwX16gPRLe6tSjxzXSbTnF7W5ud9VUrrZf9aIPtX3S6LuGBYByq2mqmGomFzuRT8arPQLbks51Ojgf750hDH/+xfjA9XSAcc9oJ3q4tB6NgoPc3xtVMtg9jKvzr8+ZzjyAuBpmv03904p/P77494MIQq2k0UoaP6Ck8Z1Sij4kWooKbxUopn0hnAwMlWRxQLoqyc4fHF21see98z0Va+RsiGx8YLaVAqiZF6waNtlKCdHowKzZMnkxK4VngbOxgRkFeDURHI7iQDQ0Cs7GxYYzzNNuR9A5W1woxgmVEuZBdf752xUcfONkZCLMsjRHNqxPh/BlSUMwo97FW+06w2KeLlfl/O8ijR0pswli0zKmdS3PM5WE1GNIYJ/JIAaDie7S+pc+Ug65aU3uODcznBV/nXRiTza2rlSb1JG+pvCkLeL2pFFsW8RNtUXc2iJubRG38kVpi7g9rgawFVaftLCqi7gVary/akPtWhXgU1UBtqF2bahdG2rXhtq1oXZtqF0batdC6DbUrnU7fbRQuw4NFQ1Erag0wEdkcjJtNcdPWvhpNcet5rjVHLea41Zz3GqOW9i7TXMcykUtHBqfnJOz6esWC7VYqMVCLRZqsVCLhVostBkLpXGgXnNxFkSBqnfUS5jQyh58p2YD9TuXVF5fMFRj1L/Toq4fAHXpugCVJDE6pzX+3NrpfwJ49oTt9I2D9EwK+aVbWggi8lI5y3M+TDhvUAdIZwVJOA+3aNah0At0Wcrusrl4sPWDrpoSi/U4XVAJZlGS38J+oX5hsdSMLYarN6OU3IT4Kay21rCFDY2l8n4CcBPtWEgAgxJdB/t8d6smMXfipq3Lp/M6BC+xDoHmD9GwZNTfw6Dy4TyjAu78PkLdbdhj6dEQNi+QxBQc6mpSLuALS4gyx8ZRBWRBz4pD4IC3MqZTHiLgWgp+q8tylgoGeTTUMR9HuvB3GmcRnfDmFJ43jySBJj07f3uenUV29qxYfqoLlZ8YLqIPFS4OJ73JhlqqWJ4F6lyw5dh/WGywDfkBKiCVKNRTKFUjHXzBeZeKkip+zeJTywu3nnH7phV5poMpwS7c4ANLOQo1r4+Nc4HeCQiAfxcPM3+BKnUYFA6I7+48gnhNxf9kjwOwbJY9DvRUgUZWVrgNLm1eMhyymjXXR5O1OPZJ49g2SHK/yj9Pwqi+U4WbOA2xHJ5GUnXBfbq4ISWfKoV1dPmb/TIR5CJUlovA9ntAqFLUW+WV210AA1Svm0GfbD8rPp280Aqrj2eZqRoFqOE67KRrA9V0WOLwabhmN07yqjN6ZfpRg/71+c0qRZI8fYckn6AeoCBSsYS8JCsmGh/pwpnQb/XMb79obt+DxCTu7z2H9WxPO/oIGZCN2yvUILpgoIgOeGxY8Q56NEDPAnKOUNBEQzpI1KQZ0GbY7vHfiU/XCFL1pcjcQj0u1WEqs8Rq25P6thz6SXPoJiSKXdfHjQwwqQsZ/TZt6zy1Sq2fRqnVBp+0wSdt8EkbfNIGn7TBJ23wSYvS2+CTNvikrfPU1nn6OQjRI9Z5ynV7nX3qOUFzV/dgazptqdfUpOjTPjWd0mW9+vZ9HNxQAo5oNi166y39lDUXrbd06y3deku33tKtt/R3RqItVHzSUBF8mKE9j1nJ5APA7WQP92WjcNvswlhx1wQSKTbWUKi8rtV9D3FjG51MjdJQW1dRufhMUyvQDwLHOQRl46vDzEkE/zbq/r+sud4po3ELlnfHMxXzJc9Z5ja3qajGbmzDPSR6NUixkbpa9WHGL3w4F/HOPec9nl4M3oze5tWJDEgbh2EKH8M8b4rNMveFK8kX6pYKdqhneMhvQA/Ibg+caY8fWGykbv7ZR1g87x/fheBrUfwK/+TzCx42GA/ewgTYipOloLEiC6jgsRS6RMh4cF5Oh72ZrWfwrtnQ0Leww+viLVOiqLwu4cQd4E7dt9+q/vpeG3UPTQ+DZtYLeCvzXoJyQmdjfTrCUCPfwPryGmLzQE+W1oL9I1iwv5cy+d4z/e/VJXeryuQWTz5pPNn6Em/wJb6JI2Z8Tnee4NsP53m179yinU2hOn+t8Pk+RV5+CHOPPS3TmCZyxVUTwb50XLKmWw7L4TINfHYo7esH27/czgFsRsPQJ5+cd/auCqc9sbOIqV5hrB5f6Bd6mXBxYKOrmMwwTlEqcHXawEFBK6KxXXEdluyYgvFJyNdF7GE8guT2KDq1AahbR43p5N1lpwtIHWhaCdO60L1PZqPh8cxMR5I0RvddkSYKSyDyuOezCFZVKFXUJzMYIm9XbDVNuHJrHIbgToOevcZrP4j35fznQYx6NeT7WYkc8NXfGDJm9Xl7D2lUebsO+eCyTRozzOVgS9BeUYuwUWWXTV1CRSHQE2BoH7tLICoSRsf6SvesirzlCh9Q/Z3RyWPDNXcLWH6Pkp3ojcV8UpFGTbUuQGhTBW2W6/uuysloenn1egzXxf7zanLx7s3FaDodfxh1uniZroaDyWA4vvzX1bvJ5fh8/L+jU/tkcjEejuqeV27eKQPPeLjhZMVvDRXRShNZLQXmUSHWBKrDAkFxffFyJlw34xnSl/zi5p2if8+9c9Zti9dXf82mlUCNW1LTYqCuZ1GMtPUsiNO73jFI2j2g/FHwBa4ajK9lnIgxEyxrj6il1f8pcVxTT0vj82q1Uay9q4ApC37DfHIDznZ5EKZ1KS8MD91qxFAcURbKpd4kXpMtgvrQpu6WqXMFtcA6Wfmuh9yWM3M7YAzTGwq6ksOycevzuS8Ejwij3koX0e4SI8ogMY+ZMn5pj1Tzy05N1tT+4lCcDQzTUO0b31oEgt2C/CpSDGZ2q4PBKuyXADsXUQK81jwNL+TdeTM/2dfTO/wIZ6iiNZrShAeGfC/kXTPLXKkfhxDmAtdC3u1rSbqneyiFZyrh7RuFnXEHEyGrtayZYhUisRtEYe9dR7BYQjCj3I9Q6tket7z42+Yqz5s4OBQwDLl3vXcFw0wXX/5UGj3fDw/uZ+sGMFS5L3l281zDrHngT5jwWKzo8kFGTMtrExHYWugFHtEFp2QKykUzmCWmORfSTbWyhJZqTvfLgBH1+TFHtqD5BvNJGqsg1HQ/FQI9WqGV7jiQZM4wOnLFSFZQESGnM61CDP3R0X8Yz9SFHKLhYJfrYlNlxOyWjF5PK/CHLWQTXjC6CyRaokt9kPGp7aYhNSt34JAzOHeOEJ/r/XfXJjy6FcIGWjqzGkRBk60zEAOO1HeY1qNWMj0pFC8tVNyUXYcqME82VTzc6/4NVgpYD0QVCBoB7MzLoGYCbJ8MkoTFfq42nR0y5R0yT8J/fd33TJ+qINZIIXN1A/8SMggVE9pVI5D6xYhi3gxdWJ5QEtFwkcYY8gMvFsX8GhEDtST5AgoLLH1geiv7uqw7hCsdauQ2Gk4PNcQ79NkNC0Fs1koK5skedmpk/v5KRaHRl1Bh3SGa34mLNK7xIOYxea17c/RLxvf+XuWIjtx2CWEuscHOQYRJ2M86DyRSyLI0BmQAOkLUkHf+8BLGTtViB7zn69HT6pZVhjpBzQYZcR/r43ir5bHoWVJK0fInlpF1j/7OZWSLvgu6Iu1fPEr1kYDcJgXARjR3n05mD2cDbfZ1hfNN7gXBA83otl/1og/x8ylEYJYqXJvgwFJDVwhtLKmjA3NDMb0qRduJfNK5IXoRxAlpO/PgfLy3dhZ/zvJkaOLeiyjMiPVwaT0aBQfZisl7yWzV7MH5WLu+zZlGfciVYfatxbm1OP8glp3WhNyakH9AE/J3Muc+BPBS4a0CxXRcq4N+K4p6IF0VR7MHG3829ry3rq0YnqDD1pElPaKkWwA184LYawXdEqL52xF5c0Jmy+TFzOrKglxYNTCjAK8mgsNRHIgmOZ5Aqh0XG87QR85NKVqEYpxQKWEeVPv+3a7g4BuPT5x+Gmcqpq5FH6izygQ2tGZcvNUyGYt5ulyVfe9EGjtK/yaIbYpvWqVHLiWG1GNIYJ/JIF7CJcUXba6QR9LfT2v09q5W3tgyXFXunyhsaQnpwcJWm/mszXzWWCfcZj5rweAjZz7LKdEbzoG0W6cBncvjL06PrJPs9rHM6jTVznxrn+ktOUB+56QrdhQwYNkRNLQqmPvoBJiLGpwB1ChUPSAAzJwGEm2Bb/byHS5ZARANFbwKigN6STpxg7mb75/eqeHkffZxjAsUqlGaaafO9cu5lrUyyewrxM970iRW77003yERHI5gE1RTmLppZ81fUq5OKYsaWbINiAZw62Mb42c3T5fLzMFCrsZR0Ri6MWDdChPa9cTiZt211l5D16XU/Y0Pwyk0JiFYKMizo94LfcaV4Ok8ZHLFubJz9niyfsCkoTlmbgd+ZIOaJyK4oYoNdBBxw0uR6EZO9DGTBFAVeRZzwu7AaYSGZDwxGpeQzlm4A7jbWxOsB8r0MfCPUu2CPTILtFq+p6jla5MUPWHdZryQWjLZvoK3r6dEpzEiSgszGNm/ouBfLbP019hnQwcK6DLKU/FVfSZatP2k0Xareq2fm9wxvegUVV9rdNUsZhdlEQ3CPDMJ+JQC+9Dc0qpQTAYiaz9U3DIXN3RYMI9HkfZNgYudCO6nOm2scwszyw4qnpo53lotVXaZtK6sWQfT7F2tTAXtngEDHyZDlxVkPg0sAnLY4LbabUVkYfK8LNIwXPf+SGmo3dkEWzDBYuuD9+nDuaO2NCPl5wPJb3+J8BodZMxdwoNzaBv2bEN50MUFgcc5OgPZB68OD2eQ8nUR3HVdU/FWEgB1aX6GjWhIrDJp+H4J/0n4drRY+sfH0vfpUn4QxNlCuhbS/YCQ7pG0b03NSYU+SiU0qyraLzxucNILfUITF2xtHqNHyz5zBmhm6U4WgZBK92h6o2GyonOGpeJQp1QDi0cAbRtgl1pEDBgBkq9ssrnv5jdY0MzW6WCff1e3QV0kC8PEUMeIgVs2Wx+QRYrxDI5PM3AZkxEGhHPjcp9ByA/nffLp/TyNVUrOLqeNYRuMLg+57PlM0SCUv6TYx1Wo5AExxydJ52Hg6ZlqY1xm3eyDcRhcLnqmIKfrkk/Jp1PGEnLGqMDFfTi/Z14+Y0kvNK/2biJ3gr/MqWRXJsZQHhD40+wc+gYM358OSjsUyHJBT4RoMOV3NiLRuh30+C24XHo6GsCs06bDojc0wJJn2hN/kSpd4zZkVLIH+8cUz/DjBDs/3MgCLe0Bzf1P7FkrCaG5e+ss8bMLNMu9S9HXQ4cmFu6Rdlopuqv8IB4PbW3vVkB5IgJKW9u7re3d1vZua3s3sRy3tb3b2t5tbe9W/fMzqH9+EOVsW9v7wbW9y2Ldk7AttfWfWqLfEv3HJvo765kzKQ29la3YnItZxyhm3S+J4yONsxuG91lZ3YDzPLrvw7n1dUMHjEaJ1gKhUppHJjmQ37p+ZK83yjiDc3Nb2Z5KrKpJZ1AwqEelDJagwK1wpfJcd2CGZXNBLb+zUWTFMkU2FvMjF9dYRbnJCGd8SQYxDdcq8CR68egCzGaEiMeB4sK6M4d8eQmXolluNZPmRmWUEyTxwoBaVqKKDnkY6tLSo9jHvEcNpDSqKPGyhoSZljoVgo0iLfZ+kYaNtqXcNySys3sS8iURPM18vB+gNi7ypWtWk+xyM69xxd5zmvRHsRLrqyk+7Ov/u6pK0w9TP29zgxmfnJOz6eu2Rt2TViu3NepUW6OurVHX1qgrX5S2Rt3jSstpHKjXXJwFUaDqVeEJEzo4Bd+p2UD9ziWV1xcMgyrq32kF5yctOEM1PDezQZiKqAVZLchqQVYLslqQ1YKsFmS1hYB/DujzWzrH+hagwHoaiZ1aT8ef29NRh7pvX2LhZOu0bElIY0beX5xlJhw7wTVPRe/677IH2AMc2Y0xR8pwyEQT+Dk9Ix7cikVmrS5ar3XZ19gowNHfHX5zZ+lAIPQpAsvBTuvMWiGzszHEDnxzGI5x3565xGq6Y/izM3Q5/rkmJLRnMAYUzzDl3SpssDAroKePOyXzBbLM2AYcwuE197y6afY+D83LidBJV6o5+Js5Slz/Xf5iBu45fZnzpj0ahiENomYQeALhFBIw/wd0wcemGtehSwWVcB11piyTXK3+cHSJTbkNFep6ptHMOJ9iAnMyu2DU/ygCxc5pvJ7ZKJ7I4mozAmaZaFYy+TzPMmFQe5ItyAYVeLikDatxT89hNmlNEn3jZ1d1FJxwn3j6IUnQC8/QPUBvf7J/4CSbd+4fqJ2yfYgHb2worK+HkXA/q9i+oVavjaPiPpsii+ZipgumQWmpOFDrGXQO4DSIlay6J5uZkn8Nzs+IVCLViWOlogIlDKR+M8gb+qqQd+FxVljnTWtpQcL9P2N9LWZ+0pi5zaX0hJ0nS9/dwMcc2m1yEjS1D3+bZjBhBwVxK1210lUrXbXSVStdtdJVK1210lUrXbXSVStdtdLVzy5dPVnppg2n+hkIUYPAod2rZuKSNSRtBjqxGuXHaUH3gOvYGvDVJC4LLMAboiXdWd6fmPPNb6NWLdKqRVq1SKsWadUirVqkVYu0apFWLdKqRVpppFWLtGqRVi3SqkV+KEL0iGoR0G24ygOTibQHETw9TEW+l7rE7dKqSrZrQraqUx6kKnkfBzeUQPCGzbHcRhg+ZfVFG2Go2gjDNsKwjTBsIwzbCMMWLzaNMByEigaCTE6mLf5p8U+Lf1r80+KfFv+0+KfFPz8H/jnndN4inxb5tMinRT4t8mmRT4t8WuTzgyOf0uexTc44VBXOCH4FFLVQp4U6e63xfrJRuhHwK7AHVnN35X3+XP2WBP31SdD3xr07ssTJTiyxX+ucs0+Jn1KdHFvq29zOpvV/Spcyqxd+ZQuXmwpBjbwtNszUlAO6OSY3pkSND0Upg3mKrmp5lSAz9x3KB22fvi0wZDw98oOFnycveOlTxYa6vkfdN8+gKbzXA2BZ+ZAVpmUqySIMlYpGiVMppEskU1BIRC/wwEhcUr1P/EecwxmViqTY5YZp6Id+7VTkI89Dgpf4TtMw9VFrz9r9I9ryreA9q1JJFiFdNhlRv1637PJ4FYXOxjetq/fwYjS4HL990+l2Bh8G47PBydmo0+2cjs5G5ufRxcW7i9Fpp9sZv/0wOBufdqpndhTf9Kd6lnCiyx7MQqBjsl61EWXrXJcLVWu2zrFmYiDRMQnfFHYrondnLF6Cb/7Lo//6tey4jtAsiKhYN/iWZe6gaWina9lEJl/Ubs5V4W5fNQKTRW6gWb65B3MWNqvGWy/H/vqyU6kolAEU7B1K8qIDK1bHymJI6tBJdWPsogtbgWQs3xAorcakQhh1RwHF4bQHtzKv/FsNZRiQKIiDiIYYqFgsyl2DxsE1HZkOYEJDwU196H7HgTrOlDMU1aG3UteV7HmF7+s8AYc8wbCqFw0lVKTqYHAVvOA86AV+VW+wzzq6ZhG6LPUC6JctKJcFvJj1dbr2hL76mnlJdljau2VS9Y47TqVzc1Smk3eXnW4nCmLt+d056qB6xPz1/Oio4/rsduQLG0s2T71rpg7hUacEHDpwdTpVNm1/j2/iiJl6mqWHINd14UBgWavqWXB30BbV3LB3JtIq3yxYMu7h4Hzc6CAgK9cH4bvNonTCcMidTtiWD77t0+kN15G2eCQ377kJx9ULLpYYb3oBt277Esdwr+D3nIuz+e7Am/bfvHPPJ8hqrMFHADiOH6L4HZay/grJhCvLpwvXSf9UvkyaPeUfb8uFKWzYHqc1iIDOjE+bfsGtd+cRJ1T9jPdeo+2f0blJO31EQ72gXOV9DC0jH06J4f0Y2nYylldKvpeQPcZMXFKWD7uRmOErjT4ClQAx3e2nX+z2Gw7YMzGw9jJlfO4mGuq42r8ddTs0VXzqUVuvuizwbrtog1s5upb3MyXMo7Bp78yWmTk34kHsWm7jQLsN6Xwl6NvRkP/beE4p5kIPZCOGDbJ24sP18/yH+rhp/ZYJg7THYTdk4pLTN9f3XFxDu5xQ7Czo4nG+/PKaNaCdDxnfpZnXbOsx+H408699GPIt3nwaajKMVPa/GvPd9ChAzoZ7jsJDB3fOAYy07RzgbDYfgvxjH2b1iDt5RotOJRsFTYKefvrq15cvXzhRi686PfjfyejN+C0Zji4ux6/Hw8HlCH/9v/hf795fXDk//1+MD0ZvTysvP+YBqqYv6BTYEEbyd+ryBLg78k3/zxWhDT8STCY8lvq4HR8dVU/du9/0jitjgIBoU+OHcPi71GFx0luxiG43HeQHrq6wsmvCrUryep7mmrysm+kJ9YkwEv8OU3bVClat83lbkh5H/7N5ESMhuKjM/EXNHifMKGBibjJDMB+7ksxLRaDWqG07YVQwMUjh8376DCqwiKkVh8sCtiOYpPn0bn6M7D5I7CQVoXMxaBL0EbzmquWq2QyfkIm5qgZCDyZj1MLZGU5hQ/XmuPPM9gdGhKnga6ACw5c6XfOP11Zz9PutwpXDhzL6mxPur0daf1MlW2WykekiDT3bYLzIft6kcslojCZhmG/CNPqch4Tm/RS9SJxh4V7GG34eGzHjsqRHNZ39k88veFh4klmYyw8cJ5nijzWdeGFgiET2k4Ohsp0pWJSd34tW18poWpdzVBNtf1QyZ376WvlKhjkVO7VQOTPMIfX63BhOb1AB6UchX74RHHKaOGenZGdzTADY/TSmiVxxKMRqRt2i5zpytFxH3c4ySUuzCJyTUDprmGpgqgRVbLkGOjeaXl69HkP/KJQWj/1N4hV/kOk8ZqrUp721uPLSs4W8OzdcKV+2vHtb+lILeaf9mY7Qcphwyd7F1viQGQC849/YekKLJwsp3AmCstLYbC5PQu5dZz3PA3/ChMdiheQWTtBCau6QjbEo3Xy2kJUF6PtW2nT94yAKSu3n8oRzlc2BebLmIFBhnZ5KvVIR/fqydqT66/7NHB//gkmeCg+//9dvBTOD826umP90BO8E8YLjybMFXzW5Bvq8jZIbvCHNy2g19ZBlFrmEyxtYRIMQNfwL/j/5AzDqA+zDcZ73nx8d94+si0ZEYwdg6o9Xhx7L8/2aM3HTShJKYnZbayMggyRhkHPmvzPgM/Zn6DumRwTjgotVg5hQkr2rLeF36AlhLjH8CYbWAMPpcUu+GhabWSA0i/2snS/h969f51Sy9yL89g1+/iNlQnNvP5DmSKDP2j1r/ZjNKU4jJgKPBMjiFgH4R44XhOusX12zsnoojssDn9OtK7tmQFacXXPoMPJ469uAsEOTZIDXn76apkM99R6e67xtBXeBA5VuMfA8lqh733XhzeTdFMjdnPtoRYP0WJ1XHUFvwYJGb2Ge3Q7PHQ/xt6+dkMbLVN8f3ScAC1rEJSUc4po1abx2Zvj1q37jkl+z+Nu3jt03BX93vn3+9u3b/wepk5jz sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new compute environment. Append `?workspaceId` to create the environme id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-credentials.ParamsDetails.json b/platform-api-docs/docs/create-credentials.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/create-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-credentials.RequestSchema.json b/platform-api-docs/docs/create-credentials.RequestSchema.json new file mode 100644 index 000000000..96bf3c93b --- /dev/null +++ b/platform-api-docs/docs/create-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Credentials create request","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"required":["name","provider"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"name":{"maxLength":100,"type":"string"},"description":{"type":"string"},"provider":{"maxLength":16,"type":"string","enum":["aws","azure","azure_entra","google","github","gitlab","bitbucket","ssh","k8s","container-reg","tw-agent","codecommit","gitea","azurerepos","seqeracompute","azure-cloud","s3"]},"baseUrl":{"maxLength":200,"pattern":"","type":"string"},"category":{"maxLength":20,"type":"string"},"deleted":{"type":"boolean","readOnly":true},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"keys":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"s3":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"},"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},"azurerepos":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},"azure_entra":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},"container-reg":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},"tw-agent":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},"k8s":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},"ssh":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},"google":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},"bitbucket":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},"gitea":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},"seqeracompute":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},"codecommit":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},"gitlab":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},"aws":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},"azure":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"}],"title":"SecurityKeys"}},"title":"Credentials"}},"title":"CreateCredentialsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-credentials.StatusCodes.json b/platform-api-docs/docs/create-credentials.StatusCodes.json new file mode 100644 index 000000000..14d8a0d7a --- /dev/null +++ b/platform-api-docs/docs/create-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"credentialsId":{"type":"string"}},"title":"CreateCredentialsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-credentials.api.mdx b/platform-api-docs/docs/create-credentials.api.mdx index 8fd682123..97bc2e726 100644 --- a/platform-api-docs/docs/create-credentials.api.mdx +++ b/platform-api-docs/docs/create-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Creates new credentials in a user context. Append `?workspaceId` t sidebar_label: "Create credentials" hide_title: true hide_table_of_contents: true -api: eJztWt1T2zgQ/1c8eg6BQq/T4+Uu5DjK0CkMoXMPHeaq2IojsC1XkglpJv/77Ur+tvPBQe4I8JLE0mq1v/3SytkZ0dRX5PAbcSXzWKQ5DRS57hCPKVfyWHMRkUPSl4xqppyITZwSocMjhzqJYtJxRaTZve46vThmked8/20i5K2KqctOve+OFrgOeDh6zJosctqcD+kQETNJUYBTLxehX5KyQ2Iqacg0k4hgRiJ4AMrSxkDDUf4fCZNTUkf1V75rlIRMctfhhvmIMwnEyh2zkJLDGdHTGBlzEM03UyMhQ6rt0If3ZD4HjUkGuyh9JLwprmkoMEecKiKlB24Gc6RxFY3jgLsG9e6NwqWzphxieMNcXBhL1JHmTOFs2YLwiPw5DKFxjWYM/R1AlGjg5by4h58hvf/MIl+PyeH+fr5Eackjn8w7qcIrdO/29loIK8qYNedzwWrMPtR5dQgDWyEkOkEPoD8TybLvvwG9pPDkC+EHOOxzPU6G9kdA8ceQ62Hi3jKErNQYPm8/qtQGlEdM7kiG2+jJDvXRKDjlMVeEIdeWEaPZhpLFAhcr9gNcFWjiROfS7LiBSNAD1QG5BoxDqthXGdT1ivqKqQYnRj8hLcoDd2C+kNPGylZFBxAPXknJQyECRiOCDkq98ygAPlomDIgDqvRXVaHO1Zx7uAe772hu/KfBwbMhSfVjmBgxYu9xTG7ZVK0OEY+jH4Y8olrIts1qfBFifUnKcfrFZpvqfAcsFMfICwP34OklAudyXabUGZu2RpJikAZ062yHTCR4b4UZeN54oKcB6xmuxxEdBq3ug6rQEEQ4NjgYMDcBXtMz1Po8j7MNoMXDJUszzbRBlYJs3+o2dawl+U+4/pQM6xhKEb0lOHoo8SVK3IolTYctYGgQnI/MkfnUMIdUu+Mvi3AqYANZdeG8Wb2276bc1qSv662mstmjocMRTiN92mJEzOEBZysmByZy14KC5UYFzDFaOjN+9SjbkC8vtOFDfBl5+xym23JZyWD9DNFlSp5BzU/pDaAENUbAKa0/W5BinfkHb2GGvjmmcmUe7fnW7JXQxXJkE2hw8QhLywVmk/wO5tYOPi1uWUsttzTuzj42EhWWYBtA+1A06LTxWEKF9kBIg8Gnxlloi88NoIICiD5QvhMjTF3EogjegJRre8ZmDsUjro8MtpYaha1xi3oeR/sJCtsIlso14z8915+06ASVwH37EhJiT7bdB8spclJPGY89qCuH58BotG81Wld36d63JV7TB4n7RuIW58f778sLdwiUz7RZy082cog+nyhIX3xsAOO2VvA4LSL2CvLfcy0rtiNHtl7+X0dafHEoF9V6W+OJjRrvRV2FXsst9u0Q3rLIW/ji9AW/K3spL8i2w8MW3sTeXsa/qpfxb+9oNvqO5pkr8Un+Xa2oonLjLaWbUutHbbzaNHOZNp2Y63LRIZKfMCoWkbK629/bMyqs9LGcn5FN9Ku0xuJyHFZSBAJ079tkPaLev2myKffNhGA1yGqr+2UywqUojqUUsiH5QYuWs84nJxLagYwhJiDP3Dqg8QCTQI4YnKGyl2A3yLdrdJSQ6bHAbikobYyQFOfIrltpm4Lz7i7rmUqwI4WMtY7V4e4ujXnXtK107bvmLhek3jVl49G5CKjG1gynj/RO7+LUuGom4AD1aXVTFjNXD+5I0h4rEwmGCEbsjz+zpo+biTbA0U6XRYfV8T0NY/svS63tCTuXiphMW8Ly5yqUfLjoP0r7ivJmnYKmaMMpxrKuk1LWKCZLyaIYrOXVwk3m2Ko2EkZFlcxnVLvKCGhSDjKkxOYvYNc4e9XAZbOCv3Ocw21/LyZAEPQOu8+77q+/dPdMIQQeFVITK6lSbVA6Vd+qdXrlUff/tBCmzoaPu3EAZTEiSWwTlo2NRuPjGCMHhmez1Afmcxy2HYQYMXCmpGl8BEvYEsgr+gtbhbs17lJtYbyjQYKUJsDuqOS4vwl5EBcOMPRbEMwu7dvtd66Qe7G2kfPw8LQr8HCK9VLacmq5OB9cYYSkfY4hVLowKukEj1P4NE1swqjD9iHi2IwENPITkyKJ5YkeT6tJoZYEylUSjaYlCcE4huIK7+9goExv9j4/vwbm/wCbsBfU +api: eJztWllv2zgQ/isCn5WjSVEUftlNvNk0SNEUcYt9CILtWJrYbCRSJUdxXUP/fTHUYV120k28m6Mvic1jON9wZjikv4UgmFgxuBCBwRAVSYisuPRFiDYwMiGplRiIoUEgtJ7CmVcb6EnlgZdaNF6gFeF32vYOkgRV6H35babNtU0gwJPwi0ea5wGhR1PsiqjGVnKEL3SCBliBk7BSYVjT0hcJGIiR0DCChVAQoxiI2sLCF5L1/5aimYs2qr+qVVUao5GBJ53wK4lG+MIGU4xBDBaC5gkLlopw4rqutImB8qY3r0WWXfrC4LcULR3qcM5zOgasEBeGKMYLXzjMingWJEkkA4d656vlqYuuHnr8FQOemBi2EUm03FvfwcHC6SMNhry5zjJu/I0M0fAGr5clQ/4bw/f3qCY0FYO9vWqKJSPVRGR+YfDGuFe7uz0DG8ZYdPsrxVrC3rRl+QJVGjMkmLEHwI/UYPn/b1RkQPhiovUk4uaJpGk6zj9EwB/GksZpcI0M2dqp8MX1W1vsAUiFZssgL0OzLZjwpnBXiIGOY0m5IIRyQYOJ5skWv6GBQMdJSpU2W0GkU/ZAuy8uM1+MweJnE7XtyvZKgAgN+4noMV4AhBNt5p2ZvYaOkDCsGXmsdYSgBDsohGcqmosBmRQzX0Rg6bNtjK7MXHl4CIRbJJ3/dCSEeUgC3UeIUyMJ7yfkGuf29hAJJfthLBWQNn2LteQyxPaUQuL8Q55tmv2+iCFJWBYH7v7Da+QLCAK09hTnvZFkMTBIvb2+mBlJ2BCWAE1HNI/wwEk9UjCOet2HTUGSIm4b7Y8wSI2k+SlbPavibANo+XAp00w3bYC1M2163aaNtab/saR36biNoRbRTwTHAWt8zhr3YinSYQ8YiKKzK3dkPjTMMVAw/bAKpyVtYIIr+93sO/tuIe2O49t2a5lscW/ohAoUnfRsIufwSOItnSMXuXeCwuVGA8wR73S5+c2jbEO+vHIPf8aXWfZEWjJ9uay2YcMS0XkxvIRandIbQBlopTAo688epFxn/iF7hLFvTsHcmkcPJvm2N0KXy5FNoOHJV1xartg2I2+A7hpMviB9jT213Nq4O33bSVRcgm0A7c+iYadNpgZsj3HWQhqN3nXOwrz43ACqEAh+Ur9jp0xbxWURvAEt7+wZmzkUDyUdOmw9NQre4Rb1OI72Y1a2EyyNa8Z/eq4/aNEJ1qYxnusID0zffbCeImftlHHfg7pxeI6cRYe5Rdvmrt37nojXDHWIQ6dxj/Pz/ff5hfuxpPfQreVnGzlEH08UFA8fG8D4VCt47tYKX0D+e6xlxdPIkb2X/5eRFp8dylW13pPxxE6N96yuQi/lFvvrEH5ikbfy4fQZv5U9lweyp+FhK29ivx7jX9Rj/K83mo2+0TxyIz7Ir6sNUzRuvLV0U6N+tNqbpJnzgnTirstLhkh1wthEK5vbbm93V3R4LGenG+Gr9Mbiehy5pgwk88XrPl0PIfw3JJs6byZGa2GCt/NlyoFrURwZo01H8/0eK5fMJ09p8iCK9AxDJ8oWHuASyCGCQXOQMhvk4pIdJUaaamZLJdqBZgcUA7ETNGhTFs1NyZlKmZEipkSJHezsQCK3HW1lO39r3pa6w5rK49H7GAExNcMb8njv4OOJc9VSwRHbM7dNXc3KPLxiybFykeAGMUHHffizJH18nZEDzvt0vmRYHX2HOMl/ZWnRnpi5tIzJghJWfW9CqZqX/KOCV1SRdZZjljScZVvJOqlljWVnLVksG1t5dekmGVPVrrQzUSPzOdPetgm8pTJAWwx2PwEHztmbG1zfVoxBRo7DdqV/X3ZkvmDvyNd5tf1qd29711VC2lIMLlgKq+ZR6TWdq0X1qsLu/+EQFt7GX3eSCKRiJGnOwsqDo8N8nHLoDC7EYlE4QZZxc04h5JAJpS3y+BVEFtdAvoVg2KvctfOXJofxBqKUR7oIuwEjeX0X876YIjjHvVgUU4f58lufWPpybifp8emZz+DTKaG1Y+u55ePZ6BOHSEF0jHXIcwzM+DyFWc5i084cORGR2xYiAjVJXY4UuUx2eWhmhVYWqJdJoOY1DReLfMQnvsBnmSjtll/os8ssy/4BKJ0X+Q== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates new credentials in a user context. Append `?workspaceId` to create the c id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-custom-data-link.ParamsDetails.json b/platform-api-docs/docs/create-custom-data-link.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/create-custom-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-custom-data-link.RequestSchema.json b/platform-api-docs/docs/create-custom-data-link.RequestSchema.json new file mode 100644 index 000000000..63f32905c --- /dev/null +++ b/platform-api-docs/docs/create-custom-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Data-link creation request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Unique name for the data-link. Must consist of alphanumeric, dash, or underscore characters."},"description":{"type":"string","description":"Description of the data-link. Maximum length: 1000 characters."},"type":{"description":"Type of the data-link. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible. If `true`, no credentials are required. If `false`, `credentialsId` must be provided."},"credentialsId":{"type":"string","description":"Credentials string identifier. Required when `publicAccessible` is `false`."}},"title":"DataLinkCreateRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-custom-data-link.StatusCodes.json b/platform-api-docs/docs/create-custom-data-link.StatusCodes.json new file mode 100644 index 000000000..5a6edee50 --- /dev/null +++ b/platform-api-docs/docs/create-custom-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled in the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-custom-data-link.api.mdx b/platform-api-docs/docs/create-custom-data-link.api.mdx index 4ac17f0cd..7b84affe4 100644 --- a/platform-api-docs/docs/create-custom-data-link.api.mdx +++ b/platform-api-docs/docs/create-custom-data-link.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new data-link in a user context. Append `?workspaceId=` sidebar_label: "Create data-link" hide_title: true hide_table_of_contents: true -api: eJztWOtu2zYUfhVCv1bAVpKlGzADw5Ym7WCgSwKn7X4UxURLtMWGEjVe4riGgT3EnnBPsnNIXWjJjbOhWDtgf2yRPDz38/GQm8jQpY4mb6OMGjoWvLzV0btRlDGdKl4ZLstoEp0rRg3ThJKSrUhLSXgJU1YzRVJZGnZvYnJWVazMSPLDSqpbXdGUTbPvE2IkSR0TYnLW59CStmyiUSQrpijKn2atBudWG1lcwO6XsBmIKqpowQxTaMImKmEAxIFooOFowW+WqXXUt+uXVnBpC6Z4SnjGSsMXnCkg1mnOChpNNpFZV8iYg3ZLt7SQqqDGT337NNpuwWeKgRRtnslsjXt2RV20Jjs/wCSp6YGbM7s0uItWleCpIzh6r3HrZqiHnL9nKW6sFLrJcKZx1ZvfUmmjeLkcGP265CCXIDEBM3YDEpOfwccYB83hXy4IFVVOa/eMgFDnIwK7bJmB11OpIGg5RCHFIMTRtiftkDIX3QiF9XWh97ywBRGsXJp8Qk6Oj4/74jz/vrtfwewehudWKXC0WBNtq0oqo0kyt+ktMwnmXF9XBnZjbXgSrIv7Mc6N76hC/+ndRcONYHWsMUFRCVQRonQHiaWGap4LaTPSrO8Lx02rJ13pZESSpZRLwfCLfrCq+/gV7FK0HY5TZI1DzX6DSkplUVmD5BTLU58+aDDIgpEXBR+OY/PvBTUjLweLJRSD49N9LrluXLHFetHSqpTN2OJwosxqYlJRkw8dNQIkSYXNYKtbeD2bElc2jHzF4mWMfjidHB0V63Edb3Sl7s/QDzBD01Ta0sRYlZSXTCVPXKZVdg6leZamTGs+F2GpzaUUjJZDgMkZaKP6oKeJ5wV5SFt2MZkuSGKUxSCVDi8dGFEBwAtlhnDBYc7TLWDaBT8gm2YJKbB856zJqcxpvkNz2NfngWRPEuBiTGa1ImSVs5IkfbckaF+tH0jfDpPAg/mshr/tduuxE3lGE3SAT44KQMgD29fHx8PaubFO5KeDT/4I13QwvscxP7ESzyzwzJxq+AVMa0p7RJDvCIK4BEa+CFWY0i5OjwPwS0TuPrY1ae5z2aH7k08Nx5dWCFd6Xa9AqDVynHE4Ce4Y5sRCySI80LtUiv+LNb//dOmyANf/P1a+sGNl+ahc907y1B8tp8TqMaPajE/QZmYRMMYrgK0TSBDoT9aItWVTF1oWLfLW7UlQAIFKVCmK7Sg3rHDzHf69RRyqoSCI8bvRJ0Cvh4H9nyFQv8IfyMpAerqToZ85Z/YfUW3Y+iAanWH00P7wiDY5hb6ZlvWJDmM4BoOKe15UZu2yxB+YAYj+G90FWXGTS2sG8cp5BuNHSHvDgREXHKzQhhqryULQ5U7XsqOEZ+wPhIwtqBWGCLxU3HG28rI9n335Bh1CdlWKte8HIMBCXC3cHe8QZZM3b85eTi9gfXrpv/ZkQHzj5W8HF16/sO8CAQGGik8czwQvQkktIAFQhYMXLrrtjG+QqNYy5a4t6Ld0GRNwefU9GsC+pstHFN9zpUBsTe4Sipd3VPAszKjurB4s7c33CyOxEYOVp/t6rWc0m/3922oIao15B3Hso34I1XY+mNUtYqv46VDxq+YVATpqA3dZIVegj6N+OqS+lOYFtAEZ+fP3P4ImBrwYRg45LZBsRM6upwSaHwoFluFbBmZLu8/dk7uSwMrHPqbd/qW6EguTpVZBpbuKe8YgV9WZNTkM32GxFIA7Ep9lKukyAu2C0VHwhoQ81F3zMGOVgPXcmArbL1rx2GF17JE65nKQ5TduhVwLavCthfjTGvztqrXR78a1e87YUMvWXpTYPOQ4bHNEMOM/XjSvOO9XxjkFHT/rnnGe39Oi8lBcPy19pCbb6QZDffMWnob1QbbTAHf7hujv0ax3c2sDiM9aC+ksreNYOww9dMiXGBkOkmpi1/OmLgl34xRGB/KQC/fetZA/dgugCAbZyzmJv/smPnaHGeRFQcvAcf7O15VDX8lNVwuf5bmxDhwOjyoBVwA0w7ljU6d3/4k0x9yH2c0Gb3uvldhucdq/NGLSN8AQTdxl+AGDD7xD7tXtlq0HT52A9RYpXY3AZYJTl0pQtKAunJOYh6CY33ruxY/ddaLbO8Ch7ajZgelZmQdpQ3C4vrp5haVWv4cWMsM9iq6wDOAX9MRnXtzte2Cc20SClkvrYCvyPLEw6W5d9+o4bAxouQ40hOA4ilfylpUQoMZvBsegLjD/C8O9BIA= +api: eJztWF9v2zYQ/yoEn1ZAVpK22IOBYUuTbjCwtUHSbg9BMJ2ls8WGIlX+iesaAvYh9gn3SYYjJVmW3SQbiq0D9mSLPN7/+/F4G+5gafn0mhfgYCKFurX8JuEF2tyI2gmt+JSfGQSHlgFTuGI9JROKAfMWDcu1cvjBpey0rlEVLPt2pc2trSHHWfFNxpxmeWDCXIljDj1pz4YnXNdogOTPil6DM2+drs7BwY9C3fKE12CgQoeGTNhwBRXyKR+I5gkXZMF7j2bNx3b90gtWvkIjciYKVE4sBBqecJuXWAGfbrhb18RYKIfLsLXQpgIXl75+zpvmJuEG33u07oUu1nRmV9R5b3Lwg9CKtfQ84cFs5egU1LUUeSA4emfp6GZfDz1/hzkdrA25yQm0tBvN76msM0It94x+q8R7j4yI2UKb3YCk7CdvHcXBCuuYXjCQdQmtexJWgC0Tpg3zqkBjc22Q5SUYyCkIKW9G0h5S5nz7RcLGusAHUfmKSVRLV07ZyfHx8Vhc5D9295t1jQcYnnljUDm5ZtbXtTbOsmzu81t0GeXcWFdUvqLaiCRUFx8mtDa5A0P+s7ubTjiJbawpQUkJUrE2+k4UaPbVPJPaF6zbPxSOq15PWNksYdlS66VE+gcfvdn++RWVM9B/TnJiTZ8W36OBXFe1d0QOVJ722b0Gw8ryhEdRPOGBY/cbBXVfUQ4Vy1AMfT875JKLzhUN1YvV3uR4iYuHE+WyJWY1uHLfUQkTKpe+EGoZNt5ezlgoG2RfYbpMyQ/PpkdH1XrSxptcaccr8HF6dAR5rr1yKVUlCIUmexIyrfZzKfLTPEdrxVwOS22utURQ+wBToivRjEHPsshLrhn07FI2W7DMGU9BUgEvAxiBtAwMBrgQBotItwBpQ/AHZLMiYxWV7xy7nCqC5js0D/v6bCA5kgxwMWWXrSJsVaJi2dgtGdnX6pfyptlPggjmly38NU0TsZN48ik5ICZHrZWNwPb0+Hi/dq58EPn54FM8wjVbGD/gmB9Q0Z2FBZuDxYJp1Zd2wohvwgwuhVaxCM0wpUOcHgfgrwi5x9jWpXnM5YDuTz43HL/yUobS2/YKDLzTk0LYXN8h5cTC6Gp4oW9TKf0v1vzh22WbBbT//7XyhV0ry0flenRSpP5kOWXeThCsm5yQzegJMCYrtO4ke0L9yZqwVnV1YXXVI2/bngwKYKASGAPUjgqHVVjf4t814VALBYMY3ySfAb3uB/a/h0DjCr8nKwfS850M/Zdz5vAV1YdtDKL8lKJH9g+vaFeCYzmo9kZnrhR2WHEvq9qtQ5bEC3MAov9Ed8FWwpXau714laIoUD1C2s/CirmQwq2ZdeC8ZQsJy52uZUeJyDheCAUuwEvHJD0q7gSuouzI51C+GYTitZLr2A8kHKR8vQhvvIcou7z5+fTH2TlP+OxV/HcgA9KrKL/Ze/DGjUMPCFBU8VngmdFDKGsFZCm7QkcP3X4lNkhgrc5FaAvGLV2BEl3bo1VoLSwfUXwvjdGGteQhoYS6AymKYUZt7+q9rYP5fu40NWJNwp8f6rVeQHH511+rQ1DrzHsQxz7ph6HawQeXbYvYK/5sX/HX3RSBKe0YSKlXWPBA/Xyf+pV232uvCvbHb78PmhhtdiJHnBZElrDTixkrhIW5xIJmGZQt/bnwTt6WBFU+9TH98S/VlVSYmHsj3DpU3AsEg+bUu5JPr2+oWCp0paaxTK1DRpBdfMqPBjMk4mHuusGMN5JPeelcTe0X1CINWJ1GpE6F3svyq7DDLiQ4mrWweFufXsxCtXb6XYV2Lxg71LK3lyR2g5yAbYGIJ+2f77spzruVC04hx19uxzgvP0BVRyhuR0ufqMl+ucPQ2LwNb8P2IttpgLfn9tE/otno5dYHkMZaCx0sbePYOow89JAvKTIiR9sSh543D0m4G6dhdLACIcO8a6G/2240CacgRzkn6cnx0/Q43GbaugrUwHPx0beth7GWm20x/CvzxjZy9HlUSxCKzAj+2LT5PZ6RlpT802u+2dBz762RTUPLcdRIWd8hA5+G1/A9Bj8wiDyo2y2u92addyA9UYYiuQMjIOTS9Q1d9AghEa837dGzKH4S3hPbs3tA1CTdCcrP2t1LO0SHi9dXb6jW2oFopQs6Y2BFdQAr0pPmvHQ6NsG0tuES1NIH3OKRJ1Um7Bb2qJCHnQGo9UDDzSZSvNG3qJqGd35z9M2bm6Zp/gQ/9QSl sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new data-link in a user context. Append `?workspaceId=` to create the id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-data-studio.ParamsDetails.json b/platform-api-docs/docs/create-data-studio.ParamsDetails.json new file mode 100644 index 000000000..43e24acad --- /dev/null +++ b/platform-api-docs/docs/create-data-studio.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the Studio is created in the user context.","schema":{"type":"integer","format":"int64"}},{"name":"autoStart","in":"query","description":"If true, automatically starts the Studio after creation. Default: `true`.","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/create-data-studio.RequestSchema.json b/platform-api-docs/docs/create-data-studio.RequestSchema.json new file mode 100644 index 000000000..8a0f114f8 --- /dev/null +++ b/platform-api-docs/docs/create-data-studio.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Studio creation request specifying compute environment, container template, data-links to mount, resource allocations, and configuration options.","content":{"application/json":{"schema":{"required":["computeEnvId","name"],"type":"object","properties":{"name":{"maxLength":80,"minLength":1,"type":"string","description":"Studio name. Must be unique within the user or workspace context. Minimum length: 1 character, Maximum length: 100 characters."},"description":{"maxLength":2048,"type":"string","description":"Optional Studio description. Maximum length: 500 characters."},"dataStudioToolUrl":{"type":"string"},"computeEnvId":{"minLength":1,"type":"string","description":"Compute environment ID where the Studio session will run."},"initialCheckpointId":{"type":"integer","format":"int64"},"configuration":{"type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session. Workspace administrators can still start, stop, and delete the Studio but cannot connect to it. Default: `false`."},"labelIds":{"type":"array","nullable":true,"items":{"type":"integer","format":"int64"}},"spot":{"type":"boolean","nullable":true}},"title":"DataStudioCreateRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-data-studio.StatusCodes.json b/platform-api-docs/docs/create-data-studio.StatusCodes.json new file mode 100644 index 000000000..eb9ecc123 --- /dev/null +++ b/platform-api-docs/docs/create-data-studio.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"CreateDataStudio 200 response","content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"object","properties":{"sessionId":{"type":"string","description":"Studio session string identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier. Null if the Studio belongs to the user context."},"parentCheckpoint":{"description":"Information about the parent checkpoint if this Studio was created from an existing checkpoint.","type":"object","properties":{"checkpointId":{"type":"integer","format":"int64"},"checkpointName":{"type":"string"},"sessionId":{"type":"string"},"studioName":{"type":"string"}},"title":"DataStudioDto.ParentCheckpoint"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo","description":"Studio creator user information."},"name":{"type":"string","description":"Studio name."},"description":{"type":"string","description":"Studio description."},"studioUrl":{"type":"string","description":"URL to access the running Studio session."},"computeEnv":{"description":"Compute environment information where the Studio runs.","type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"},{"properties":{"credentialsId":{"type":"string"},"workDir":{"type":"string"}}}],"title":"DataStudioComputeEnvDto"},"template":{"description":"Container image template information for the Studio environment.","type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"configuration":{"description":"Studio resource allocation and environment configuration.","type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was last updated."},"lastStarted":{"type":"string","format":"date-time","description":"Timestamp when the Studio session was last started."},"effectiveLifespanHours":{"type":"integer","format":"int32","description":"Total accumulated lifespan hours for the Studio session, including any extensions."},"activeConnections":{"type":"array","items":{"required":["lastActive"],"type":"object","allOf":[{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},{"properties":{"lastActive":{"type":"string","format":"date-time"}}}],"title":"ActiveConnection"},"description":"Array of currently active user connections to the Studio session."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"},"waveBuildUrl":{"type":"string"},"baseImage":{"type":"string"},"customImage":{"type":"boolean"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session."},"mountedDataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}},"progress":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","in-progress","succeeded","errored"],"title":"DataStudioProgressStep.Status"},"message":{"type":"string","description":"Human-readable message describing the current progress step."},"warnings":{"type":"array","items":{"type":"string"}}},"title":"DataStudioProgressStep"},"description":"Studio session startup progress information, including build status and checkpoint mounting progress."},"labels":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"},"description":"Array of resource labels applied to the Studio."}},"title":"DataStudioDto","description":"Created Studio details."}},"title":"DataStudioCreateResponse"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"object","properties":{"sessionId":{"type":"string","description":"Studio session string identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier. Null if the Studio belongs to the user context."},"parentCheckpoint":{"description":"Information about the parent checkpoint if this Studio was created from an existing checkpoint.","type":"object","properties":{"checkpointId":{"type":"integer","format":"int64"},"checkpointName":{"type":"string"},"sessionId":{"type":"string"},"studioName":{"type":"string"}},"title":"DataStudioDto.ParentCheckpoint"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo","description":"Studio creator user information."},"name":{"type":"string","description":"Studio name."},"description":{"type":"string","description":"Studio description."},"studioUrl":{"type":"string","description":"URL to access the running Studio session."},"computeEnv":{"description":"Compute environment information where the Studio runs.","type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"},{"properties":{"credentialsId":{"type":"string"},"workDir":{"type":"string"}}}],"title":"DataStudioComputeEnvDto"},"template":{"description":"Container image template information for the Studio environment.","type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"configuration":{"description":"Studio resource allocation and environment configuration.","type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was last updated."},"lastStarted":{"type":"string","format":"date-time","description":"Timestamp when the Studio session was last started."},"effectiveLifespanHours":{"type":"integer","format":"int32","description":"Total accumulated lifespan hours for the Studio session, including any extensions."},"activeConnections":{"type":"array","items":{"required":["lastActive"],"type":"object","allOf":[{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},{"properties":{"lastActive":{"type":"string","format":"date-time"}}}],"title":"ActiveConnection"},"description":"Array of currently active user connections to the Studio session."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"},"waveBuildUrl":{"type":"string"},"baseImage":{"type":"string"},"customImage":{"type":"boolean"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session."},"mountedDataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}},"progress":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","in-progress","succeeded","errored"],"title":"DataStudioProgressStep.Status"},"message":{"type":"string","description":"Human-readable message describing the current progress step."},"warnings":{"type":"array","items":{"type":"string"}}},"title":"DataStudioProgressStep"},"description":"Studio session startup progress information, including build status and checkpoint mounting progress."},"labels":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"},"description":"Array of resource labels applied to the Studio."}},"title":"DataStudioDto","description":"Created Studio details."}},"title":"DataStudioCreateResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the workspace or compute environment is not found or when the API is disabled.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"409":{"description":"Conflict - duplicated name","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-data-studio.api.mdx b/platform-api-docs/docs/create-data-studio.api.mdx index f6a183951..a78ca8121 100644 --- a/platform-api-docs/docs/create-data-studio.api.mdx +++ b/platform-api-docs/docs/create-data-studio.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new Studio, starting it by default. Default behavior can sidebar_label: "Create Studio" hide_title: true hide_table_of_contents: true -api: eJztXOtv2zgS/1cIfdlbwHbdxx52AyzuUifdNZAmRh7tAUVR0xJts9FrRcqJL8j/fjN8SNTLdvrY2zvoS2JJJGc4M5z5DTnggyfpSnhHHzwh84Anwvs48AIm/Iynkiexd+RNMkYlE4SSmN2RK9VsQISkmeTxinBJFlsSsCXNQzkiJ/oHWbA13fAkIz6N4YH4axqvWEBygZ3kmpE/cpZtSUozGjHJMjKnuUyucNhflzQUbD4ix2nK4oDM/3GXZLcipT6bBr/OiUyIr5hS42iOCI+Bw6Id8ZNYsns58gZekrKM4mSmQTGdEyqp7ggNCh5QEA9eDA/Q0KEJbTiKQrHs1QX0viAa5xHLuE94wGLJl5xlI/J+zWKSRFxKFgwqDAsziwB5xw+5ADE4jAt/zSLqHT14cpsiSxw+rVgGn5ZJFlGpX/39lff4OCj4LsS4m+vpksgsZwOC7WEs7tMw3Gq9CpdPukTtKFahZ6HhIzLH/vNWRhdJEjIaA19gThkDDoR8nQRbbFJlwxCxwxPTmIiU+Xy5RWPxkyjNQdks3vAsiSOQ7UCJifIYOJMsSkMQ44AEoNRhyONbgSYSJTk2zJhI8gyUA9NLfEVEwKTBrGCIJV/l2jZIojgSOB2lglgiszRNQ657PfsskOMHZ7bILM9YgOvHcHkab5S9KGXA5I1AksVn5qNG0gzNUXImcACtsgcvovdnLF7JtXf083jgRTy2j8+LIYTMQBoNPRoB4kgj8jYXuPRIHnMQI7njcu3aFizH5gohb3nMozwioSJ5RJ7jYs2oD2ofkLf0vvpxPC4/g7Qea/xU5vJi/OrnffxfqB80tObmfB01qP/UQr1YyddgdDdZ6JihIfk4qGoHmXyChCdN+yPTE3K3ZlnFAwkmBFrSHQ9DkuWxYg9kKzkNJ2vm36YJrFZNf++CVlZYmqfTp8OUVmluJoYS847Gg91EXr5oTPQ8jxZoJUvy2+xG2AUD/glWU3Oeanr+t6Q6OZRqxKIk234t4WPlIZCwHg/d8Fv++jAOsCsGEUcxNMso+lkOHkm0WmGNPrZH8oXfArMS2m+VQaGFuGOIbXZBg4DrNTWrWEiDnTgPQ7oI4aWKBF3suXa/oRnHLuSWbYcbGoKTSSnPBPAnd3AMthzQ0yrbT/QTExwCiPm3dMVMeDCemSwRZ4DrSyLbQAAzEMrCsCFIZzaKtZAvGTjE+HeIEuLb2fIah9vlHcBNw2CsEX6TNIXpA/YhWrww1nw8h0kEOFuYWB6HHOAETMyyPsL470kuUZVeCW0mFQ+CzkjMMr6BUVpCdSc+SGLgy5mICtUG2IFeYzA6u1CsykkJiWiA8gSdYh+hOgmJIlBAY6AmrMNxwEJWhXSLXGKHOJEuIS5dDGKgotIkXbBwGoiWJVm39PoS3QWsPJEmslVg1VE7dKAg3qVGNTDc48BBDaobvgASsdCr9MV43ERJddBKoBWx3Z6CWHbHEJ0DHNBO67kSynbDE2v9upULkFFzLtQ+QClPA+DnoCXClxXDYmESr4Q12yruflQJAfQvY3ZTIdNY84RzoosEDBUH0v0AodiOmi4gfUP4jpagf5mBu4LlwO5heSicW3RDELpbA/4X4Imiy7lBnY2AsEOv+FXNoaNzq/GfyGQ0q8sSWqLA6/iZgl+iyDlYKg8xjCKMxpbnB0FpfqgciiHb5qiJt30x/O2c+Q0MjZbRtQqs61QGx0sTUkYXt/K0C+63gO+DOrsQu1RsK3Suj3BzeYarhvo+mIqyeQhlMVpva9S3oLvFo7WAakciTXQNdETbuoCwebFUefsT7MPBQF2WgDklstP6MWOrVoG7xjApZn+ygIXgYYpeW8Rg+uinIIR1LDl0jCe81eows24L+QVRRdKz2XGbBmwGzSOEVLZlRQ2IrLrA074VmbE0EVwapL4X3VWYKfsSNDnLhuVRp1b+ITZvLNbtTbCnJmTsn8q8BSIj0kYg+AGmArYMsw5YoAik8AKdODa5hylzlAhFrwVWmqdpkuFH0ND9EIcApJyhoYmvGqup7XeQBMMsrzT/qG3AJvtFgomy8iC4IYBNCShuAzEzwK08Fa8KUf2NjVajAfnhc55uIef+AX5m2l/gz43wk4D98GMXAr221teWz7b6ppbtGoUOXT9RGWm/HfaZcZ8Z95lxnxnvyozB0JhOslpzmmJy2G4owUU3nSq8BLlGKUKXilwd0G/yVCFv0uC70cLxSa4JFATVicB3IFgozxIWmpBejsslLDy+YWd1U3qq+VwnYLIIO/MoD6mrYmNPNaBi2BqAdfghvAGASuMt5FqQJgu9z4+YXjE30XsL+HaXz3KTFZzpserclpiUkPT/NsFpgllHJIfZWBXCHtdUsSMo+HmGKSX4BK2/In+3WtwRnTTUU1M4YDfEwsKav9X06ytANx+RWQLPGAiUlxJHZK5cFwvmA/ypj03xt8mc9Gvt3PD3EhSkGy9yHgbmrfr9Rn9yIE8DqVoC8MqMj+dzZnj7U4PNLEsy9cvSsT81mQ74+m0JNF1zCWaBoICA1WqspQ891No0Z5eMivaswQpwcnl6Mr2++nR5c/7p4uYavpxN35xezY7PP53+azaFr/DqanZx/enydHJ2/Pb4enpx3jWVgmB7GLoqrRGTPbphr1E8XYdYCyrYNOoSiQ7z9e/FSeyft/tboEAW4FTP8ED2ADD4hLy9zu1JAROb+4vkNxbj+T8mNyC/AGZk051soLIfPCNeqWCBiUaRgKRUrp+wMXOu8im9zVjCVpM+LXL/FmAgjvTj07dtTsqnBgWzv4nhzzn+Rug0DDhkZxuW2b1G5+i33HgY6e0MPedLttzPzaUroCLuFsTdkIsfbi6nRO0/F7nkXLw8evYs2g61VNC7rUT9Df03vIF4j3Y0Kg7751p6msG6Xy6tAL+PyKSIEyaNFuhGFYFdHlQ36fB+5Ud3NaOJX+Nwj8p6lW21xI0wyYPC9pqSG5Grgk96J5RckmQVMi2PPCt/fIJ5ZbR4HPo4tAok7A8wdrPxNtcWDfLeOWGgBU+aFKIXHNH+14Tsk6aDTt4lg88v20Qys6LYsWPWSGaUkHTrzuU0z8UQ/KocPsc5sxwdxvAOEOpzMBDyFmDCAs8CzLoQSVTscJiiAWcBHAr5eFHV4ej4aaCta8olMx3nI0/3QPUVvsMqHep+xUL/yzbz2Pzo8LoLHzozkmuqzhDLHWsu3BV3GqVyq6wkzRch9x0nquWm3h6rzlxtCOwNne/XDDRQW9tY7aXHUrDVDqcqdPD0qK6vNQ/g+QBq7zgMxEMutwaAkmVIIUmGAK7rswZVJvTAOiCYoj1IpSBv23B2J/Zsh0LsDy4AENhtkcbee2dLazfvjs+mCKCm5/pXiwWMLAJsVCLqDy0hcKJrDOdqzDnuas4NgTk4VaYQSvFGp7BUiMTnCha49kIzZg6ig9FODFrn7RTBLjHNlUHxGBIAHrgWVcbqxqdWe1d7+Hr1riBGfwWK2r/FjZWW+g2PhwVBsIYcrJUFFUTfinZnps+VZOnoABRfl+DveUTjIRqO2kazotSNFhZOmOSPWA7B6oGchs8ZZiOHCKk8RNk3kaabaWZ9mczTkh/n9MSFQirvsUtUVR+Wh8QKLGMjO0hZzvAlxQxfu3/QeSSmEtqO8zCNCbsSD1Ov0fl5CzS53/V5CsxmaRLWdsycNk/fvnNVf4aStod0XVGlyAu0Xoiqs6jvhHftN+LQ7XXVQVn3CBA3bHEE1ToSU/LxqGz3xfh5V60ILte+KqSvCtm32PuqkL4qpK8K6atC+qqQviqkrwrpq0L6qpC+KqSvCumrQvqqkL4qpK8K6atC+qqQviqkrwrpq0L6qpC+KqSvCumrQvqqkL4qpK8K6atC+qqQviqkrwr5S1aFvGq7QeQ1DewlJF94wZldsnvRTXeG7sxBecYG4y+bjF/Y2/sI3gODZw13xgu/Gr9qNj9P5BtYOMGg3JMsMxzMUNtOmIUae4n91B1ptufxbIofIWXClRV88d1wf4bofmk9y10Ch5IMSZBrXsGyDFr9S05EVZuAMwfgogDEawahNzvO8dDjw0eM/RHAqATvcUwTZcqYbsLTM3t9JQ6QbexVjjnumXhrKVNMJWnKRwp3jjTqHPGWmgz1hczMOT/RmQcYgkIelrkrlbqqmbosFpNFip65F1E5JdUIN7rUjzfW83y+k0oiKPXL8prE03sapRpWmksdO6Jj+bp5C175sXr5Xfm+9W66ccuZrDorHZvTy3F5njiuHOx9sCN/rB+5tZ5olXzUjpTG1V0pHc7Ky50+jD/aO5nM/UncbtwauzI6RKXtUy8aCwfcbRqrLQVfLYqq6bgGYzbLFdl/lh8wFOqTd/j2fPTLT6OxyhXATgHCOLrUTpsU14/Wdn2Khfm/f/OqWQ34+CwNKVdROdf7mHrhVu6dXeOShlcPD7gnB0b8+Iiv9f2luJytI/aOFJ87RPfd7mRtndItA/5qF8YaWOSpQ5HDGf+W17Lu4NW9JLbk9CM+6ANr5W9BJQC8cX8AhK87TjSnQ7WxVfZthBCcte6BaXIqd7Z1/frs4gq31xfmttgoCbBPRu8wf4S/wCde6VsczKl3eNAUr3IVcTw9JrpVWvXKNS/spqg03jocggGqFtfJLYvBCK3UJD4DuzD4fwBWz0JD +api: eJztXG1v47gR/isEv2wPkB3vS4urgUObTbJXA9kkyMtdgSBY09LY5kYitSTlxA3834shRb3bcXb3rteDPlmWSM5wOJx5ZjjgEzVsoen4lmqTRVxqehfQCHSoeGq4FHRMjxQwA5owIuCBXNlmAdGGKcPFgnBDZmsSwZxlsRmSY/dAZrBkKy4VCZkgMyDhkokFRCTT2MksgXzJQK1JyhRLwIAiU5YZeYXD/jRnsYbpkBymKYiITP/xINW9TlkIk+inKTGShJYpO47jiHBBGCnakVAKA49mSAMqU1AMJzOJiukcM8NcRxrQggcUxBMVLAE6phWaNKAcRWFZpk0B/VoQFVkCioeERyAMn3NQQ/LrEgSRCTcGoqDGsM5nESHv+CHToKqM63AJCaPjJ2rWKbLEhYEFKBrQuVQJM+7V397RzSYo+C7EuJvryZwYlUFAsH3CDA9ZHK/duuoqn2yOq2NZ5VIUKzwmU+w/7WR0JmUMTNDN5i6gCr5koM17Ga2xSZ2NnIgfnuSNiU4h5PM1KksokzQzQECsuJIiAWECKybGBShiIEljZiAgETNsEHNxr1FFEplhQwVaZioEwuJYhpaIDggTEQ4x54vM6QaRliON07FLIAwyy9I05q7XwWeNHD9VZovMcgUR7p+cyxOxsvpiF+Mu8AKRs88Q4oqkCtXRcNA4gFuyJ5qwx1MQC7Ok4x9HAU248H9fF0Noo7hYtNYxFyCONCQfM41bj2SCf8mAPHCzrOqWVB07hHzkgidZQmJLckxe42ZVLDSgAvKRPdY/jkblZz2kmwY/tbm8Gb378Tn+z+0Di726Vb4OW9T/2kG92MnXUsY3Kq6oYU5yE9RXB5l8gYSP2vpHJsfkYQmqZoE0aI2a9MDjmKhMWPa44Iaz+GgJ4X0quTCO/rMb2mphqZ6VPltUaZFm+cRQYnQ8CnYTefumNdGzLJmhlszJzxc32m8YiHA3tedppxd+T6pH+1JNIJFq/a2ED62FQMJuPDTDH/n7/TjAruhEKgvDlGJoZ7mBRHdqYYM+tkfyhd0ik2Pt7FbpFDqIVxSxSy9YFHG3py5qGtJiR2RxzGYx0LH1BNvYq+r9iimOXcg9rAcrFmdAUsaVJhrMDo5DKSJ2Umf7hXbiCIcgKQvv2QJy95BbZjJHnJFpIxPfQBMutGFx3BJkZTaWtZjPQadM/EtmSn8/XV7icLusA5nBXCpouV+ZplwshuSQOPHKOZmOpoSLCGcLmmQi5glHDfGsD9H/U8MNLiUtoc1RzYKgMdIXiq+YgQ5XvRUfSBGvqxOxrjoHdqEUAkLjN4pfclJCIhahPLVR2EfbTtqgCCzQCOyEnTuOIIY6pJtlBjsIaaqEuKlikBwq2pVkM4gnke7Ykk1Nb27RXcCK6lSaToHVR92yBhbiXTpUQzfYqEQNthu+0KkU2u3SN6NRGyU1QSt5MxoR3+0liGW3D3ExwB7t3DrXXNlueOK137WqAmRcuSrU3mNRXgbAz7I4JnxeUyyIpVhor7Z13L2xAQEIU/rs9oJMhOMJ58RmMjN2INePhEVHR5drT/iBlaB/rmRCmCDwyLWNpMpuCEJ3r0D4FXii6HKWo86WQ9ixrvjVzmFL507lPzZyeNGU5SagKPAmfmYrZhhyDgnjMbpRhNHY8mwvKM33lUMxZNccHfGuLzl/O2d+o0GhZmzbBd50WoXjpQpZpROdPO2C+x3ge6/OVYhdLmwndG6OcHN5iruGhSFo595UJgRqb6fX96C7w6J1gOqKRNroWmUuOGuhnTg+n9u4/QX6UcFA2zQBY0pkp/OjgkWnwKvKcFTM/nh2bCTFEL2xiRVYO8VivWXLoWE85p1ah5F1l8sviFqS1EfHXSvgI2ieIKTyLWvLgMhqG3h6bkcqSKXmJkfqz6K7GjNlX4Iq59nwPLrQKtxH53ONrfYm2NMRyvWfmawDIiPSRiB4SxWEMklARBBZAqkCGyFgk8cUFEeJMLRamdBZmkqFH+8C+jjAIQYrplDR9DeN1V7tX0DhZrty/ONqS7nHJsZA2VoQTAhgU5IqueIRRJjKs/6qENVfYLgYBuTV5yxdG1CvAvJKOXuBjysdyghe/bANgV577euKZzttU0e6xqLDqp2ojfS8HvaRcR8Z95FxHxnviowjZsAFWZ0xTTE5bDcwPIG2UeUJaMOSFKFLTa4V0J/HqdrcpNFvRgvHJ5kjUBC0JwK/AcFi8Txh7Qi57TifQ2j4Ck6bqvRS9bmWhsUIO7Mki1l1iXN9agCVnK2AcBHGWYQAlYk1gUcDQrs8P2J6y9yRyy3g2102qxqs4EwPbeeuwKSEpH/aAKcNZisi2U/H6hD2sLEUO5xCmCkMKeM1cetXxO9+FXd4Jwf17BT2yIZ4WNiwt45+cwe45kNyIbXm6AisldJjMrWmC6JpgI/u2BSf88jJvXbGDZ/njMeu8SzjcZS/tc8f3KcK5GkhVU+ABjQfH8/n8uH9owObSkllnzwd/+jIbIGv35dA2zSXYDYBrdmiW41LG7qvtjnOLoHp7qjBC/Do8uR4cn316fLm7NP5zTUN6Onkw8nVxeHZp5N/X0wuT45pQK8uzq8/XZ4cnR5+PLyenJ9tm0pBsNsNXZXaiMEeW8F7FM+2Q6wZ0zBJtonEufnm9+Ik9vfL/hYoECKc6ikeyO4BBl8Qtze5PS5gYju/SH4Ggef/GNwwDRGRwoc7KrDRD54RL6yzwECjCEBSZpYvSMyc2XjKpRlL2JqHT7MsvAdjY64fXp62OS7/tSjk+U10f5Xjb4ROg4jrUK5A+Vxj5ei3TDwMXTrDzfkS5s9zc1kVUOF3C+JVl4sfbi4nxOafi1hyqt+ODw6S9cBJBa3bQjffsP+MDw5YGKIeDYvD/qmTnmOwaZdLLcDvQ3JU+Ik8jNZoRi2BXRbUNdli/cqP1d2MKn6Nw22s9lrd6vAbscyiQvfakhuSq4JP9qCtXKRcxODkkany4RMIo1jxdxDi0NaRwBdQLE+8TZ1GT/XbnRNmD5oG1JFC9IIj+l9HyP9zdNDIV8ng/7ddIrnwotiRMWsFM1ZIrvXW7TTN9ACYNoPXOGfI0GAMHkCb19MfsGhgjTUQwu8LLZMiw5EXDVQ2wL6QjxdVHZU1fhlo2zblkpkt5yMvt0DNHb5DKyvUw5qG/o91ZtP+WOF1Fz6szMgsmT1DLDPWXFd33EmSmrXVkjSbxTysGFEnN/v20HbmNiHwrOv8dQlmCY29jdVebiwLW/1wtkIHT4+a67XkUQRiD2q/cM1nPOZmnQNQMo/ZYkgm87w+K6gz4QZ2DiEv2iMx14asODzoZ9KhClh0LuK1T4u0cu9bW3q9+eXwdIIAanLmnjo0YOgRYKsS0X3ocIFHrsZwasecYlZzmhOYDskVWIRSvHEhLNNahtzCgqq+MAX5QXQ03IlBm7ydINgleXOrUFysWMyjqkaVvrr1qVPfbQ7f7d6FAv0NKOr5FDdWWro3XAwKggHVWRgCRDVE34l2L/I+VwbS4R4ovinBf2UJEwNUHJtG86J0jWYeTuTBH/EcEo3kHHxWGI3sI6TyEOW5ibTNTDvqUyZLS34qpydVKGTjHr9FbfVheUhswTI28oOU5QxfU8zwrfmDrUdiNqDdch7mMOG2wCOv19j6eS1YwsNtnyfCgEpl3MiYVdq8PH1XXfpTlLQ/pNvmVYq4wK0LsXUWzUz4tnwjDt1dVx2VdY+G8bjDENTrSPKSj43V3Tej19tqRaK+KqSvCumrQv5QSdO+KqSvCumrQvqqkL4qpK8K6atC+qqQviqkrwrpq0L6qpA/TYDTV4X0VSF9VUhfFdJXhfRVIX1VSF8V0leF9FUhfVVIXxXSV4X0VSF9VUhfFdJXhfweVSHvum4Qec8ifwnJV15w5rfss+hme4RemYO1jC3G37YZP/e39xG8BwbPGh5yK/xu9K7d/EyaDzITUVDmJMsIByPUrhNmbceeYz97R5rveXgxwY8R17izoq++G+73EN3fO89y5zEPDRmQKHO8QkRytPqHnIitNgkzxc3aAoj3wBSowwwPPW7v0PcnYJYS73FMpVVlDDfpmB746ytxALXyVzlmmDOhS2NSDCVZyocWdw4d6hzyjpoM+4Vc5Of8xEUehxcTizw8c1c2dLUzrbJYTBYp+nsRrVGyjTDRZR8+eMvz+cFYiaDUL8trEk8eWZI6WJlf6rjFO5av27fglR/rl9+V7zvvpht1nMnas9JRfno5Ks8TR7WDvVs/8l3zyK3zRKvko3GkNKpnpZw7Ky93uh3d+TuZ8vuTuE/c5nqVryEu2nPLi8rCQ9B5Y5tSCO2mqKtOVWHyZLkl+8/yA7pCd/JOx/T18PXozXBkgwWpTcJEZTGd1SbF/aONtE+xM///r17NtwP+PUhjxq1bzlwi0+3c2sWzS9zT41v69IRJuRsVbzb42l1givvZW2I6tnzuEN1vdilr55TuYd26MTbHRdSeiuzP+Pe8l3UHr9VbYktO7/CPO7G2BjegS2A2QXD7lHc8cpwObGar7NvyIThr1wPj5NTsbFs17BfnV5hfn+XXxSYywj6KPWAAyR6QT7zTtziZs+/wpEksMutyqBsT7Sqrm+WGGa7GqEysKxw+PbkW1/IexGZDvdQM/qebu81m81/RCEJo sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new Studio, starting it by default. Default behavior can be changed us id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-dataset-v-2.ParamsDetails.json b/platform-api-docs/docs/create-dataset-v-2.ParamsDetails.json new file mode 100644 index 000000000..48d611ffd --- /dev/null +++ b/platform-api-docs/docs/create-dataset-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, creates dataset in a user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-dataset-v-2.RequestSchema.json b/platform-api-docs/docs/create-dataset-v-2.RequestSchema.json new file mode 100644 index 000000000..348fadb85 --- /dev/null +++ b/platform-api-docs/docs/create-dataset-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Dataset create request.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"title":"CreateDatasetRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-dataset-v-2.StatusCodes.json b/platform-api-docs/docs/create-dataset-v-2.StatusCodes.json new file mode 100644 index 000000000..ca08f5f1f --- /dev/null +++ b/platform-api-docs/docs/create-dataset-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"workspaceId":{"type":"integer","format":"int64"},"organizationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"lastUpdatedBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"description":{"type":"string"},"mediaType":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"version":{"type":"integer","format":"int64"}},"title":"DatasetDto"}},"title":"CreateDatasetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-dataset-v-2.api.mdx b/platform-api-docs/docs/create-dataset-v-2.api.mdx index 8d4020b3c..4f7423aa8 100644 --- a/platform-api-docs/docs/create-dataset-v-2.api.mdx +++ b/platform-api-docs/docs/create-dataset-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new dataset in the user context. Include the dataset nam sidebar_label: "Create dataset" hide_title: true hide_table_of_contents: true -api: eJzdV0tvGzcQ/isEz4rkpmmB+NL6kQJCi8aI7fYQBMhodyTR3iUZkitFEfTfO0PuSrvSSrGDHNpeDIvz4DffPDi7lgFmXp6/lzkE8Bi8/DCQOfrMKRuU0fJcXjmEgF6A0LgUtZ5QWoQ5isqjE5nRAT+HoRjrrKhyjJJGUUOJAnQuWl7ZemUqJxx+qtAHMTH5aigurEVS/PjL0rhHbyHDcf5RBCOyCKHjljyA2OptIciBNBYd8C3jfIv+Oln99ZLkFhxBCug47rVkfKTXupJ0FAdO0NxK7tPx9/ZOXZXoVCZUjjqoqUJHDEyFKVUImA9q1L4LuUMYOffZHEuQ52sZVpaBKBLN0JFoalwJIR39/EpuNpSamrBL4ottutDqKBu6al2+JV6oA5uAtYXKIkGjB89260MQZvKAWWCyHNMZFHqWJq62Wj44pWdys0fRgZwUggoF7qfjXQJICpsUmXJIOQuuwnjgrdE+3fzy7Oww3re/f7/Q6iR9XVHlvQxwXlmwC+O9hAU55UwSAlVwWXFtseafTCSl8xlXHa+Llss+ZOnyPkmN72TC7sn1WE8N67d75GnAjJuBVl+27fgko6NVVoAP95Yyhfnl6v9O9umWGsgScwV38bSvIYmk1Gs95dqKivVeBEXRdPl9ulGOBXYNJsYUCDp5nGDhWzJwDnimqoClf2azfVPNLKCo+iU0X+gJyrAfufLXOIWqCEfFK7pTZcfEYwLrrCngKDffkKJWqfzBzF5ProOJxwt6zrqVcuId2XmpB3Hj5ciUTnOYxzTpvOqbxJeQN8/Nc0Zyu39L9B5mT2jURvFkJ71xzrgD5D/2vCHNtiC0CQKKwiwJT9R+3fPCVikcFFT1Jcf4L42WhB6zyqmwilvOJYJDd1GFOf38wJsErUBzwxuSNTFpFlgmR9tFkD24RbMmVY7GmpyHYP35aARWDbPCVPnQ4ycicKjMwaJ0GyXihlqAK1Bcsb64uBlLvr5Bd8v0pFDbGLfR8o3NmhQbKCrRSfrnt6a2H5YhUsK0v9stSW8+Q2kL3C0vuwbrot3NBcUDmAHU5NZxMPCvhciEqYxWvqTMlQFZrIwufW3S6hcjXvvrTtDuafnD8PVPwzM+42SVoFvxpF5tlsx9iOtdef7nFvm6AvjnyBag4tSMRK7rau1+tsy5kOlsvZ7Q2b0rNhs+Tms813CuPEwKbsApFB5PUPWdl/zeSB5xdfDdUb9WMrbIApxivLFjKTyEnHdMCiSZXiW4L+ISsLM9GEKbQWNxkWVow0nd9mS4eXt7x51Wf2yUJmcbB0s65L+Ekz+32Do2cDxb06OvZ1WcWTL55L6EblvvtXGMqlkR9KqFkJIZNe7MI2pKaMNb4N8El5z/A66fGgw= +api: eJzdV01vIzcM/SsCz7NONl0UqC9tPraA0aIbbDbtIQiw9Ii2lWikicRJ1h3Mfy+ombHHX9lksYe2lyAWSenxiY/i1MA4jzC+AY2MkTjCbQaaYh5MycY7GMN5IGSKCpWjJ9X5KeMUL0hVkYLKvWP6wiM1cbmtNCVL7+iwIIVOq8GuEr30VVCBHiqKrKZeL0fqtCzJafX55ycf7mOJOU30Z8Ve5QnCxrbGKVQrvxUEyMCXFFBOmegV+os26s8TyKDEgAUxBcm7BsEHYxgcCRkYSfyhorCEbTr+Wp3pqoKCyZXR5NjMDIWRmsyULwwz6axDHTchbxAGGcR8QQXCuAZelgLEOKY5Bchg5kOB3C79+A6a5jaDjrAzr5cSswmty7Knq/OVU9KBjiUEy9KaPBF0dBclrt4F4ad3lLOQFYRONhTF2nK18oocjJtDs0XRjr3JgA1b2r6Ojy1AaMRD0JpAGsYcKkoLsfQutiefHB/v5vvht++XWndJX3c0ei8Dcq9iWKdxA/iIjHKTVKCxUlZSW+L5hxB5m73mqMN1MdhyH7L28H2WDt+zF3YdKUzczIv/UCMvA+bDHJ35eyXHFwUdrDKLka9LjUz6bPl/J/t5SWVQkDb4Ka3uEyQytVrbU66DrMTvDZuCtvh9eZAmS5sBU+8toWt3nJKNAxuGgNJTDVMRXym2b6qZR7TVfkug6KuQ037kJl7QDCvLB81Lh4XJD5knjimU3uJBbr7higal8rswezG9YJ+WHynEzUp55h1Z79I14n6XA1267cPSppsM3u3rxGeo++fmNS15qN+CYsT5C4TaOz6rpPch+LCD/Ic9b0g/LSjnWaG1/ok0JO+f9rywVZsOKbJUSI7/0mybDCLlVTC8TFPOGWGgcFrxAsY3tzJJFMQLLxNS6dOllSg2OFoNgrJDeOzHpCpYGMOCuYzjoyMszSi3vtKjSA8UcGT8zqB0lSzq0iJLBapz8VenlxOQ43t0V0JPm+oQ4ypbObEfk5KAkhNk3T+/9rV998SJEqH943pIev8Fi9LSenhZC2wT7bovGGnAAqAjt8tDgH8tRSHM5BQ7Z6kMzFNlbNI3JK17MdKxv6wNQ03D29Hb45PRsSzKbRXoBgm1Yu2nzG2M9bo+/3OTfFcC8vOotGhS20xM1l25bn63LKSSxzdQ11OMdB1s08hyO8dLEWsTcWpFgTO0kZ6h6jtP+XszuaflzodH91xB0sgjBiN4k2QzWBBqGTJv6i70vIX7Jk0B69idLtRkfcRpnlPJz/oOW8Plh6tPIrXua6PwWmICPkGW/o4hfW9JdFJwWqvBoptXqWlBu6cIEzd1vaXjlFU/I7jlAGFdtx6f/D25poGeN5bf0Nw2TfMPKOAaMQ== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new dataset in the user context. Include the dataset name and descript id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-dataset.ParamsDetails.json b/platform-api-docs/docs/create-dataset.ParamsDetails.json new file mode 100644 index 000000000..183210b92 --- /dev/null +++ b/platform-api-docs/docs/create-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-dataset.RequestSchema.json b/platform-api-docs/docs/create-dataset.RequestSchema.json new file mode 100644 index 000000000..1b7e22e8f --- /dev/null +++ b/platform-api-docs/docs/create-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Dataset create request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"title":"CreateDatasetRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-dataset.StatusCodes.json b/platform-api-docs/docs/create-dataset.StatusCodes.json new file mode 100644 index 000000000..ca08f5f1f --- /dev/null +++ b/platform-api-docs/docs/create-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"workspaceId":{"type":"integer","format":"int64"},"organizationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"lastUpdatedBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"description":{"type":"string"},"mediaType":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"version":{"type":"integer","format":"int64"}},"title":"DatasetDto"}},"title":"CreateDatasetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-dataset.api.mdx b/platform-api-docs/docs/create-dataset.api.mdx index 0adc985de..f21561089 100644 --- a/platform-api-docs/docs/create-dataset.api.mdx +++ b/platform-api-docs/docs/create-dataset.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [Create dataset](https://docs.s sidebar_label: "(Deprecated) Create dataset" hide_title: true hide_table_of_contents: true -api: eJzlV0tv4zYQ/isET0ngR7rdFlifNom3gNGiG+SBHrw+0NLYZiKRWpKy1xX03ztDSZZky0422EPRXgyZ8/7mwWHGnVhaPpryUDhhwVk+6/EQbGBk4qRWfMQvLh5W0jJQYaKlcgy/Q0gMBMJBOGD3AGx6YwD/sVLJ7GzlXGJHw2GoAzuw8BWMGEg9TCLhFtrEfZHIYeBl+qVMf91/d86QyNwKWJAaA2irMjq4uPiivqjCjGWCKdhU1phUXmYp16DYRptnm4gAdWjl4JsbsIkKojQEz1TJLGQETKgQQ3FCRpaUbHVqmIGvKVjH5jrcDniP6wR9JyQmIWJRODAulCA1EUbE4MAQhhlX+Ae5dj6gTI9LAjERbsX3kf1r56tKYzAyYDLEqOVCgkFmckUaQLvOpNDjNlhBLPgo426bkB0EBpaelUAVrjj69T3P81khjpFcYyAk0zZdhsCKJFRRoyaPmnIkIZIkkoEPfvhkSSw79EHPnyDwUBiCykmwRC2Q2HFZZ6Ra8nwPgQM6MjjpItiH+q70LyeONi7+wCZa2cLyu8vLw3A///7jQitL6GVGGXYikFpMGRLqMKZcrFEpJRI9kBEVDVUOcf5JQGI2v8PU8bJoqOzyrDDeRSn9O5mwR1Q9UQtN/M0OeJ1j2iyFkn/vWu1VQkerLBLWPSYhTajr7X8d7NMt1eMxhFI8+NOuhkSQil7rKNdGVMTXdxKjaeP7eqEQImgLzLWOQKhC4xwi26AJY8SWkuMgtt/ZbG+qmbWI0m4Kzhe8GgLo9lzaMSxEGrmj5C3alMEx8gSdNYmOxFFs3pCiRqn8QciO52On/fEaL6t2pZy4Rmot5SCutByZ0sUcpjGNPO+7JvG1CN9y2zT7NwZrxfIVjVoxnuykT8Zoc+D5zx13SLUJMKUdE1GkN+iP5/7QccGmRTjAsOpjivFfGq1vzGqd260agBuYdFu/1VyDMGCuUtxgRtMZrRa48qw07UOJtsUaRDQ+3I19O8waV0A+3G2XpNqsq30pNTgBebUs4lI4CCKdhvXGeLAy3XsKuy0XSXZD/OzqdsLJr8rte0KyQKXp/A4YssjLhcr3mmfCk+Ljt6oNnjbOo0cZuqvXqU/fRJxEUO85dS+2va1HiKRZTQ6UeSjjIMdfCpEAkwhpyUxFJAJfRG34mqCVl4s3+7EmNNuf/zT48Mvgks4oi7FQjXjOxruSOGft5X7f36wu6//5U6EsLtJE7ks/u32OsrJDpvViRK0waj8Umk+wFTUW8mfZHM8eTZTndIwGDTXljK4rI8WcigkbKZSWvrElFyKycCJFZ3flbDlnLzw/OsOpLmdFV3N5Y3L8fIbt3sMnnyH7CkRI2y66WHDcFI70/TpSazgYh3mvkrgKAkjcSd7mRLr9fP9AjVy+emIdkowRG3pQ4a/3Vntg/HzwZxmuH2qZ+unJC53U9qI9NfamhI+qEw9Mmud40M+gMHEVPI7+EzB5/g+JGVpp +api: eJzlV0tv4zYQ/ivEnJJAsbPpokB1ah5bwGjRDTYJevD6MBbHNhOJVEjKXq+g/14MJdnyM9mgh6K9SZwHv/k4MxyW4HHqIB6CRI+OvINRBJJcYlXuldEQw9nZw0w5QVrmRmkvlBOScksJepI9cU8khjeW0JNonIxOZt7nLu73pUlcz9ELWewp089T9BNjs3PMVT8JNueNzfn8/PJUTIwVfkYiKawl7Veb9s7Ovuqvut7GCRSaFu1uQulgM1Vz0mJh7LPLMSGRGO3pm++JgU7SQlJQam0mKiWBWgpJHlXq2MnSFFZYeinIeTE2ctmDCExOFpmJgYQYagC3tROIIEeLGXmyzGEJGjOCGFYYBhIiUExijn4G28z+tcKqi4ysSoSSpL2aKLIQAUNRliTE3hYUgUtmlCHEJfhlzvso7WkaVJlU9PXSzx+hqka1OTl/beSSbTa3bkIQ9SG0UUMEgTXt2QLzPFVJCL7/5Nis3MVgxk+UBCosU+UVOZbWTKy0nLdKT6HaYmBHXkXglU9pm+ovDb6KNTZ5CQsuN9rVO19eXOyG+/n3fy60JoVeV1RyLwOFI8uCdRhDwDl65IOkDFXKScOZw5p/MpGj6Ee2OpwWHZf7kNWb75M0+I4e2KMjO9ATw/rdCngbMGOnqNX3Vam9yehglqXo/GMuuUNdL//rZB8vqQgykgofwuq+gkRPda3tSddOVKx37lVGW/y+3UhSSpsGY2NSQl17HFPqOjK0Fpd8OJ4y94PF9q6cmWNa7JdYcqawCe1HrtwtTbBI/UHxUmOmkkPigfZkc5PiQW7ecUSdVPmDmb0d33oTludk3WamHLlG1l6aRtx6OdCl6z7MbbqK4OO+TnyN8j23Tbd+M3IOp28o1FbxaCV9stbYHeQ/7blD2klAaOMFpqlZkISg/cueC7aowyFBKWUc47802lCY7Ti3GjUoKazyyzDVXBNasleFn0E8HPFokZGfGZ6HcuPqMYhl0F+1fdcvO1dA1V9Nl+zaztt5qbApxNAOi5irXpKaQq4nxp2R6T5IxF0zSIob1hdXdwNgXC3se2ayZqULfkUM7wjNQBVqLShB1Hz81pbB08IH9viEvqzHqU/fMMtTWs8561rcRLtuIYp7NQNozqGJg4G/FiITphJyjTInESYhiTbp65LWXC5h21/Xgm75w4feh4vL3gUv8jFmqDsBndyucuJUbE7324DLdV7/z98KTXaxJ4avQvMOh1Q2JTJcT0ZcC/HmS6H7BptxZcVDKMsxOnq0aVXx8ktBlqtyxPeVVTjmbBqWIJXjbwnxBFNHR47o5EvTXE7FK++PveG0t7Pmu7m5MgEieKbl1sunGlURzAglj7vDstG4qYGch3lk7WGnH1ZRa3GVJJT7o7rdlnT3+f6BK7l59mRGso3FBb+ocFGjNYGY0CDCWgkp6mkR2ifUPrnucbNtbLWJENVePsqy1ngwz6SrakWP538mpqr+BjDfWo4= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Creates a new dataset in the given workspace context. Include the dataset file a id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-label.ParamsDetails.json b/platform-api-docs/docs/create-label.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/create-label.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-label.RequestSchema.json b/platform-api-docs/docs/create-label.RequestSchema.json new file mode 100644 index 000000000..4b40867b1 --- /dev/null +++ b/platform-api-docs/docs/create-label.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Provide a label `name`. Set `resource: true` for resource labels. Only resource labels have a `value` — if `resource: true`, include a `value`. Else, omit `value` from your request body.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"}},"title":"CreateLabelRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-label.StatusCodes.json b/platform-api-docs/docs/create-label.StatusCodes.json new file mode 100644 index 000000000..080928a00 --- /dev/null +++ b/platform-api-docs/docs/create-label.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"}},"title":"CreateLabelResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-label.api.mdx b/platform-api-docs/docs/create-label.api.mdx index dd479f7b6..1c981faaa 100644 --- a/platform-api-docs/docs/create-label.api.mdx +++ b/platform-api-docs/docs/create-label.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new label or returns an existing label based on name/val sidebar_label: "Create label" hide_title: true hide_table_of_contents: true -api: eJzlVs1u20YQfpXBnlXKadIC1aWxHRcwWsCG7aCHIIBW5FBae7nL7C4lC4KAPESesE/SmV2Sokw1aYEeCvRiWPP7zTc/y50IcunF7IPQcoHai48TUaDPnaqDskbMxKVDGdCDBIMbiFZgHTgMjTMkNoDPygdllq1yIT0WYA0YWeF0LXWDGVxsocBSNjpAWCHYGp3kBLCx7smDMhS/8eggtybgc5iArGs0Bcx/jha1zPG6mEOwkEdAUwLgFK6RHFPeGKM37gJlcIfeNo4kqUKyy3VTIMxdq5hBcA3OqZSCIswj4nkmJqJHeV30RPzGQUhXS0flBXRM3k5wrWQzwEo2ivn71KDbipes/t7jNE2FTuWgCjRBlQodGft8hZUUs50I25oDKypmGVWldZUMSfTjG7HfU8ccUhYfLmyxZZ/jVLfOril4z9Ocsc4zuMcw5qCMrT0iLIMbo7cvpbCSkfuWLvjj8xdQ5SjgpKf7wCxcaY8TsJUKvXvpbAVb8oS2FlhQMdyE2EcTuC4aCa3y2JHpo+fidmOm7OIR88Adcty/oNCzNjWot/I0PGYp9hMRAZzUdKUMlAtrNUrDWuXfpYE+pSZ9UEHj8djcpdJIvU89Uw5pspiolK62xie435+djTt58+u/x4cq/tZ0Tf4jxCVqmDmyeHOKnAtZdLPzT1g6tOGDqNB7uUS+gV8nrzMcFz/Af+WcdSPkr0+0tT+GxgaQWtsN4WFzj3njVNjGE3OB0qE7b8KKfn7ktaf7s7J8mmobi64l68S0PeXs79bdhWqcJt0qhNrPplNZqyzXtikyj58ofabs6EbdRw3cahl4LOCS7eH89lpw8g7bPVOZaBki7JnhjN1Fi62ORiRJ//zSDdzjJsSauUV3h3t29SyrWuNhhTuq+wE8CA5zxyt1NGntjilT2oit7VFbItf0reqZS5XTQ5iMecBkHgfsmNkhnzRjSsdlKu3bg4KXh9qS8rzKfvohO2MZd7GSZlBqWoF0cV8C3B1m/P/8RrdTxmGmtZYqnpjYkV27D8NPmxUvCkl2O2bgvdP7PYvTG81bUigvF5rPQSn5lfprzr/xgp/E9YTb0UdCN8VxqdbSKc4fN5zgoiwoGgNLrpcp/XcPHP3gOzpx+0nncZ7nWIev2g4vye3N/QPvZvslUdmCfZzc8HrRX8LJ30XsHVc+ynbEsFk28SKKFJM3WR4fgheLH6tqVdJsBwipOdHiwT6hoQZ1vAX+TXAp+J+aJrv2 +api: eJzlVs1u40YMfhWCZ1XObhc9+NImaQoELZAgSdFDEMC0RNuTjGaUmZEdQRDQh+gT7pMUHP3ZsbvbAj0U6M0ecsiPH/lx1GCgtcf5I2pasvb4lGDOPnOqDMoanOOlYwrsgcDwDqIXWAeOQ+WMBzLAb8oHZda9cUmec7AGDBU825KuOIWLGnJeUaUDhA2DLdmRJICddS8elAGCyrODzJrAbyEBKks2OSy+jx4lZXydLyBYyCKgmePgFG8ZqM8bY4zOQ6AU7tjbymXcuUmuTFc5w8L1hjkEV/ECyORAsIiIFykmOKK8zkcifpEgmGBJjgoO7IS8BqVWnOMeVkxQCX+vFbsa37P624jTVAU7lYHK2QS1UuwwQZ9tuCCcNxjqUgIrE3gdTSvrCgrd0XefsG2fEnT8WrEPFzav5c5hqltntyqfeFoI1kUK9xyOOVjF1h4QlsKN0fX7U9hQ5L6nCz7//geo1VHAZKR7YhautOcEbKHCeH3lbAG1rSR7rAWWNq+lCbGPJkhdVJZaZbEjs2cvxTXHTNnlM2dBOuSkf0GxF2vXoNHLB6fMGtsEI4CTlqGUPePSWs1kxKr8j91AnzK3CQYVNB+OzV1XGrZt2/VMOc5xLkR16UprfAf349nZcSdvfv73+FD535qu5D9CXEeNMNcm+OkUOReUD7PzT1ia2vCIBXtPa5Yd+GXyBsfj4vfwXzln3RHyb0+0dVyGxgYgre2O8xjKc1Y5Feq4Yi6YHLvzKmxw/vgksi84bKysptLGoksSG876VS733XbYUJXTOMdNCKWfz2ZUqjTTtspTz6/sKFX2aEfdRwvcagoyFnAp/nB+e42SfMB2L1R2tOwjHJmRjMNGi62OTpj0P34aBu55F2LN0qK7aZ9dvVFRap4kPFA9DuB0MM2dSOpg0nqNKbOyEVvfo75Eqelr1QuXKmPfO8uAURYH7JDZfT65IKWjmFb2h8kg4mHnuzwf0g9nH9MzOZQ2FmT2au000K3c9wibacj/z490P2YSZlZqUnHHxJY0vSD2v202opT5IzaNMPCr020rx90jLTLJlaelln2wInmm/przrzzhJ3G9cH30lTCMcVTVlpyS/FHiCW6YcnYRWHf1skv/zYNEn+4e7bg2GW6cZxmX4Yu++6vk9ub+QcTZf0oUNpc7jnaiL9oJTvkwkttR8/GsQU1mXcWViF1MkTIdboJ3yo9V9SYy9R7Cpuk8HuwLm7bFgbcg/7F9atv2T7FgvBs= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new label or returns an existing label based on name/value. By default id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-managed-credentials.ParamsDetails.json b/platform-api-docs/docs/create-managed-credentials.ParamsDetails.json new file mode 100644 index 000000000..8147d7560 --- /dev/null +++ b/platform-api-docs/docs/create-managed-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"userId","in":"query","description":"User numeric identifier. Append to associate managed credentials with a user other than the requester.","schema":{"type":"integer","format":"int64","nullable":true}}]} diff --git a/platform-api-docs/docs/create-managed-credentials.RequestSchema.json b/platform-api-docs/docs/create-managed-credentials.RequestSchema.json new file mode 100644 index 000000000..9db64ee33 --- /dev/null +++ b/platform-api-docs/docs/create-managed-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Managed credentials create request, including provider type and authentication details.","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["ssh"],"description":"Authentication provider type. Currently supports `ssh`."},"credentials":{"required":["name","provider"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"name":{"maxLength":100,"type":"string"},"description":{"type":"string"},"provider":{"maxLength":16,"type":"string","enum":["aws","azure","azure_entra","google","github","gitlab","bitbucket","ssh","k8s","container-reg","tw-agent","codecommit","gitea","azurerepos","seqeracompute","azure-cloud","s3"]},"baseUrl":{"maxLength":200,"pattern":"","type":"string"},"category":{"maxLength":20,"type":"string"},"deleted":{"type":"boolean","readOnly":true},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"keys":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"s3":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"},"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},"azurerepos":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},"azure_entra":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},"container-reg":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},"tw-agent":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},"k8s":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},"ssh":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},"google":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},"bitbucket":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},"gitea":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},"seqeracompute":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},"codecommit":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},"gitlab":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},"aws":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},"azure":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"}],"title":"SecurityKeys"}},"title":"Credentials","description":"Authentication credentials configuration object."},"metadata":{"description":"Additional metadata for the managed credentials.","type":"object","properties":{"discriminator":{"type":"string","readOnly":true,"description":"Type discriminator for metadata structure (read-only)."}},"title":"ManagedCredentialsMetadata"}},"title":"CreateManagedCredentialsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-managed-credentials.StatusCodes.json b/platform-api-docs/docs/create-managed-credentials.StatusCodes.json new file mode 100644 index 000000000..1352fb882 --- /dev/null +++ b/platform-api-docs/docs/create-managed-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"managedCredentials":{"description":"Created managed credentials object.","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Managed credentials numeric identifier."}},"title":"ManagedCredentialsDbDto"}},"title":"CreateManagedCredentialsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-managed-credentials.api.mdx b/platform-api-docs/docs/create-managed-credentials.api.mdx index c1fc49c95..43b0e4760 100644 --- a/platform-api-docs/docs/create-managed-credentials.api.mdx +++ b/platform-api-docs/docs/create-managed-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Creates new managed credentials for the given `managedIdentityId`. sidebar_label: "Create managed credentials" hide_title: true hide_table_of_contents: true -api: eJztWt1T2zgQ/1c0fmpnTEJLr9PLyx2kXMvQlg6hTx3mUGzFUXEkV5ZJ00z+99uV7PhLCeEgHT76Aom0Xu33rpzf3NM0Sr3eV4+HTGiuOUu9c98LWRoonmguhdfz+opRzVIi2JRMqKARC0mgmHmCxikZSUX0mJGIXzFBLnKSI8txdhRedMiZJDRNZcCBkaGtPj/lekwoyVKmiIRN5EaFIVPse8ZSzZRPaJIwEZrVi7+QFhl7vicTpihKehQuZf1oReiXhwBhQhWdMOCFCs89AV/ggZa0QMlR64Tqsdc0Rc6Y5OaaEZFNmOJBvjDiTKFMKDaHw72eVhnzvTQYswn1enNPzxI8lQvNIqaAFIw3odouvX7lLRb+UjSpolIcsIOateQ5UREV/KfRf4Us/+9sa+D1h39BhzkOJfu5q6pOdwXOJo6/mQq+J7I4psOYWdMvFufWG8DrQIYz5OH2aFWuwARRIYNPuAjiLOQiIomSV6ApCAqCEApK0gzEhecC64OQacrjFKUOJEgpNB4JsRvnFN1vKZ47byslh99YoDFQFca0yUXYLY6sUKZagTBAycD6mL1pOm6n7X5dsproHdLPlILdeEbSLEmk0im5ADaQUgsQvZI4cGwZzl9tfPilVHDsevl5iH8n9McHJiJIqd7Ll35DETjRhl2N7sXuroOwpmPTIgu/Zq4qs9dNXqX16BTLA/2ZKVb8/xe0VxS+RVJGMS5HEKvZ0H6AAIMPQ66HWXDJUGV0gO9dvklzv1MumNpRDI/R0x2IMKHNVsgCOZlwbRkxWhyoWCLx4ZR9h3IGNEmml9LsBLHMMBnTPe8cdBzSlH1RcdOuaC+oWpA06H7PYTwIBRZJNWs96TR0DMUyrBh5KGXMqDD1jYYnIp7lSeZ7MU01lIPQFaTLFA3h9B3NTfy0OOCmLd63YGLESMLbMblks/T6tAw5xuGEC6qlMzcbfFHF5iM5x9knW3Pr+z54KEmQFxaLvbuXCIIrCFiaHrOZM5NSBmVAO3d9b6ogemvMsF8O9Cxm+4brocAq7AofNAX0TizR3mBvwIIMeM2O0eqLZZ5tQVtsM0WZaZcN6FRTqZxh09S1Iv87rt9nw6YOlYx+IHrso8SnKLFTl7wcOpShcXwyMvPUXas5pDoYf1qlZwpsoKqu3DdPbxy7ObcN6Zt2a5hsfmvVYWygQh85nIg1PObsms2BydyNVMH5qKbMIXq6cH69lW0pllf68CaxjLwjDtuuWlZxWL/Q6DQnL1RdduktaAlmFMApv6M4NAUtL99yBzOMzTFV19bR/ci6vZa6OI5sQxt8eIRj5Qq3KX4Fexsnn5aXzDHLrc274zetQoUj2Ba0vak2GLTJWMGEdkOVBoP3rV5oh88taAUDEL2hfO+MME0RyyF4C1JuHBnbaYoHXB8Y3RwzCtvg5nY/Wvs7FLaVLLVrxi/t63c6dIJJsgk7hYK4r1z3wWqJnDZLxm0bda15DoxF+9aiTXNX7n0PJGr6IHHfSOwIfrz/Pr50h0T5QNuz/HQrTfT+ZEH+4mMLOj7UCR63pWBPoP7d17HiYdRI5+X/aZTFR6flqlnvwURia8Z7VFehp3KL/d2EH1jmrXxx+ojflT2WF2QPI8JW3sR+v4x/Ui/jf7+j2eo7mntuxDv5dbVmitqNt1JuapiptYiSGmRGihGPMovEItaGBkoyYZoW18IGtzDk+JHGpCBaQskcaKFOCWi4Gxc1tTsDalLjYcRZygZsskBDVpJnyGhHAqfnnZrx2rizj4X6DRs7QWqnFnBk30DUMWRmIU2kSK2uL3d32xY9OfbuDHY0aUPoWufleA0ntqsIgc3gQTnNGlzX9agtF/xtvXPeDt9quaFnrO3RNUD+ymX9AxoWkLGbuKEKrppAasPJ14OqCsK11fRQKalaku854qaAUBIhNYG2Iqcgz8JWKVMmTJc5YDBoKSwC8PUcqwnkxlgi7BLmXyMkYiZ7XrdEk3bnLYDlohvUagzMTFcFKDNDVJM31jpJe90uTXjHQJ869veKDpetSLA1nXyOqcaYIX2kJ/ufj0y5K+QfoLmt6apaLK2HJ3o50NBUU0MEK/bDP0U0fptqYxd042kJKzz8QSeJ/aWuxJ/loLAGlg7jvaxIOdpy+b2u23K5wtSC1ZYIsJKmxHaVawWUqdKKys1KByoXG826GlaVSo5fuRhJY8FaczWWv85H6HEOEuXEBmUQmFSp+7/qdcgWHpt6MJJ/lxsgCAaPPedF588/Ortm1oZ4hMBDlrmJbWa7SlVT3HmZu/cc+pwHr2Y/dDeJ4aqGqmcWGGhTsQbs9r2eC+1cNQWkzBhTGR6cz/MgWyxw2UKAMUehRebDxwgeabbRqvU2QCc7Vbg0MVnAn69onCGNGdI2P/yXoZPXqLBEUZc6nOMXxS1E+UbWfHaad4rnZEMYulOyfJGKWVWuQuJ2gCwQcTqGgQfLDwhs6fpWrB0cmip8Wq0OfWafwME10Wtpqx3l88ngDAtdDtqewC0YVhWd4hwHf43M0pjJYpRxbe7FVESZ6Yye5YmlitaLfaO4V29QdatAChiKM3y3B2lQGMm+6wPDLBb/AQjbX4U= +api: eJztWltv28YS/ivEPrUALTtJURR66bGdnNRIWwd28mQYxyNyRG1M7jK7QyuKwP9ezC4p8WZZPrEK28mLLS2Hs3Of2dW3FASJFeMLIWNUJEmiFZehiNFGRuYktRJjcWwQCG2gcB5koCDBOIgMujcgtcFUm4BmGCTyBlVwVZGceI6Lk/hqFHzQAVirIwmEjrb5/lzSLICgsGgCTTNkbqAcmcHPBVpCEwaQ56hit3r1O9MyYxEKnaMBlvQkXsn6lxfheL2JCEUOBjIkNKzwUijIUIxFT1oRCsla50Az0TVFxTiozLUIVJGhkVG1MJVoWCYWWxqMxZhMgaGw0QwzEOOloEXOu0pFmKARoZhqkwH5pV9/EWUZrkTTJlmL87lAs+jJc2oSUPKr0/8WWf6/vb2BN2/+kR02sGlwWLmq6fShwNnG8fdTIRSqSFOYpOhNX5aX3hto6UjHC+Yx7NGmXJELolqGMJAqSotYqiTIjb6RMQu6yDEAFQdQ0Izfi7wPYiSQqWWpI60IFfGWkOdpRbH/yfK+y75SevIJI+JANRzTLhfHS1Fv2aC0ZKRKRChQFRlnr7WzftoetiVriT4KjgtjUFG6CGyR59qQDa6snV2NRBmKhjF423U4X/j4CNdSXYZ3yC9j/pvBlz9RJTQT45cvw44iZViFXYvuxcHBAGFLx65FyrBlriazX7u81taDOZcH+FoYrP//DxUZEKFItE5SXk4kzYqJ/5ACf5hImhTRNbLK7IBQXP9mK7+DVGj2DPI2NN+DhAOBH8UY6SyT5Bkh1BsazDW/bPEzGoh0lhe0kmYvSnXByWhficsyFBOw+NGkXbuyvXIgQsPuFwPGi4Aw0WbRe3PQ0CkSxg0jT7ROEZSrbxCfqnRRJVkoUrD00baoV2ZepWgMhHskXfz0OPBDX7y/gYkTI4+/jck1LuzdaRlLjsNMKiA9mJsdvqxi95WK4+JvX3Pbz0ORQZ4zLy4Wrx5eolBAFKG173AxmEkWI4M0+DQUcyMJW8y4X57TIsVDx/WN4io8FD5sCpLEJVqcvzrHqDCSFu/Y6uUqz3agLbeZusz0ywZYO9dmMGy6ujbkfyvpj2LS1aGR0U9Ej0OW+IwlHtSlKocDykCank7dPPXQak6Aotnft+lpSRtI8Nbn7u2tY7fitiV9124dky2/WXVCBYpOBpzINTyVeMfDc5e5W6nC81FLmTfs6dr57Va2o1i+1Yf3iWXmnUhLZqiWNRx2XGt0VpHXqq669A60jLRSGNVnlAFN59pcv5YDzDg2Z2DurKOHiXd7K3V5HNmFNvzylMfKW9xm5A3QtskUCtLXODDLbcy7d7/1ChWPYDvQ9r7acNDmMwN2wDgbVTo//6PXC/3wuQOtYiC4p3xvnTBdEddD8A6k3DoydtMUjyQdOd0GZhTc4uT2OFr7Wxa2lyytY8a/2tcfdOgEa4sMz3SKh2boPNgskfNuyfjWRt1qnufOosfeol1zN859TyRqjnWMx07igeDn8+/zS/e3kv6E/iw/30kTfTxZUF187EDHpzrB82Ot8Duof491rHgaNXLw8P99lMVnp+Vts96TicTejPesjkLfyyn2RxN+Ypl368XpM74rey4XZE8jwm49if24jP+uLuN/3NHs9I7mkRvxQX5dbZmideJtlJsWZmojoqQFmdFqKpPCI7ECb0MHJcmQoD4WdrjFseSPkAY10QpKNoAWGom7kCb3dFFXuw8M6WnxcOKsZLNkiogKg8FPzGhPq3Tx86hlvD7u7K9a/Y6NB0FqZx5w5G8g2hgyt2BzrazX9eXBQd+ip+8eDnaU9SF0vf0qvMYgtqsOge3gQRXNBlzX3aitIfjbZue8nrwmvaVnvO3ZNWUofhmy/hHENWTsPm5ogqsytBYSvBtUVRNurKZvjNGmJ/mrgbipIZSB0hRAmuo5xo6VrcqE6zJHCAYNFwExvrjkapIhzTTDLnPtlHaYybHYX6NJ95c9gGW5H7VqjEVzU4MyC0Y1iRlRbsf7+5DLkYM+jfzvFSOpe5Hga3rwPgXimAmOmT44fH/iyl0t/zmb25uuqcXKerxjDTR01dQRMcjLffhvHY2f5uTswm48W8MK33yBLPe/1K3xZxUorIOl43hfV6QKbbn63tZttdxg6sFqKwTYmmaN7Vqv1VCmRitaP2x0oPVip1k3w6pRyfmrVFPtLNhqrs7yd/mIPS4jtBWxQxlELlXa/m96HTOQqasHU/2f9YMyFBw8fp8XoxcHL0cHbtjWljJwqVbZ2Kf2UK3qyrtcJ+8jxz5X0Uv4hfbzFKRi1QuPDPS52EJ2h2I8BHdumuIyFDPO5fGFWC6rKCtLXvYYYE7SWNpq+phCart9tGm9LeDJgypcu6Cs8c83kBZM46a07Tf/1+DJG1RYwajXOlzyFyM9Rvle1vzprGoVPwdb4tAHJasWQS2actUS9wOkZMjpDMHVn4tlRXfsxdrjqanBp9fr2Gf+DZ5cc9pI22wp70/PP3Clq1DbmY75HQNzHuRg7mXWzkwepMxrS5GCSgrXGoXnybUK2tW+U92bR6i2VZZLT/GBL/fKcmUkf9lXXpZl+Q+CKl+q sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates new managed credentials for the given `managedIdentityId`. To associate id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-managed-identity.ParamsDetails.json b/platform-api-docs/docs/create-managed-identity.ParamsDetails.json new file mode 100644 index 000000000..39a5ae4ac --- /dev/null +++ b/platform-api-docs/docs/create-managed-identity.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier. Append to create managed identity within an organization other than the requester's default.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-managed-identity.RequestSchema.json b/platform-api-docs/docs/create-managed-identity.RequestSchema.json new file mode 100644 index 000000000..8e9238bc9 --- /dev/null +++ b/platform-api-docs/docs/create-managed-identity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Managed identity create request.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Unique name for the managed identity. Must consist of alphanumeric, dash, or underscore characters."},"platform":{"type":"string","enum":["altair-platform","lsf-platform","moab-platform","slurm-platform","uge-platform"],"description":"HPC platform type for this managed identity."},"config":{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig","description":"Platform-specific configuration. Structure depends on the selected platform."}},"title":"CreateManagedIdentityRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-managed-identity.StatusCodes.json b/platform-api-docs/docs/create-managed-identity.StatusCodes.json new file mode 100644 index 000000000..5356e263e --- /dev/null +++ b/platform-api-docs/docs/create-managed-identity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Managed identity numeric identifier."},"name":{"type":"string","description":"Name of the created managed identity."},"platform":{"type":"string","description":"HPC platform type."},"config":{"type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig","description":"Platform-specific configuration."}},"title":"CreateManagedIdentityResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-managed-identity.api.mdx b/platform-api-docs/docs/create-managed-identity.api.mdx index e1348a8a1..df0e6eff4 100644 --- a/platform-api-docs/docs/create-managed-identity.api.mdx +++ b/platform-api-docs/docs/create-managed-identity.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new managed identity in an organization context. Managed sidebar_label: "Create managed identity" hide_title: true hide_table_of_contents: true -api: eJztfWtz2ziy9l9BeerUOlWWlNtO7cmnI8tOVmesRK/lZGpPaiqiJEjmmCI1BGlbk8p/f/sCkCCpCyU7M4mCrdqJRRJA49Z4utGXz0eJN1NHrz4e+RMZJn7iS3X028nRRKpx7C8SPwqPXh11YuklUglPhPJOzL3Qm8mJ0CWWwg+FF4oonnmh/6eHZcQ4ChN5nzRFr/gxVC9k6I0CKcbwIPYC/094O44lvfcCXfscfolpFIt/9ztQ4NaPoxCfqebRyVG0kDE1051kxOl2upom+Grhxd5cJjLG7n0+CuEHfA1UQqmTIx/79UcqY/y02Nt3dkfCdC5jf6zpn/oybor2YiHDiUgipBvaro7InZ9crxiVKLmWsUiu4Tn8JWIJBCig8B9KTOTUS4MEu6fG13LuHb36fJQsF0izD2M5kzG8ghGZewk/+vnl0ZcvMFW6ltNossQyxb70ypRpinUhbI6mKkywrLdYBP6YaG39rrCCz1VqotHvcpzgAMc4EbRiXpnxzb5SSeyHs8rYvg99aFjgxzS9OAzl0YNFk6oEl5Dy4d9oKrxgAWPGM3EiJp66PoGBFWk4gdkdRzEspmuY7TFOdvPoC5AWeAmO1SqCJFSEC94LEs+PG9mnJ0eBmto/55E3sn+rII3n9oN0JvOflU2DK9e8FUiE7rCvqj1GmqG/U3+2faDvovjmzI+3j/Vb2IDTILoTWEJM/Bhqi+KliHj1jYNUrz0FgwfUTH3YlWoJD+d6CkYSl7A3UlGQwqJZeMk1PLC3K/QFP7z2bnFNeZPGXezDl954LJWeilhepuGA6NpOc3syAS7DT3CjJELey3GKzMdnssNpI/DScHxtvlrEPo5rBB/cRjdQqcg6DgOHdEjVFAMpxcd+LIn+RaSSRpyGugr12/F1kizUq1ZrEo1VU8k/gME0/ahl5q8xDqJ00uKGW97k1gvHcvIT9K0B9TVMfQ1d3xPuOTx9nK57U5go2AXBiq7x2I+j+SIAZjf5W3oaaqo65SW8vqs+/ulZHeLlnzJjx+lEZrTU3Sl9RUt1364YYhtcVwPr4m7wl7X21lm2m+6Apcu8GzA26pF2j+hORTT3E5jVE3M+KByZoWYBQ6I6VTJ+W4/5wpcZ5x0M/o2jGUI39IAjw7oGKkQYTSRVfQ2zXa/qf8OXVDXU3O0LbzKJoQvIu6u1LqI42Xq6vXheaQMpxrJNccaD8UoMnz/nQcAW/l8q0xqkXl3r8weIQ4byBxYrMUUBg0oHvGY1+CqbYt6WUJlm2/MFTO8eja9sGNq8u/ahyYW/kIEfSvF7NAIOAGtMpSNeDU3RgYUFyyu6lXHsT2A1idGSqslKFbYTETr37onIASCufYb/io7qe3+ezhEVjYBY6ARRl29PoIvJxI7ko6ugFBy3oYxShZs6n8BnT5/mM/i/0egdNad24iG6xYiLZrgio4qWHxCqz6No4c0AA/17XYOjKAqkF1ZahO2YxKk8EcMirUOaHdjNzLN8Xjk2BY1s6oReLjRuQA8QBAAgwGbbI+gpYJg3MKOakZYp6BvOphZyDGB0XJpmMQACx0kK5EwkYlRllpeSAWx0aN8wx2LbKzH0JWNE+PALo0zgeQC4cQzogVpA5xmTPH/6tIo93/3yeOjSn9TBw+XxqqDfFWiezq9aPO6txTQYRk9WI7lN6HMLRvw6SPDXIgCkkwh3iYKfCJhwQOO5nPgoGmCttG3wYHQY7kfBcJaQbfXTi2MPJWSAJXO1fUXW20jneVPi1ot9UgdgUSLk1gvqnKQrK6Gy2XFSg6e3EWSyUJZVUmLexeND8+9Hqrp6GuR89iOPphmQk+LP3yzmTewCxuODbgbp3D5YBCWVTMymNLRYC+GQwP3ERyLnfugB09vei35Bci8UFseE1aMwWJ7QAI48RIvQsYyV83ELNT1BDQt+/g6+1mfnKmL0Nloy2i69R+y2WCCV8GVRK4H90MugBy+KAw0Fy9sV+M+7KenDnJLBHVDf1QF1IHzIKRmcksEpGZyS4ZtRMnw5+Vw6/HeESga7MJ5E4FPAk5qbWvcmJTzkZI+Dkj3gf79BZd6daoy8ZHxtY9T2rwNxig+3AtXi3KKiwpvJK/po1ewAdBijQiZbUsjpYtmd1Pz8Fo7PuVQ1Vp+upSpinQ6ErgWHeh6lsDiOmd0BC2rhMdfC4/lVC3ViHvDPmH4P95JPHr7pYjnzWQm3hQfCnPG3GobAoRulMaAHcecDWhzl2rBj2Zw1gXWlqiE9wHDPdN92O77sRcK9Yf6OLBeQT4joWy9aKIrrIty55rzGs8v2m/O3mdbLoPhuAFMJk6Hf18WBKl0gepCTTyqaJnfAs1tMYQuP0Vtf3j2xyO6GKkG8uH5dF1ZY5zmIH1wiv1Au059NwvRZ8/l94MUzWZwFOFMuo6BGe/iVaF++xSU2iz00yIBF24A/4Z+J6LZ7Apbg3FeKTkT4ah1vAQ5v4Ey9prHu2DSPvTzvDETiqZsSLtoBka2a+/WsVh++X2ugNvD4wO8DU6ihoECkr6vCvnUuurw6goClm0yto5kNVb9WrndC9A8hROt13Vmkah94/jaD5J3+e4X9jOgc3bymdaM9OQdZtjfap2EuaxrE5b12/57g+pvLmTdaJvr+wuHLQ8KXwMVgI52TFWGdceAvxcdfeftpdrh+g2HtT2zxcQpil2QBcpoiD3++e+OvqaCt/lzbPrcBFFzyeClRonwNbeEtrJgBI+WdCXz7oSdzdKHxtkVClX7WZkWzN3GULrav6Q5yq1/pAL6IZgoOSihGuzjrmIDa1CHp+ngmB6G3UNdRUkf8Ly2XrOiWxdKapf5EtpT5/Mn2mYMOzWT10p4h0mt8WRpBrfloio/WN3XHTDODBnBi1cpEw5/ovw0ipWF9YpjfE+GlSTQn22ODc4qSgfUxnaLAbDS+KxJvWA8tOJD/gmhZxB9apUX2xZvPgWQNWDd2pYP+uyv4CWi9ahPateF7Uwzho6EmR4k0pHv4OIWvcRFEYWMi59grG/nDBAyxibxcsdRgESX5x+IYeidxj6mE1yQINfue/j0/JMUcnf0wKLc+riy0fth8gzj37vduUusCd21ytkh3ZoFv+u+tUSbcMFJtWICDsResOxWLmoS12ryMdIXqetQV4MpuyPsFzC+1DvL/zaZeibdRQi88nmc0MV+3t31LrnyITqMTzedeQ0k0pUeUF2T22LiqiuuSljQPG6G0QYJlZstNW+X0fHD16XUXt4v581P/8t2by/PBoPvhHB7jSv/Uaffbne7Vfz696191e93/Oz8zb/qX3c75qveVnXeGngBz3OHiGvY7cxFWnKji/iK7fhippYjShBhKJnMWTt5VFA+Jv+QbN68Ufw030sxli9uXZ3MOR/E6TVZhulI4t+ei3euK7hl2I1Us5/KJhQyvxEmsKyTkrRd+mN43nqO03UB2PyfnDGqf5Zy5lIkqLFGjDPqHonaNYZq2R7Mvl7BUgKw8wZMY9gNUfQtohs4WviVpz70/4VexeayWYUKxRWB8iq5QGFkvxnWG6EO/g2OD9YUyQWkYvqIKVDqCJw/ZLRd6d2AbujYSdlWE3aahz2mfxjBT0oNFSE4h5M+AQ0DMHIoyTbDuYj9ZEsR6DNJMhRp9dc+IwolEfQWKtJK+msJJeYcybJySmQjOPIK0OAqoF2Ym8LIN+Js3hQlnTKHue6j33D4Prwf3NAkXpKbV2tJF5Gv2DRXVuxIs1WMxwlzogsr2vY7aUL2CKpFfvzk16luQuOW78Ax4SlJUrG6965lgGYY3lnL1WoYrcY6vdAFe+XL8/Be57Ht1bpRx9m4kWgD6cXZBa9lREGM/Tcc3j7MTvByWD16IEder2/O1zLjuBIez9xSOkZt9py7Xx5eniiHzZniw+VjXgKF6+orj22cMs0b+pC9j9HHzZnvRb5CPOWsXsT+mG12veEacCA8d8xZZY4aZ5qcQF2WFiZcUT+xmGTCSTj+M6FjgcwMah93pB8z30zjGRaiwFFcM63EkEUSToTEfAHQJCYsgJ6t0H/tfLLPKqWLb4122y1i7I6Iz4vnrQQX+QKV1zoLze1imdCgW6wC2aKqpyc3KFVjsDNedJbnnuv/dVQiPfhMh9DcWVe25X2foNMTAJfUVyKqA8NMoSvblA1iWwTWxASQ5q//E4gpyrOpqGzTOKkqYRh+JNxXYH5j/zAGVLT1Gy1yANU6kuep02JLJuAVU4P+bXPeQVxUQSUjBmG+QkYtoB/A3Ll9Sw9GHc2+JBwhsMvLJhd/BFHYw0ocfFmX7FSIGqUbyDhQ6WJpgkOGbHsE1oHXeYuQGRVsM8VoTeQs8AbY/ayagTw2qVCtJmtfJPNBKEi82lhL198RlGlaVmGjm8pprs5RKCpfVeLMui+B5gRHmEhuO3BxGPGhmlcN4hyukMWQDWBGhhrxyfbTG859f7rzp25e9n1+K4zexd+snUWjvDas/TNZJWU94wtSslhH3uYHsbr19LFqb0FLLzExY5TS5NAhnF1V8jiT6ljJG32SXlkaGoMy1NGw8e+nn5rtPqnppfSue35SdVB+hecMsimaBZKZmWzi8oeeCtJ07Gjn85RYA7sLv8C/8Nl34HoiW3d3uudu9w7/dg+WKC7cOOi+cQbqcEWrqWn0V6tDmX5Z5lw7eYgy8APvVWPiFOrGIiZPCwVDWtdHwoJW1dupYdurHIGtSjbo2ihgykok/BmaFamutTyMo2B6PUUA7n3t+sJ3qARdCtQWJdRKLEfhBwx5WZvAZV1Da7gSseh6qZzWuMkMQPmtgHRMvnpAlXWEIPDMIJZMwWydaW3EMopxWGrCulxSCLFpIoaPtwC8LK+Oho62NAGAZUS4Tgj70muLj+xEMVyourgb5ZiDe3mTwRIKD5iO0S1rUumpFqjGRsBsC9VNKdXyCuX4i9PJZpKMAXXjpW22zrmXKJiI8vMdpcIyhiS3qeSCqSrkQF9KLqXMfehvomsCnjUB/2rid2wT+hA5fn7TuGgjDn3rkSA7ovD9rl0YIpkVfZeKKBO5qHLKb4p3RdJ/AoYlcohHd4Q3XmKVM3U9jaundwrgQ0yEJb5qSt3cMtQERDxY0imv4cS7RoEByBvI3CvBv9jL+wZJmgY4ycd6stY4+ic7DmR/mNgxNMVxMsg00zDYG7iIMHIQq78I++udT8ebUqAztbfQ3ii3MKh9RbPH+hOVSlVra+Pj7EFr2t2DcjvsdmHRg8ocAk9skv50BDDOQDz1WshoEM9Dc99PZc/Xp9oUGi+sgKL1iJljTpoxbNYUsk7IPPWNHRne8tW6G/ThJASzqInmtGjirdJR9XktFTrTZpUxN82KYlTqVoVNlw1PKn4Urgo5UaC210Al8+KNOO9VwgVTU6PoBwlzji3Hu8BdEM4wuohbeuBbUvIhmog3n4RJqUaQ3pKKmhXkU+hyUxNR+hZui3mWw1ssnGSNFjFRokDWfXuJ1okB76J+HE7qo2V79GZSDrWUKCqlLsomFMV0s1n6ZBrWGpVw33rybMYGqBazsxAzKA/BI8Zi6kSusc9YfPbZmt+ctmucgni0/Dehlk//5VL0LfhiuMebeBWSz4iGpZG/kysAIWm5488t5doOyQ5gEXckv6YjsMrAfBbBygEDJaX4PQfOLyg5ZY6UVVjYb+UC7IEm9v7zITnJD4BL2cuPmX6qB7owoKOszXamgI+MaAzoYXIgx7goyEiMoaJ0q0rgsmYgBJE/jM5tK3sRZ5C46QHbqZ1aK+GsW8Cr3LbNQkxYPhzbsHRT0SDs1rUraJMtKb4Ujd8E/fy1ViMwflyQ9AwaoG7aJi1fv8+qgmf3c0R/D6iS70erdcT0rcVhlP+mGG1Zder2xg0In8Px5PXDQR3WNwlh0H0jEp6KMEuh23lO4HdkslCtfszhOhN4TCVpWN3ShoTamJHMdMbyEKfkV42wAoloOjZZwbqJT6BbIvKSeu1+PTUrQ6U9rQhZZh4zSYkxdWtMbe/W0MqKZJU46KJAw4i6NWjSBauklsK3AHy8138Prds3fCArmRr1R+Eml1F86SO+8Jf4RyltS9Wx6+9tJZRDuG1htAyRH2rPb6rfEwX7Wqz7RbTYKPB8s5PiBVh4wZpkv8hovNKPFhTkf0AEexUM2A0aDSYC5sC4wxnWCbqKJbYyL8rs/EZpS8Z927wJm0UR2BLEsJnUs8cYhGly9Gtrq7cfp4SrLQ8MpoPd/R/+cbuawdDNfyxm1lmv3X+SNWnVGPYhb99Iy0Fgzx4G2uLbh5W/fQPAZp1B2TGsHplVDdVr3jh2DXdlaCX0F3kBfkAZdZ3NECHpbD+WWq6S+1VFGb1WVf8mSjVTunGwKV95Arf7AMqOrBArSOhvjpsWw4xtXuGRqqd0MIbIz5JjH6wkdJtxzCny23uxiE+tCA/0au+m9KruMPtKlbcnumgytC35cxQbHi7Rv6+7qjx+PFEAAO7Y56sDJpGIP+4uVRK60ynip5+GRbHOUuj7zAFrU8R3Sl0XovzOhMtqzeZTOZplLm7ruzovuJ+skgcxams0YjGsQV816bay6B2B/n8VwhoVFgDbh4vhp4wWv8SSOUgxEfA1LxdA8jhbLBxCNxVF2yGOXgzjcj/1bAIZtjhdZc1MsuJAVaFJiNH04eo7DSMAhgGEuA3itTFzPkQx2MALY6kS1zvmWG8pAH/7BWyBzHWs6Fe+PoeJ1AtR3K0BBN6bqCqOz1Viib18PBEtRIqEinL2BI2ob/Z6us6bLGlY5z3WKVS81J7ccltziDGFW0aZ2vDYZkHvrknzlV5kFZzGpi5keSzaKxuQwicxZY8dvjCUsgzk7B+I+hy01SY3JQZ4J00RFJ3OVGvYt/U5m25LtLQ5TUK+CQfYt35pYtttQt30yZE5lco7cscbmNcOaZJGrYzFNg2DZ+CP1AvYnjuVUxjI0TtAfP/Qs02fdUm1DY12wYQqqJyfUIQz5Qd6Y5gVUNcSrrKl/f2Jf1m3lCDAO6kcYiJq8axdDDowPVTVRxRiX34OB6iPFUFgH/9cGUtgUDmmPWL8cdfX5Cgm4HN13N0vBahRbU2/yook5qNL5V/V1QA1Z3Qg51QA2hpCP2lR/jndbHOYVKt07Gho9/kmb7TXYr7qhNRgN6ho89J/kRuyktqHqsV0ORz+SHHCBsDdSv01F5ETEwxcRD0RYctKIk0YOXxr5StFUH+IR5sVwCCWSTTOsOBSVkHnIySph3x/sQba25r2jXhVyE63z3nxgzJkCxhkVLkJMyJkSwGHns+Fs8WJYckFDc2mNOgpoqx9HuBTbcc2LxmG3WHBIEetNCxy5xkZmwOWVQjo8jsR/d40LX9s8aS+6LNiTcV1kN8UsdArFFYRWyJJHhlE6uy5HwocKLUm0DoBjOdQYx+fxWgJvLInfHisoFkgdg88Ywz5SJL3Bigh6dnw8IyJbQdUOyX9QBSmc3qus7Af4xuUfdEjaIelvGkm7/IMu/6DLP+jyD7r8gy7/4GFqFzj/IDqprcKpzpHTAc/vC3g6R07nyLkvSc6R0zlyOkdO58jpHDkd3naOnM4O+Ss6cgILTzw/Xil0temV6J8O3A2BE9QOVVA7CIbgbgjcDYG7IXA3BO6GwN0QHKrEwjcEgZquBKvd0564GLx2SNUhVYdUHVJ1SNUhVYdUHVL9TpBqGvrJ6yi+gDaT1QbN0ACrTembFePI31x56uZSks5v9TcOEx8eJub8MJVwXJzMgB47axkHbb9laFvb1VnnDilknUO/5lQN8+g6fdiq2+vi+EsL+HbLWYY5wLDKUhyt9ZnnjftI9UK/mMzZhuJonCDyXdgsJL8tZiEzmdR5MEphpMQkxd6uvECmgtpeYDMDuJ1fLev4hWcZZPCzgl9SPrrVq2ebcF3WBit5ApqXlICGj4t5p2Ras8dN5YdexgVs+n69BmiHY6xggHHwgJfrXHQnzNljnGGFATyocBWgYc0ZqGQTBVhXCNRmcXTHOZ1LueTgH3aVe4rSTSjSMPOLxy8H+L6+Ax4WaRj6zXq2OklOUb6C7SffhWeSDUdqVE+fmprMoqLOEdHrbBVgzCaS+Qkfp9q/8VLOupOHRVgwnpLIBeCrQiKdMtj7k+guZbROohsZnpmzcLsQaraolmQG7YGgKmyfLcM5CqD7uTbx4ZHA2CLvwk5mtVPlDu3CApnYI8/iyZTToHzDdj9oUFC2++GOIAet9H8btlo/ILgEV4zIahddB3oPCfQ6R/T98sN9J/rBHfKghWlAaVUZdq1SpXCSXE98rKRf4yRp+wV/yeWtLPyLqfeJ8JLEG1/n6gkb7SATPMlwUjaeFTPsqFAKwcMgCxi4rxMwdc30Y6UzMHuDd6LvwsGidrxujr2YqRO19MBLOktCLPIgSkp8xFSzsYBNuhAvBWqe91om/FVDP/uJ0UIDw0PZzxvW4bQ9QPQjxLbXOm5MXncp0YAZ+qwP6x20c4i+Y4z85AECo8C9pJ/ToE8fzM//JSYAFHCSeZ9kxt1jILOVqiwE5vb47O4MP6QzfE8mJm9W+4e1KfiWOP9l4LIFOrXZD6M2c05mzslsX5Kck5lzMnNOZs7JzDmZOZTvnMyqzNg5mblsgS5b4A/JtB4xW2CuVqQR2DUrIBa3lRomM+CWrH91UgfumhnQSvwX+FOg1MdsBsrWwug0afhamPffugpl3UTCK8zluMtV9ZdN2QS3cyE5h16NVt75f9knt9+XjSnuvmzOXPdlUyI6UiLvkFjuy8YMcV/qpXv78gjZ2h6H3e+IafbDI/XY0IZ0VF82JZZyh9aBHVpYVTpbfa/3PoStJdDg2aQyck5STiV+oCrxgxC9nJOUc5JyTlLOSco5STl3/sNFrL8RagUhu2SHgUqP0z28lvQt2NVynedCxUsDGV28NgFd5XO+g3uI9fr56UDf5LFRFN34HTO3w0s7POVaeDq/amXmnvRb38F/M+qR9XoujUJyhxTKLgMnhLGWX5eRcLfTy14k3Btm78hxza1dlndogusi3LnmvMazy/ab87d5vleNBbsBTCVMhn5fFwZmVoefVDRN7oBlt5jCFp6it768e2KR3X1gpsZV9GeTMH3WfH4foAqhOAtwpFxGQY328CtKFwRLbBZ7sJynmP5wFnN+xW67V04etI61AIM3aKZe01h3bJrnzJcDkXjqpgSLdgBkq+Z+6zXT1xqoDSw+8OuZFOBXmR0y5mK96PLqCAIWbnzjwqOZzQMNUJ0MfQgy9Ne6tN24pv/aO9uT6qWtg5eHBC+dk9AaJ6FbWDHamWRnAt9+6MkcXWRWZxkJVfpZmfV1MmQeiKqPZ3IQegt1HSV1pP/ScsmKblksrVnqT2RLmc+fbJ+5nd3YteKjKT5a3+ydYZtdrOi/DSJlpdOMcayWKsM5RcnAtm/DUxRtdhjfFYk3rIcWHMh/QbQs4g+t0VLbHeiTNWDdWFAO+u+u4CegdWRkJVxrw/emGMJHQ02OEmlInjdxypfFIgobEznHXhWSu0IxbCIvVyw1WER5XnaQBgK0cyWnHO2D54f7nv49PyS9HJ39WVJR9Lxb6y1udIJ7N6lVgbs2+eBEt4wbRqq9xV+/qElYq8zLSFeorUddAXn1y/sFBkTA1ikj7YZeibdRQi88nmeyr1yzt31LrnyYR/58jk5tZL0Ngx74KiGnSzSTlhNRkUh1fmNEaYMEy8yWm7bK6fng6tPrLm4X8+en/uW7N5fng0H3wzk8xpX+qdPutzvdq/98ete/6va6/3d+Zt70L7ud81XvKzvvTKJTG+5wcQ37nbkIK05UNXnyGEZqKaI0IYZiG8nnJ+8qiofEX/KNm1dKprUbaeayxe3Ls4nGFXUy8WqL4Havi86xlm8Cn1jI8EqcxLpBQt564YfpfeM5StsNZPdz/0/catg+yzlzKXWcDLNEjTLoH4ra1RmIGaMX75awVICsPMGTGPYDVH2LVvB5/AXj61VoHqtlmFBsUZmMzIysF+M6Q/Sh3zGZinVmYPiKza8pO/FDdsuF3h3Yhq6NhF0VYbdp6HPapzHMlPRgEUbQ8/hEaHGGmDkU1Sbhj5Ql2ZCmVmRLjvDWDy9zQKSV9NUUTso7lGHjlOKY2PmUsRdmJvCuDfgbGoyPGVOo+zVWKWWCXg/uaRIuSE2rtaWLyNfsGyqqdyNYqsdihLnQBZXtexu1oXpMHq5zh+8bgCU7HXT4C9a0ZspVDMJSIwDL3pnXi0nXM859d5qObx5nJ+S2W2LwQoy4Xt2er2XGdSc4pnyHY+Rm75zvmT6+PFUMmTfDg83HugYM1dNXHN8+Y5g18id9CfMIos1sL/oN8jFn7SJG3w2KeFA4I07QW8hDBaNuzDDT/BTioqww8ZLiid0sA0bS6YcRHQt8bkDjsDv9gPl+GsfkTIKluGJYjyNJsQ7gfZaCniCnRVbpOva/tFPIVHXo8mCX7WKiZIXyTpy/HlTgD1Ra5yw4v4dlSodisQ5gi6aamtysXIHFznDdWZJ7rvvfXYXw6DcRJkaCRVV77tcZOg0xcEl9BbIqIPw0ipJ9+QCWZXBNbABJzuo/sbiCHKu62oaNnld4U4H9QXe/GI4gOM5VFhYkE2Cbor1YyHCSq06HLZmMW0AF/r/JdQ95VQGRhBQyU3G0cRHtAP5mDzbYgfTh3KOQWbDJsIwHv4Mp7GCkDz8syvYrRAxSjeQdKHSwNMEgwzc9gmvoR9xi5AZFWwzxWhN5CzwBtj9rJqBPDapUK0ma18k80EoSLzaGEvX3xGUarvDWgWl4zbVZSiXt9rZRI8JxWGxGmEtsOHLo+hk0s8phvMMV0hiyAayIUENeuT5a4/nPL3fe9O3L3s8vxfGb2Lv1kyi094bVHybrpKwn5Nh0a2TEfW4gu1tvH4vGJqXobKTnmVwahLOLKn61Fbi+yS4tjQxBWUHc7KV/TEZwURgsV/hC1QxXUTRpIN3mt+4O8UjYbp1OYC3A26Sm2cMGgW+DbXl9ndWB/8DbdVNv8qKJ0XBSjJZQkGg9Yy9ZKmjLpbWFd/IJqim5VwVrQ8hHjvTUmKPXLl8/Q6V7a2npcRYIi/k91I0UyQZ1DR76T7Iei/dAtw42Be2yldxIMhCkgxqpdxfR7iL6QG543M2yu1k+/Jvlr3TL+xBI7MVwCCWSg05Y+LiiykdOVjFHe/D10Nqa99bGFVwmdMQZOqEeURYuYJxRQTA2onAJ4PzzKTwUw9nixdBo0/xcnNWoo4C2AJ/jUmzHNWAdYp5ht1hwSJZ0drzxIjIDLq8U0uGxheDdNS58bRdK5KdhpoQ6MWCEtFqZSEf3HdAKSW0yjNLZddlCDyq0rgXqALgBfWnUIrkcGXhjSfz2WEGxQOq7ARPm65E0/IMVmn1bb69vO2xl798ojrHA9DXEMRfp1EU6ra1IdpFOHVz8yyOdfnZBNVxQjW2UuKAaLqiGY91fNahGhQ8bmzCOkviN8+H1nLPclu4dQ+7MfeKYGfkTElasRDSWMh0v7mMvMOr0TewYrQFqTDlph6sGbrvz6i2XvCTKFozGig2OF2nfjqZSf/x4pDr999nkaAtXUonXu2no8cf5JVqFyGwWwmcNpVNmNV7qedhwSG0kXZcz1g2bTrM1GhDUTEyojDajhjNtltnPrT3+qjdIRhPEloVG6cFVN3c+LqumnlBYBHgBLY6fNl7wGgcpOIVOqGtYKobmDadsHaKxOF4ekOTQrHswr9oUCy5kBbWARYAisTgOIxD70CbQC+C1MjFEHniy173V44Yy3Tr+UcpK58Lv/CA3Ni7e63d8T7UB+FYm6vVAcNBXkbDaCYdLR+9SWa6iTXB5VZXzPAR61STOgetDAtfuGm01bWrHLA8DusZYkmF+McmDnHt+kMe/Qg8CPE348DS6bx0R0JiGJJE5a+xgEbGEZTBnS0Tc57ClJikH67I2ZXZpT5cI2ylHFwhz45DtLb73qFfBIPuWL8bwpkZjA6jbPhkyCzY5R+5YY/OaYU2yKFmxmKZBsGz8kXoBGy/HcipjVMjpHHMfetYVlG4pXx/EjZscQpfMIfXWooXTMgUbpqB6ckIdQv8iMv00L6CqIWbemPr3J7YV0FaOgAlIf4SBqMm7MuHY1sWueFg05HM51R0U/z6guMup7nKqu5zqLqd6Hb2Oy6n+Dae5cjnVnTTupPG/Rxo/EM2ey6n+NXKq52Jh97QnLgavXWIFJ04eqjh5IJzQJVZwiRVcYgWXWMElVsg1xWnoJyDPX0CbyWp9ATTA9+v0zWpDUvjmylM3l5LuhVd/44TGQxIaMYWD7VUTpPHcQWAHgR0EdhDYQWAHgR0EdhD4O4HADpgeMDD9JR1RuFxynPwuXL6d7c6PjTTZtHp7Fwsrm2M4QLtwLr6/vMhseQyByyiNGzf/Ug3EO2h4p817lAo6Mq5jajq4EGPcFdPsSqV4xcKZpAzWosAZ+Mymks9/htN4D77wxjXYnVVDVooOQGOkaqEV69TVaHJo867Bjva1VtNlA9sVNofWEVhANmupQvb6uCTpGcii6mnEhYtX7/PqoJn93NEfw+okJx+/EtKz3m0erLKfdMMNqy693vjarRN4/rwe7O5jBHiFERw+UHgZKsoAkxCsp3A7smemDruwenGcCBOuDxNeNHShoZZkKPihGF7ClPyKEkrPC5dDE2ZnbnC9boG8GuplYevlXg0ajC+yDpmAOWPq0pre2KunlRHNLHGibUOqpi/9CHAYvwS2hZYjmu+hD8s3bfHSz3qVW7ywEeIEzZFrOOJtCr4LY5aliFyTHMx4VsKcD+gAj+IhZ2fAOPahn8C6gMoRyYIUoarmeJpS8Z927wJmMU45BpVKvJiiSRNvHGIIolcFs//H6eEq6zHDKaD3f0f/HMA+JIDtHP2+Yw1gaRlorJnjQNvsZcPLol+ETsryyyADHDtcBDg5zclpTk5zcpqT05yc5uQ0J6c5Oc3JaU5Oc3Kak9MeS077buWk7eKEY1oHx7RqBOncPSkQjQBj3Xpo9konE7eVGtSPrd5ydZza8JJ6jdeRTeXmqMBvfjl3+hanb3H6FqdvcfoWp29x+hanb3H6FqdvcaKL07c4fYvTtzh9i2Naf7G+BZUmtlZCxxVsoMdUQ2D2n730MHaVRgezXcWyVU+zqw7mZCclzfvQv/UEOrqYMLvOOdapZg5UNXMQEMA5xzrnWOcc65xjnXOsc449VLhfco5tw570Y9E/HTh06tCpQ6cOnTp06tCpQ6cOnTp06tDp341Oe5E3crjU4VKHSx0udbjU4VKHSx0udbjU4dK/BZcWPqF29Gqr2OWac1RR8lR/XGEq1urtUMazXjFDz6VUC9gg3PLJ0cunT6t2rKceZl4FNqFw3aCdu15qtJfYiKv1u2KrDTW+lnMP/7IHZA5HDTRrWamuWYfmw6ppiNWT8ziO4grlL6qUv4OaGa2EkTYvBnq+kLnnOIWTfElo/lQCe4jbKdoSf6Thn8vkOprg9oyo0wuyMz5q6UxBSKyxzVJURRoH8N7AHW/hNzn7bIZ5qmclvRFmCkUHvxftfvcICTD0DXA4eWhsKrPRwRaRFPoM1zR9BE/4j9fmwPj9LqF+4zRd8lyeRpPl+b2HqDTnAPmmzVgO8BJS3TcsJjTOYGQm61glC/KE9byItvMXZXCav7HwXv4wh1P5sxwH2e0hinlagB752yIqyJ8XD+Gn1WPP7uiag4o4M4y2H04jmiwTuZ7nHCd523LQ5sJKf0wJxMa064pLzV5glIib0ME0+p/8BbJmtHendp41//ufzadG+Jl7oTX3zCFEOd1WmdbPOQ/QRQD9iFDeVUqiRAh4I4pnXuj/yTuRyt4DROwVP4Y9pRN3ijE8iL0AJsCG4rp2OjcQQCBstbOCW5lRsQEUMnyyzaIB+6z38Mcjaw//xgsHn37+PPKUfB8HX77gY9ghMTMHOM+1WRela9swFu/sbgL+kjEwZG5t6su4KeBgkSFBj/HqkTaZxctjVsqprpkxaQa01LG28zdyidw2nnUn2RH06oh4jDnciOnxOkefJ+gzF+pwzxpXWG9etsL1EQNxiTaIRYtk47c2c+2/G1whqwJGRLyfcvQexd4dwhz4L9B5chTl6I+efQamEM5SOiSOuE7cal6RL5b4oK208cKlRSHMO31xhVlBYe7NiFGWUCAXKv//VsB4Ew== +api: eJztXW1zGzeS/isopq7WquKQjpPb2vKnoyjZy41o80TbqT1XSgRnQBLxzGACYCTRLv/3q24A80ZSHFLyJpLxIRWZM3gdoPF04+nuLx1Nl6rz8mOHRyzVXHOmOr91OxFToeSZ5iLtvOwMJaOaKUJJym5IQlO6ZBGxJdaEp4SmRMglTflnCmVIKFLNbnWPjOsvc6YIS+k8ZiRkqZY05p9ZRELJ8DmNbe0JSzVZCEn+ORkSll5zKVL4TfU63Y7ImMRmRlHROdvOyPap0+1kVNKEaSZheF86KU1Y52VHyOUo6nQ7HMb1R84kvFof7dvqQNI8YZKHtv8LzmSPDLKMpRHRAvpNNduckRuuV1tmRegVk0SvaEr0ihHJ/siZ0kz+TZGILWgeaxieClcsoZ2XXzp6nUGfearZkslOt7MQMqHa/PT3nztfv/7W7dhaTkW0hjL1sYybPbM9toWgOfxUqYayNMtiHmJf+78rqODLZm/E/HcWaphgCR8CV8xLN7/FW0pLni435vZ9yv/IGYGX8fPCNDRnr0fGudKwhBRXmogFoXG2ovZLdElE1apLhCR5GjGpQiEZCVdU0hA+dq/ztdvJYqphrrZ1iKV5AguexppyGRSvdjuxWlT/mQg6r/5bxblMqj/kS1b+c2PTwMp1Twl0wg6Yq80RQ59DkS74cv9E3wj56YzL/XM9FEmWa1bdPgQK83RJIi5ZqIU0TWeSXebpFMvur9e8B8tYE3bLwhxEAzdLOl0EMc3TcEVMCZJJDqMWhKfXApt+w271IhY3JJMiZEox1SNTxsjHiWSEphHJhNKBzFNbhfrt2UrrTL3s9yMRqp5ifzBJe1z03ewGYSzyqG8a7tPomqYhi37IJAtoGgWuvsDWd2LGLJS+76DpQjNJaBxvGRRZ0WtGQpFkMdMs+lPGmNpeDZtLa8cgB1HE4U9aGZBZlrmsyPVUY+2mL62W4oVZE8Wqw61QNGHmk4sUq80Vk2/aCRPFZCFJptN/EprrFewoI8Jg1cGahI0YxjkIWmxgJZRu18A/hdLYgJBkNCE0iiRTCiRSo16yYjQiqYiYXVtS75XfP73YXGTTfxIoiwMKRZqyUMOW2TIQcmYOjJdk9uLFzIyL0eh/c5a3GBi+Vkphlc8Trk1TK1Z+GBzV72Ju5ROKk3u3UFlZRj79LuZGaif0FotN+Wd2zPSN6S1P8gTO7DmT8JmgarNnQ5qSOSN/QP0RoZqIlBHNE1ZM3b/E/C3WpA7aKMKUKU4zN2dmyEq5ZQ1CnC6pZv/c1dZciJjRdKOx0YJombNuWbVrk0pGinoNIKnOaWWNLGisGCyTr92O5jqG9gZzpeHQfC15ZCVEs+mJkz4qYyFf8LAuDnpkqmUe6lwyEjEARYoIcxAoFrMQOuUEWL3traDt0oCSzld4ExAKlyzqvITB4w8qE6kyh+CL5883wc7bXx4OzvCoDQDbXIENuLUFPqJgbiV+3qDoMcLG4LZoO3S4C+7sASXfBnr8KuSnirTPqF4ZMaAFvE9gQmXCIg5YFGpFgbDgMVNHAJJBFBHqAMf3BUvuGPpfHZxUYGllnFRKCioZ1yxR+1dku410XkHA11Ry1D+hKHbkmsZtTrStlWDZ4ghpIcwHWRavjRZQVGKP9zuP3QequnHm1uTsRzObbkJ+q0hrlA/n6fUHWy90bP/sKGheMe12YbipkHwjmKoFAeG/tgu78RYKmmMXtetsYOoKoC6zoCMOnUx4SrVoISMnNd2wVpg8k4xGgUjjdRcncE4Vi+BoLWS3OV+5SE9Ah4fX36bx2h6W2zpj983aIN/Gc8BeWQa9fPmloffCOOwyGAs6r090p7uxP2kcv12gxcWrsX+988KrsV6N9WqsV2Ofthr7tfulcdoceDa7w9IAGDhpawDGwoiKKbhxAHt0+7jR7devX3/72u3QGxXMqQ5XVRQ0+HVKTuHHvVCo/jFB96VL9g5f2vY5MslC2ADFGgIZKdkoavn6tYjzhKkWy83WsgniT6fE1gJzm4g81eSZEVcvyawPR04flPmXfThBKU+ZxH/PjkLA999lki25sevsEXS/Tol5l9ysmIT7LyVyGTJFbngcg0h1BpZnrLfsdcksVwGjSgc/2rEddm5UF4kZDYpsFK8yT1M4QYoDI4J1kR5cc1nj2eXg9fmbwpDikOgojnP4GPZ5W3Cm8gxObxZdKbHQN1SyvulhX1wzec3ZzUml26NUaQBxu9d1bYUNXxBuS5SXYs3+Fx9h8WPvxW1M5ZLVv8K/xPxSxC3ag7fI4PINLLGlpHCpzFMWLCWs3YiMBmOSMWkPOFz0u8/1At+1axrqlq55GOX5cEo0VZ8aQPEAvLPt2++WrRYNfKuJukOox3xC9aqFCgx2QVsVjG14MTKrI44N9C0MB1bYYPU7NUdvOPwuDId2XQ+zXB0Dr98UsHo4ea9gnCJ0uHPvZhqzRMj1eH4UrseyrkFY3jv3bxfWX8KWdL7W1iTuAeWjBpTdzg29ZudIfWozcPMm+fir2W9W/u3eUVD7yVZVqdtZ5CC0Xxze+CssiOZSotZKs2Rn+6aNkx65NBOkSKPnO/qWXqcJmxpofHAH33wYsxJOWIBd6cJm/43FRyxfS5FnLWyPIJ5+xRP3QiwVWUIxZ9YwAyOxWKqnZMY2X3Ka0kythG6j2TeWS1F0z2LpL3Mesb5yr5/s/3ILIZds8+LXYKJX8LAxg9bE0CMfK++0nTO7+wOWXqt+oQv+QHMtEqp5GNTaCsTCvBAUysUJse+CPmUxTl0rqBq14QQFs4jBdvVxOLGDay9iWSzWdezBMxbzlCE/8u4zQO8A6o4XN528fdfpAlLf5LSNqtC9R2bnwxcz2x1F8hSvdWWeaQ7rQaRBxBIYVRX1qx6ZQRNluXqpaSZ0+TJ5FosbBttNabM8E54ee/KPeYqGNTz3MymuOSwyuEy/+34qobdHN2lteYc2uczyg6Xh68n7yiwjZpirQa7FNKTxrhOxbkXYabMruq6A1Ap2AljZAbvNaBph6xFXn+4aFXkjND6g5jsDRXbXNucVnfI+9oyhSBIaKAZUYEB4ccEnhVVVX5e4pM20IUKbaiizXN+1VU7Pp++uXo1gu7g/ryaXb19fnk+now/nnS5upqvhYDIYjt79++rt5N1oPPq/8zP3ZHI5Gp5ve76x886AyZzADicrcWOliDGaqPr+QvsplXJNRK5RoBT6Zu0Q3tbjGcqXcuOWlcK/Znf22ZStb1/zNRO63GnFqn2uXGmRkMF4REZnMIxcGR3XHF4g8BqSBInCc1A+ULZe8DS/DV6Aph2A5E+QXI7tGx0nYUyr2hJ1svpvCtt1PCdLbxotiACDP4u6WCoGUa7hUJbimkXkmklcwPYqZZDQzyJtNA/VGsRQb1ERrmCEkUHVWdhmij5MhjA3UF/KtL0GxQpUPk+Zvs9uubC7A9qwtaGiqwQMG6e+7PtCioQwGq4MqR352DAFKMxTZqSYYmEuuV4j2nqIrrkKLRAbnWEPIwa2ClBnGb614JLdgP4qcyQh4MWJSLUUMY7CfQm46CJa0sWChwZeqNsx2Dz3f4dX01v8CBdoorWW0kxwK74X6rbd1VyjnoogLBWuhbo99irpjuoV/wxfi7w+dabbTCj2Nj1jMdN1o+reG50Iyhh4UzGsrli6FedwZQuYlc/CF7+w9YS2uYCFr/eJAaGMy/K6NATbRCG5b07z8NPD7ARaIvTpT2Ru6rXtcasv7jrB2VydxiL8dOynK23xzU9l0PPd8ODuY90Chs3Tlzy7/tHArDmPJkyCjw5d3usW0521meQhshlp/YzoEgqORVnRmBOm5SlkihpjCdX1E7vXBIxoz08FHgvm3GARyVPNYyP3cylhESooZSrmiswZgGjkrZoDAHyShNKVblWPzh+fP/8vo76yhTJU1kO2S2jdqcCZ6vzVdAP+sIVqcxac33KFV9GNOsjozFXTUpo1K6iIM1h3FSW+tPsfbk148FsIYt+p9GqQ8DZTZyEGLKlv0K0NEH4qhD5WDkBZA65RDECXi/q7FanAQtXW8GBxVl3DdLZIuKWA8WhSOtAhTCHzdanAOie40mw66zMd9lmo4L+eqXtmVhVPDVJwLBMkmJBBrJk0XA2uzIsJXcMBkse47ChJaLzIU6S5wYt1NX+LioFWknIAtQE2PjC9UT2KcK0XiqRvkNv5cNo3EK8fsWsWg9psjBQsVAFWanX+3konsbWXUOn4EO33xGWebhowgeD3ytRWsS8pWFbh3WYthOc1QVhqbDBziYhY3Csq5wolZFMbAzEAFSFqKCu3R6tM/v7zwZt+cDn++8/k2WtJr7kWaXVvVMZjutVtmgy7pjfbdcRjbh9He28e69QSXGoFp8RYn6JLh3AOMcOXSGJSMcbYW+zG0igQlLuSnq9rS78kh55s2qTtjXh5SwY8hqUQy5gZCValMrzG3wlaOQ9kM/zHr/r9zd7Tv9m762b3iVjX/TWev8Z7gtd4mRSwUttg79qhY8s5laUtn6tWhyV2VYhbNrSEo259FmmLlV6rE4q4KA4mVMOuNgI6O6kbCm0oh4Iks+BSaVOjrQ3jGcwZMLxjNEpbaxkCvUEYgvp1nlAetyD0m0JglECljUExhDZA2TGmCnOo1UyyB8GmMQXjq0VNbgrSHwOoI6IyQo5cbQqom4QG2atq8WxtFh6dOZOAseSiuc+RvG0skHRZRcJwylgeEYuIU9QKFefDuEc+vp/nqc7JxbtpuRlQmPcMWkK1wAoO3CV9bF31hQoipimP1Q851nEVa3VC7PLJ8nkM/p74LjKbC42xB/gNbmkCEwElqipylHw8YywjF4xKHNyH8R39ihjLgti+Glwn1Q7+AM5CV9YyrU7Qd8jOHKL84fuzQWOGuCLFpSaN43Xhvdsjb50du0umKCUCcQP3V6HRIe04HYmSXlMeo9BB/W2Ro2uwZDGjit1bjaiv4Ye5IpsLoc+4QjPd66NoPVDSLdB5oay7tea8l87TJU9LskKPzLKo2ECzYmPALoKwJmDQru2j/35OXp86g2B1G/2JSokRlccqJfRzLrfoJAP4+XGoJMcTEfejeg8VPVR8mlBxnyJ3MDwxEuPD2BhIHT6ZWtl6dfZCXV3/ZKHgLoBp4kugiGtJDTOtukIVZtiHsaOD4f1sq1tdLnVOY3elW9ZqYbHK58Xrrczb2LdqKVdTUo+40aYycE8MqFJ8mW6JP7HR10YLw5iztJVesBmqDIs6O33dKdLx+CDQhMpo2ApIXoglGaQ0XmseKrT5YVHXQiJSbuJTuNrfwaZod5Frbeq6kJyAgGoNGqsl1XQoYuu7fZ5GeMmyv/ozqikJi4KE2ZKGHuEYiPXaL/O41bQ064ZbczcnsVgSKXLtJuUeaKN+Ln1iW5g1u8+aqlV2TLPeearl+mqKD3vmf1eb97j3Qy2Opt00pn5iW73jrQLw+pfz4qLjAF95W8kv+RzpE9DlGhB5giDI22yfgs0WrBasxUqrrWzDxclimjLy/vKiOLRdB9cil8Gnf6gAPA5B47XHt1LxkMk2cQ6mFySEXYFcLoR5lQOEOa+i1Io8VIzht2ovK772INDxrDhonEUpFKVFmKPS/asCkKyeN6tC2mnNIHRQ06phFqqQ6dwyCqwzO3AzLHt4w9+61itA3Q/bJfsFHAh3YhMWr93nm5Pm9vPQvpxJQ+/cvOJtx+v+9A/1g204qNRl15txKRjGlCftcMAE7C4Kgkt8QF0dixpAgJfoVMF2NOxNU/mOxdEldk9oIEAHttDMch6RVUNml4xGv0qOkdTWM2fuS1wAB9sCskDaeeSNDfMD/PKsSSMrBuSsDyEOacdoqqunX3TaiMRoCLqHAdeNWRMRCc1DkomYh2sr9+BW3Mo3RH0l91akVyrH8eJBekPX8EfKQBj91t0Y5m0ABYNriqE2VJsa7JE8Kfo9wZ65rTAR0TRj4T3pFpmICofgHa5gzuAqIjbFI1rImeHjAnMx5Xo9w2C5Gnw1dZUVC9o3j4jtKfn3YHxBVBGxT2kq0XKK0m8GzKeXs6ol+mFGuI0C6GRBJqI/Y3zesvLILSvfygW0lUP1f8gHdNMF9ElcgTe+u4WPJbSrKVt/ehgXb+L1guguQdTCmNn2Tvvdqm48sFfOAXhWBHh9bGIr4NN2YLRZJY6tjXl4r/H6a5F6YOOOp9rDrTS0jYg61nLifJoMNPiLmz0K49BhvIJC7D8z83WC8t+MHKN87WYx3CWKgM3eYne8V03/yge6A22QlJGVXHN6qjcYZvmkdcji2vyZmRpO3lfjSoPRGRkKR9AZtnZyK8nhZ/sdHojqotTqjLKklaONvZ0BZ5cIy1g34Hm+XBb+X2o1Suq+GjsDajpqsWEFOD8aU7UxJEPVYxEdxVg/g8IkBgI1efY8+MmscS1FDjFhV0IU1uRQZOt7dBqKA74v40bnik0kv6aaDUyQw5abIjOFKtERGUQyj9fkWSoIuwWfNhqT0cQavWI6Z/EBd+p7PY52eaqahgqcBn+YLVD4WfW8ofX7MLR6nefR6jzdTrpQ7yCMWYsl+ubVlBitiGgsYiKPriiEf3BWNltnS/8uqDIpLXubLl1eD3nkeoinmmzrmzrwtmKKzp9r9CTfRqstIifX87g1OH6OsqeFO1yqkQ0lC0WSGNc52NiZFFHuLvXLPHcu8jUSQlowSCbDgj1SbCbjxN+ugmnxrrmsqHCfP0yG1aOgcLliCYjDFrvVTSsiCxuHepHH8Tr4I6ex8baVbMEkS52L8McP4wp12LbUmqhrCwauoDrp4oAgIAb6KroHL/v9GdwgLfhtt3pHtlcE/EvM1fcwES2F1Q6qBMRM2iR4QqDHx0DvfKBgArug/c6IAnfFBToi4K0JPfpii3bbDHF7GO1uM5Srq1f/1IPcPnnyTd0CwLjVNlTMZiQX15GPltWewN2SiXU6GI+OjhCGP/9gOXCBcTAOrHUiwKEFNOEnJd8bTTJYPbRr4q/PmYk8gLgaer/P/OPVv6ev/j0RRchrGl7TeIKaxjcKKXofbykqwxXXzHAhKhEYNoLFgejaCHZ+b++qnTUfHe+pniNnh2fjPaOt1EDNvHar4YKtNBCNccyaLbOfZg33LCAbF2m9K/BqIgUsxYFseSk4G9ULzjBOu2vBxGypQjFBqFLQD2riz9+sYOFbkpH1MCvCHDm3PuPCVwQNwYh6l28MdYalIl+umvHfZZ5WtMw2iM3omI5aXkYqiWloEr4/UzyFCxNTpeOXPlAMuemW2HHVyHBO/a2EE3u0vnWNVOUV7WsKT3wSt0eNYn0SN+2TuPkkbj6JW3Oj+CRuD2sB9Mrqo1ZWTRI3cCPahoS8q503AT4uCOVd7byrnXe186523tXOu9p5VzsPob2rnaedPpirXYfGmnK5VVUa4CMyOZ16y/GjVn685dhbjr3l2FuOveXYW4497N1nOY7VYiscGp2OycX0lcdCHgt5LOSxkMdCHgt5LLQbC+Up16+EvOAJ19uJehmTxtiD72yZQPPOO6o+XTI0Y2x/x6OuJ4C6TF6AjSAxJqY1/uzv6b8DePaI7+lbO+nZEPLLamoh8MjL1ayM+TARokUeIBMVJBMi3mNZh0QvUGUjusvu5MGOB715lVjPx1kFlXAtSspd2KvlL6ynmnHJcM1kNIKbkCiH0W692MKC9qbybgFwnRyYSACdEqsE+3J2N6/Eqh23ZavndJmH4GfMQ2DOh2TYuNQ/4kLlw7iQAtX+/Qp5t2GOVUhjmDyuiE041DWiXMIXVuBljoWTDZAFNWsBjgPhyl6dihgB11KKG5OWs5EwKKSx8fl4bhJ/52nh0QlvTuF5e08SKBK4/rv1XBlk58iM5WcmUfmpPUXMosLBYad33aE2MpYXjjqXbDmK7ucb7Fx+QAooLWv5FBrZSAefsd+NpKRafGLpmTsL965x96ZTeaaDKcEqqs4HTnLUcl6/sOQCMxPgAP82HRZ8gU3pMKgtkKg68wjijRT/kxkHcLPZZByYroKM3BjhPri0e8iwyLaMebs3mcexjxrHeifJ4zL/PIpL9YMy3KR5jOnwDJLa5txnkhtS8nEjsY5Jf3NcJIJShSpiEbh6TwjVmoarMnN7FcCA1OsW0KeYzw1Op6iVwuzjRWSqVg5qOA7X6a2OasYtcfg4qNmtg7yaiF6FfdSif7N+i0yRpAzfochHyAcoidIsIz+TFZOtl3RtTZi3AvvbD+a0DyAwSfX3oHL07A87+gARkC3tFXIQXTIwRHOR2qP4ADsaoGcJMUcoWKIhHCRa0ixos8fui3+QiK4RpJpNUdBCQ6F0P1dFYLX9QX39Cf2oT+g2Iop92u43MsCgLuT8l6nP8+SNWt+NUcs7n3jnE+984p1PvPOJdz7xzicepXvnE+984vM8+TxP34cgesA8T6Vtr3NMPicoXrU9uJxOe/I1tUn6dExOp3y53Xz7PuXXlAARzYVF92zpx2y58Gxpz5b2bGnPlvZs6W+MRD1UfNRQETjMUF6krHHlA8Dt9Aj6sjW47aYwbtA1QUTKnTkUNl435r770NjOT6fWaGhuV9G4+MxIK7APwonTB2Pjy35BEsF/W3P/X/a6vpJG4wZu3ivMVIyXPGcFbW5XUo3Djo3qIjGjQYmN0tWZD4vzIoJ1kR5cc1nj2eXg9fmbMjuRBWmjOM7hY9jnbbFZQV+4UmKhb6hkfdPDvrgGOyC7Oal0e3TPZCPb+l98hMWPvRe3MXAt6l/hX2J+KeIW7cFbGABbC7KUNNVkARk8ltKkCBkNxs1w2LuP9QLetWsa6paueZO8ZUo0VZ8aOPEAuLPt2+81f32ribpDpse83e0FvFWwlyCd0MXIrI44NsiXOy6vFTb3ZLL4G+yncIP9rYzJd67p/6wtubtpTPZ48lHjSc8l3sElvk4TZjmnB3fwzYdxme27vNEuurDZf2Pw+TZJXp7EdY9bLdOUZmoldBvFvrFciqJ7Fkt/mfOI9ZV7/WT/lzvYgc1aGHrkY+Wdo7PCGSZ24TEV1NoKxMK8EBTKxYnzrmKqwDh1raBq04YTFKwiBtvVx+HEjk0Yn8ViXccelhGk9nvR6R1A3RE1ppO37zpdQOog0xqYtgrde2R2Pnwxs91RJE+RvivzTGMKRJEGEUtgVLVURT0ygybKcvVS00zoao7DGOg0yOy1rH2eHnvyj3mKdjU894sUOcDV3+ky5ux5RzdpTXmHNnnvtE0GM8zVYI/TXt2KsNNkV3RdQUYhsBOgax+7zcArElrH/Ep3jIq8ERofUPOdkeSxY5tXE1h+i5SdyMZiEdnQRm22LkBoUw1lluu7tsrp+fTd1asRbBf359Xk8u3ry/PpdPThvNPFzXQ1HEwGw9G7f1+9nbwbjUf/d37mnkwuR8Pzbc83dt4ZA2Y87HCyEjdWihijidpMBRZSKdcEssOCQKly8cpDeFuPZyhfyo1bVor8njv7bMrWt6/5mm0zgVpaUttkoFVmUYqy9YKn+W3wAjTtACR/wj/DVoP2jY6TMGadZd0SdbL6bwrbtfm0DD7fzDaKuXc1HMpSXLOIXAPZrnTCdJTyWvNQrUEM9RZVLV3qdRa2mSLID23zbtk8V5ALrFOk77rPbrmwuwPasLWhoqsEDBunvuz7QoqEMBquTBLtLrGqDArzlGnLS3ugnF+ua2pL7i8BydngYhqyfeNbCy7ZDeivMkdn5mp2MBiF+xJwz0W0BNZaaOCFuh2348m+mt7iR7hAE621lGaCW/G9ULftbuYa9VQEYalwLdTtsTdJd1QPqfBsJrxjvbCL08F6yBora2FYBU/sFl7YR+cRrKcQLCT3A6R6dsutTP62O8vzrhMcEhjGIvx0dAbDwhbf/FQGPd8ND+4+1i1g2Dx9ybPrHw3MmvNowmTIUk2X97rEdGdtJrnLhV47I7pASqZgXLSNOWFankKmqDGW0EbO6V4TMKI9PxV4LJhzg0UkTzWPjdzPpURGK5QyFXNF5gy9I1eMFAkVEXJWulXzoX/+/L8sM3WhhnhxcMh2caEyUnZDzl9NN+APW6g2Z8H5LVd4E92og4zOXDUtpVmzgoo4g3VXUeJLu//h1oQHv4VwjpaVXg0S3mbqLMSAJfUNuvWgmUxPa8lLaxk3VbciFVio2hoe7qR/wy0FjAe8CiRNAHaWaVALBbZHBlnG0qg0m876TId9Fir4r2fqnplVxVODFAqqG/BLyCDWTBqqBlfmxYRi3AyTWJ5QktB4kafo8gMv1tX8LSoGWknKAdQG2PjA9Eb1TFp3cFfqG+R2Ppz2DcTrR+yaxaA2GyMFC1WAlVqdv7fSSWztJVQ6OkT7PXGZp1sYxCIlr0xtFfuS5d7faRwxnttVQVhqbDBz4GES94rKuUIJ2dTGQAxARYgaysrvn8K4krW4At7L8ZhudZsmQxOgZoeOeMzt42jvzWOdWdII0fInppGtLv2D08jWuQsmI+1f3Ev1gYDcLgPATjR3l03mCLKBufatKue76AX8ntforl79Uw/853PwwGxkuLbOgY2CVSW0taaOBOaWavqmFu068tHEhggS8BMy98yD8eho6yz+XMTJMMI9SCj0iAU4tIAm/KQYMXmvmMuaPRiPDPVtzgzqw1MZeu9vnP2N8xO52fFXyP4K+QleIX+j69z7AF4qwxXXzPi1VtDvhqEeRNcG0ezelz87az7a1lZ3TzBu63gkPaCmWwM185ra6xTdBqL57+fk9SmZLbOfZs5Wxktl1cKMGryaSAFLcSDbxHgCrXZULzhDjlw1pGgdiglClYJ+UMP9u1nBwreMT+x+nhYmpq5DH2izKhQ2vM24fGN0MpaKfLlqcu9knlaM/m0Q2xTfdEaPUkuMachQwD5TPF3CJsUXXayQB7LfT7fY7atWeXuXUTXl/onKltGQ7q1s+chnPvJZa5uwj3zmweADRz4rJdFrIUC0O9KAieXxF5dHjiS7vy07OiO1C27tMzMlJ3jeVcIVVwwwcLMjaexMMHfJCbguarEG0KKwyYAAMHPGFd4Fvj6KO9y4BUA0VGMV1BsMs3xSdeZuP39mpoaT98XHsRQoNKO0s06NzcullXWjk8VXSH8MlA2sHvxsv0MmBSzBNqim1nVbzl1/KbU6oyxpdZNtQTSA2wjLWJ7dPF8uC4KFWo2S+mXoTod1p0wY6onDzaZqY72Gqhuh+1svhjMoTGK4oSDPngc/mTWupcjnMVMrIbTrcyiy9T06DcUxcjucR86peSL5NdVsYJyIW26KzBSqeB8zRQBVkWepIOwWSCM0JqOJtbjEdM7iA8Dd0ZZg01Bhj4E/GrkLjogs4K18j9HK54MUPWLbZrpQRjPZP4I3r6bEhDEi2igz6Nm/osCvVkX4a6yzJYECqkzKUHybnAmPth812vam1+19UweGF52i6WuNVM16dFGWUB6XkUmAUwrHhzktnQnFRiBy94dauMOl6josWSiSxHBTYGNnUkS5CRtb2YXFzQ4antoRb52VqthMxlbWroJp8a4xpoJ1z4KBD5Nh9SgoOA0sAXHYYre6aUVkYeO8LPI4Xgd/5DQ2dDbJFkyy1HHwPn4YV8yWtqVyfaD47S0RXiNBxu4lXDh9VzBwBdVJFwcEjHMkA7kHL/v9GYR8XfDbbvWqeK8IgLw038NEtBRWhTZ8t4b/KLgdHks/fSx9ly3liSBOD+k8pHuCkO6BrG9tr5NqdTRSaG6aaD+LtMVKr9UJRapga3cbAW1y5izQLMKdLLhU2tRoa6NxtqJzhqni0Ka0BRafA7RtgV22ImLACBB8Zded+2G8wZpldpsN9sdvShs0SbLQTQxtjOi45aL1gVik6M9Q4TTDKWMjwoBybin3BYT8MO6Rj+/neapzcvFu2hq2QeuqL1QQMU15rH7IsY6rWKsTYpdPls9jHpqemsu44nazB5fDQLkIbELOKiWfko9njGXkglGJg/swvqNfEWNZENtXg+uk2sEf5lSxK+tjqE4I/NPOHHIDhu/PBo0Z4qqZ0BMhGnT5rfNIdLSDQNwA5TI03gB2nC4cFr2mHFOeGSb+Itcmx23MqGL35sfU1/DDODvf/5IFSroFWvJP3FprKKElvXWWRcUGmpXsUuR6GNfE2j4ypJU6XeWJMB58bm+voDwSBcXn9va5vX1ub5/bu83Nsc/t7XN7+9ze3vzzPZh/nohx1uf2vndu76Za9yjulnz+Jy/0vdB/aKF/sJ250NKQrezU5lLNeoFq1t2aOD4yOLule5/T1S04L737Powd1w0JGK0CrXGpc1p6JlUgv6N+FK+3ijiDfauWcjU1jqo2lUHCoIAqxZdgwN04lZp9PeAwbF4XbD3vnBdZPU2R88X8VchPmEW5TQsXYkkGKY3XmocKWTwmAbNtIREp10I6OnMslu9gU7SLrWbD3OhCcoImXmvQ6EpU06GIY5Na+jyNMO5RCy2NakrCoiBhtqQJheC8SOu1X+Zxq2lp1g2B7NycxGJJpMgLjvc9zMb1c+kT2xLscvdZU1V7xzTrnadarq+m+LBn/ne1qU3fz/y8jwYzOh2Ti+krn6PuUZuVfY467XPU+Rx1Pkddc6P4HHUPqy3nKdevhLzgCdfbTeEZk8Y5Bd/ZMoHmnXdUfbpk6FSx/R2vOD9qxRmy4VUjG8S5TDzI8iDLgywPsjzI8iDLgyyfCPj7gD6/5HPMbwEGrMcR2MkzHb9vpqNxdd8/xNrKNmHZspimjLy/vCiucFwH1yKXwad/qACwBxDZ7WWOUvGQyTbwc3pBQtgVi+K2un57bdK+ptYAjnx3+K3aywoEQk4R3BwcNM6iFB52zoe4At8qB46lb8+qwmp6oPtzpemm//MWl9DAYgxInmHTu20cg7VegTx92C7ZL1BExrbgEBav3eebk+b289C+nEkTdGUzBn87osSnf6gfbMNBpS673gyjYRhTnrSDwBNwp1CA+T8gBR+LGlyHlAqqYDuaSFk2uNr2xdElLuQ2ZKgLbKGZJZ9iAHMyu2Q0+lVyzcY0Xc+cF0/icLVtAaNMtEuZPC6jTFjUnhUDck4FIQ5px2iqq6dfdNqIxMjy7DaJghMRkdA8JBmy8KzcA/T2J/MDJ0W/S36gIWVH4A/e+qJwez6MTERFxvYduXqdH5WI2BSPaCFnJmEapJZKuV7PoHIApzzVapOebHtK/j0YXxClZW4CxypNJWoYKP1mEDf0ZS3uwsOMcBub1smCTER/xvg8Zn7UmNnHUnrE5MnGd7fwsYR2u0iCNvfhL9MCJhxgIPbaldeuvHbltSuvXXntymtXXrvy2pXXrrx25bWr7127erTajXen+h4EUQvHocOzZuKQDSRtBzoxG+Wv05rtAcex1+GrjV8W3ADv8Jas9vLuwJyvfzn3ZhFvFvFmEW8W8WYRbxbxZhFvFvFmEW8W8dqIN4t4s4g3i3izyJMSRA9oFgHbRtV4YCORBuDBE2Ao8qPMJdUqnalkvyVkrznlXqaS9ym/pgScN1yMZe9h+JjNF97DUHsPQ+9h6D0MvYeh9zD0eLGth+Eg1pRLMjmdevzj8Y/HPx7/ePzj8Y/HPx7/fB/4Zyzo3CMfj3w88vHIxyMfj3w88vHI54kjn8bncUUuBGQVLgT+BijyUMdDnaPGeLfYaOwI+BWOB7Zl76q7+Fw9L4L++iLoW+PeA4/EyUFHYm8rOeeYFD+NPDku1bfdnW3z/zQ2ZZEv/MolLrcZglqxLXb01KYDun5Brm2KmgiSUvJ5jlS1MkuQ7fsB6YP2d98lGLJMj3Jh4eexK2jjm7pqgWsJ1Pv6cqnjrCFmBRnXM9ZcMpWJVJkjs9v5+fnzTbLwKY0IbAKmQLzYJQivAZXNKjn935Xh3KhwxRIKf1X3TcKUoktWIQrvEFfuxU1iT2Uk51IKudHznzZ7/tYkvhcpSYXlcLMIq1IszCXXazR0nDIqmRzkQNj++BtMf8L0SkQAJAUOOkMyd6dv0/VAZ50nhsIqchl3Xnbc16cZ75l89MUS2Dze8Alxn9BmahlMRh3ogOvfFKbTTE21l8XsQIvQFXwNlji+1OnaP145TeX3G43jhs90ab7lqYjW57cUTsvyoCilRwGOX3Yo3psFFbgcFhKtwEaVkjVsU/m9fv6XD5pysnxS0e3LH0vNvPytVKar7YH6+7ymkZZP63pk+Xtd+3u+qZRVB7pDl0J5iam9FgI/lovubr45fOR9y8EytpV9GUVkiLuuvtSqC4wllMeoli7E/5QP4AQHpwJs58fej89f9J47PJbQtPLxjYjYSHvV7OyXUgjYIopQkrKbzYRZPCU0JUIuaco/V86wW90jjRxYnLlMzSRkqZY05p9ZBMmM8DmNbe2ILwAcgR2iAopUJRU2NABClyO1Dmfsi93EHzuVTfybWTnw65cvc6rYexl//Qo//5EzaaRDxJU9SFB7vWMu3laHmeYJkzy0o1twMJYMsoylRkHePtNInd8yZ0KvGKBBajC/lcZM/g1SM6NyvXPwmHuqI+RyFBXI5WUHhYwDQSj1zEIHz7KPNmEV5mdmqQ4wM11ZdkPsg6ZlSgzCkGX6zner0nXydvoOZJWIMD9WgknZO5LeAPqgN9DPbkeUFgr87Usnpukyx1OiY+r8avJsVwVjQxBWDdo0XVd6+OWLeeMdpIH++rXjZgzTQne+/vb169f/B5hv1Ck= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new managed identity in an organization context. Managed identities en id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-organization-member.ParamsDetails.json b/platform-api-docs/docs/create-organization-member.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/create-organization-member.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-organization-member.RequestSchema.json b/platform-api-docs/docs/create-organization-member.RequestSchema.json new file mode 100644 index 000000000..f16cdd46f --- /dev/null +++ b/platform-api-docs/docs/create-organization-member.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Member details, including user identifier and organization role.","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","description":"Username or email address of the user to add as an organization member."}},"title":"AddMemberRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-organization-member.StatusCodes.json b/platform-api-docs/docs/create-organization-member.StatusCodes.json new file mode 100644 index 000000000..f16ab091d --- /dev/null +++ b/platform-api-docs/docs/create-organization-member.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier."},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string","description":"Username of the organization member."},"email":{"type":"string","description":"Email address of the organization member."},"firstName":{"type":"string","description":"First name of the organization member."},"lastName":{"type":"string","description":"Last name of the organization member."},"avatar":{"type":"string","description":"Avatar image URL for the organization member."},"role":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"}},"title":"MemberDbDto","description":"Details of the newly added organization member."}},"title":"AddMemberResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-organization-member.api.mdx b/platform-api-docs/docs/create-organization-member.api.mdx index 8d866904d..1ed837992 100644 --- a/platform-api-docs/docs/create-organization-member.api.mdx +++ b/platform-api-docs/docs/create-organization-member.api.mdx @@ -5,9 +5,9 @@ description: "Adds a new member to the organization identified by the given `org sidebar_label: "Create organization member" hide_title: true hide_table_of_contents: true -api: eJzNVk1vGzcQ/SsETw0gS26bFohOlT8CGE0bQ7FPhoGMliOJDne5IbmWFWH/e2fIXetjFXsD5NCLvSKHwzdv3sxwIwMsvBzfSevo//1AKvSZ02XQtpBjOVHKCxAFrkSO+QydCFaEJQoyh0J/A7YTWmER9FyjErN13F7oRyzEZ7K6Up+HciBtiS4aXylye+4QAn7c8fFP9E6GJTjIMaBjVBtZ0A86EB3RrmZQJYSlPES660wUVY5OZ1tgjjE4/FpphwQguAoH0mdLzEGONzKsS75FFwEXEcXcuhxCWvrzrazr+3QcfTizas1n9q9P+IXCANr4gdBFZiqli4WoPK1vgQgo1D57zhpkeJml64vAvqEsjc7i9ujB8wWbLlo7e8AsMGWO2Q0aPe/yfTtWPjhC0aHrlqyYW4IiyK02ApRy6L2w85jBCJuSTcsCSAPFPuikhiExM5BBB4NJLImGaWKKNutD1uOCL23hE9rfTk+7ZH78++fRkYD2tWN1vi6HQzKb5B9THcXLTPbz2xj/GzXfP4PzbkU+p2cgY3Zfd3d5TATf8znXzod+MN+zqegD1EBfnx+gp0t4hAA9qmES7YTOYYHidvpBUGJedMw1e8wtkgZiN10VMcF529YyawzMLPVA67jNPp2w6ckjxBz6XmfaOqNWN+X7d2svSfBidhFsJ7qL1JRasqiZmzVnGtUP1XSqWi5q2n97rG7PQImmS/5IAW87xB0F7z0lIYb7Sr0mw04SdtFfOme7yH8/0nHa8SQKGwQYY1eEJ1q/61pfVCkcFGgw5xj/p9HSpsescjqs4zQ9Q3DoJhXNz/HdPQ81GrVLyyO5rOKtPFrHcsSvgdEmTt16lHThRyQZyQ7dYzudK0edRS5DKP14NIJSDzNjKzX0+JX4HOquFj/FHXFtIHDzE+dsLybXV5LRtGA/MVsp8l3Iz8HzjbIZ4Px7Fo1oJX28b9vqwypEhjgL0+34vnyCvEwFnKblM5v8wpjbeFNDagOYEb4WCzOjM/SNMSsCsqiIfZ522Wm6c7z2r+0GAWGS0z2/Dt/9MTzltdL6kEMUVPMwSi+pY3V8CHezlejPe9Y1+Qj4FEalAXqe8Qxzcd4kLTUvy4Ect2+4Rk70xYKirC8pKjbcbGbg8daZuuZlSpdj2dIntUkNM84HiU5pz98k2jkYjy+E+cu0qbU3osfz8GgszSIUa8kwTMW/6PMLrp+fpfU9GS4RFEuJAKa98wTj5IY9bM92mkM9aE9MsgzL8KLtbsVe396w4pvnaG4VH3Gw4pcu/Y0wbWQlFlJc29CULRZVbCUyueT6gP3yOiinGNRRIihj0eLGfsGCstbyEvg381LX/wF9a0x/ +api: eJzNVktv2zgQ/ivEnLaAYqfdYoHVafMqEGx3E7jJyTDQsTiWmVKkQlJ2vIL+ezGkHNuxN3GBHnqTyOHMN988WwhYesjHYF3pYZKBJF84VQdlDeRwJqUXKAwtRUXVlJwIVoQ5CetKNOo/ZDmhJJmgZoqkmK7idakWZMRX68pr+XUAGdiaXBS+lpDDhSMMdLOl45+oHTKo0WFFgRyjasFgRZBDVAQZKAZVY5jDS6TbyoRpKnKq2ABzjMHRY6McSciDaygDX8ypQshbCKuarSgTqIwoZtZVGNLRHx+h6ybpOflwbuWK3+yaT/iFpIBK+0woU+hGKlOKxpPbAiLQyF32nNXE8AprApnAurGutSri9fDBs4F2H62dPlARmDLH7AZFnm/Z3paUD06Zco+ue0+OuRXWCapQaYFSOvJe2FmMYIQdLB8L9ALNLuiUDQPougyCCppSsiQaRokp6Ph2l/V44GtrfEL74fR0n8ybv38eHQnosXKcnW+nw0sy++AfyrouiwE5Tm8v/G/M+eMjONuvyOfwZBCj+7a6q0NJ8H86Z8r5cBzMTywqjgGq8Vidn/FIlbjAgEdUw1mUE6rCksT96LOYWfeqYq7ZQ2rJNFXspksTA1yt21phtcapdRis4zb7dMKiJwuMMfRHvVnX2Y0rR2x/u/ZSCl5OL4Pd8+4yNaU1WYaWesWRJvlDNZ2qlou6y+Djobo9Ryn6LvkjBbzpEGOoyHssKbr7Rr0mwb0gbKO/cs7uI//9QMdZjydhbBCotV2ShCj95770ZZPcIUGaKvbxF/W2y8BT0TgVVnGanhM6cmdNmEM+nvBQqyjMLY/kuolWebTmMORtYNjGqdsNU174IUoewZ7cYj2dG6chh3kItc+HQ6zVoNC2kQNPj+RwoPZz8Uu8EbcaAzc/ccHy4uz2GhjNGuwXZit5vg352Xm2CP0A5/9pFIKs//i0bqsPyxAZ4iiMNuP76gmrOhVwmpbPbPKGMbPRUk9qD5gRvuULM6MK8r0wZwQWMSN2edpmp+/O0exfm4suAyY52Xk/eH/6YXDKh7X1ocKYUf1mlFapQ4X8Em+7ydGft9f1AQn0FIa1RmXiEHNx4KRk6lfLDPL1EtfnE2TAGTXJYG59YMG2naKne6e7jo8fG3Kct5MMFugUTjkg4xak8vwtIZ+h9vSKm7+N+mJ7J47YDw/60h+iWQHD0A3/QQbfaPW8l3aTLoM5oeRcGrf93UWCcXLHGjZv97pDl61fnBUF1eFV2e2Svb2/45Tv99HKSn7icMmrLi4TTBtZiZUUz1rQaMom9hJIKrlAcLe+XtRTdOogEW2bJO7sNzJd98xL4H/mpeu+A0HgTKQ= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds a new member to the organization identified by the given `orgId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-organization-team-member.ParamsDetails.json b/platform-api-docs/docs/create-organization-team-member.ParamsDetails.json new file mode 100644 index 000000000..e4493fbc1 --- /dev/null +++ b/platform-api-docs/docs/create-organization-team-member.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-organization-team-member.RequestSchema.json b/platform-api-docs/docs/create-organization-team-member.RequestSchema.json new file mode 100644 index 000000000..0d2259be1 --- /dev/null +++ b/platform-api-docs/docs/create-organization-team-member.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Team create request","content":{"application/json":{"schema":{"type":"object","properties":{"userNameOrEmail":{"type":"string","description":"Username or email address of the organization member to add to the team."}},"title":"CreateTeamMemberRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-organization-team-member.StatusCodes.json b/platform-api-docs/docs/create-organization-team-member.StatusCodes.json new file mode 100644 index 000000000..525c4e1a1 --- /dev/null +++ b/platform-api-docs/docs/create-organization-team-member.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier."},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string","description":"Username of the organization member."},"email":{"type":"string","description":"Email address of the organization member."},"firstName":{"type":"string","description":"First name of the organization member."},"lastName":{"type":"string","description":"Last name of the organization member."},"avatar":{"type":"string","description":"Avatar image URL for the organization member."},"role":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"}},"title":"MemberDbDto","description":"Details of the organization member added to the team."}},"title":"AddTeamMemberResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-organization-team-member.api.mdx b/platform-api-docs/docs/create-organization-team-member.api.mdx index 4dbac455b..b1f7fad9e 100644 --- a/platform-api-docs/docs/create-organization-team-member.api.mdx +++ b/platform-api-docs/docs/create-organization-team-member.api.mdx @@ -5,9 +5,9 @@ description: "Adds a new member to the team identified by the given `teamId`." sidebar_label: "Create team member" hide_title: true hide_table_of_contents: true -api: eJytVttu2zgQ/RWCT7uAY6XddoH6aZ1LgWDbJnCSpyBAx9LYZiqJKknFcQX9e2dI2VYi1xaCvAgSNTM8c+ZaSQdzK0d30iFkVt4PZII2NqpwSudyJMdJYgWIHJciw2yKRjgt3AIFywuVYO7UTGEipit/PFePmIvv/Pci+T6UA6kLNMDWLhKyd2oQHF6aOeTqlz++IdGv3jQJF2AgQ4eGMVUypw9S0mZOygOpGFEBbiFfwmwbFHmZoVHxFh1bNvizVAYJgzMlDqSNF5iBHFXSrQq+ROUO5150pk0GLhz9+0HW9WCDJPi1Fwr78/YQ7oM6WneikxXr7Lg19uSKRpDMxJos5o7FoShSFXuCogfLOlUXgJ4+YMyKheGwOYWW/5YWzTci4NKcZ6DSloJ1RuXzDge3pMCMCW0EsoqAJDFordAznya6Ha9tYpFUO7+GzL10yqW4SZ1tukwaN2sWes6tP7CFzm1w4P3xcZeyy//fjqHgQl85roTDQX9JavB6R2oRTQMfo352G+FvPqP7R/KPgfPXY7/EOO+ZDN7mTBnr+sH8zKKiD9AU+tr8Aj1NwiM4MIcNjr2cUBnMUdxOvggKzF7DRqc7cSLlAPdsvcx9gLN1+4x1msJUU7/Vhnv50xGLHj2Cj6HtpbMuN2qpE76/XYIhBc+mZ053vDtDR7HdW+EUd9xT4DRr2tUd6pfLm2Q+7KrgE0he0+y2veKOaLCWwuEdP1C5QbATjrYH58boLvJ/dvSe9VAUuXYC0lQvCQ+LW4xLo9zKz78TBINmXNKYGd3d8xCg4bjQPEgL7Z32I2gkI6LbRpUflHXkZ3lUhWFVR4F9K9m4eVzP1tJQvcqFc4UdRREUahinukyGFn8StqHqRvja/xFXKThuKeKU5cX46kIysjXwa+Y5cNaGv6GNb5TN8OPvqReik/Dyed2sHpbOE8Lxm2xH3/kTZEUoi85Y2oSE5/NM+0ubyDTYGewht5gkFaNthDmtIPZp9ZyyNlFN+/PX/rf9QUCY73DPu+Gnj8NjPuPYZeCzstkrwmwLS9WmMp/BrLb5/QZLWRMLh08uKlKgbYangvEdPKTUHW9dnDOj9fYVNkQ62CxB68Si6C84HUmpqqZg8dakdc3HFDbDqUyv1IQUTDkYlHyJsvxOiTyD1OIeX/+aNNX6tzi85O10qzmEfCUZRVryF73+wNVmt+QV71WY/rztvQJLQ2x9T5ILhIQ3CiIr/DwN1x/dsImtcqfVsStBYxzHWLi9su2OcnV5fcNl2OyXmU5Yx8CSV1d6eqDa0+Gr259VNFDzeek7oww2uWjhec2/qHHv1U4qKH28xI3+gTml0IYZ/mZi6vo3cSBkNg== +api: eJytVktv2zgQ/ivEnHYBxU67xR50WudRINhuHeRxMgx0LI5lppKokJQdr6D/Xgwp20rs2kKQm0TODL/55lmDw9RCPAFHmFuYRiDJJkaVTukCYhhJaQWKglYip3xGRjgt3IIEywslqXBqrkiK2dofp2pJhfjBtzfyxwAi0CUZZGs3EmK4NISOxibFQv3vjx8I8/+8aYigRIM5OTKMqYYCc4IYtElvJESgGFGJbgFvYXYNiqLKyahkh44tG3qulCEJsTMVRWCTBeUIcQ1uXfIjqnCUetG5Njm6cPT3F2iaaIsk+HUUCvvz8RCmQZ2su9ByzToHXk08uaIVhAgSXTgqHItjWWYq8QQNnyzr1PsA9OyJElYsDYfNKbJ8W1ky3zGnsbnOUWUdBeuMKtI9Dh4tGWZMaCOIVQRKachaoec+TXQ3XrvEQim7+TVg7sEpl9E2dXbpcte62bDQa279gS11YYMDn8/P9ykb//txDAUX+spxJZwO+ltSg9cHUmsATeRj1M9uK/zdZ3T/SP42cP556pcY1z2TwducK2NdP5hfWVT0AZphX5vfsKdJXKJDc9rgyMsJlWNK4vHum5hrc9Sw0dlBnFRUOfdsvSp8gPNN+0x0luFMG3TacC9/OWPRsyX6GNpeOptyG5v0jt/vlmBIwavZldN73l2RQ5UdrXCUko4U+EjKbnWH+uXybiL4cqiCL1C+p9ntesUEcrIWU/KOn6jcILgXjq4H18bofeR/Heg9m6EoCu0EZplekfSmLCWVUW7t598FoSEzqtwC4smUh0BObqF5kJbaO+1HUAxDbVI7rP2gbIZ+lg/rMKyaYWDfAhs3y81srUwGMSycK208HGKpBkmmKzmw9EwGB2o/wvf+Rtxm6LiliEuWF6PbG2BkG+D3zHPgrAt/Sxu/CO3w4/+ZF4Ko/fi6aVZPK+cJ4fjd7Ubf9QvmZSiLvbG0DQnP57n2j7aRabEz2FNuMUkqIdsKc1ph4tPqNWVdotr255/9Z3fRRMB8h3c+DT6dfx6c8yEHL0eflu1iEYZb2Kq2pfkKZ71L8A/YytpgOHpxwzJDVfixYHwLDzk14bWLkyberF9hRYwg3m5Bm8yaRrDgfIwnUNcztPRosqbh4+eKDOfyNIIlGoUzjsakBqksf0uI55hZOuLrH3dtuf4pTm95B91qD7FYA6PIKv6DCH7Sertc8o73Lky/X/fegaUltpk2ESwIJa8Uk7q9vAzPnz2wiZ3yXq9jV4LGKEmodEdluy3ldnz/wHXYLpi5lqxjcMW7K64CUO3p8OXtz2rIsEgr3xoh2OSqxddF/6bIvVcHqajrIPGgf1LRNDtm+J+JaZpfM/BkWw== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds a new member to the team identified by the given `teamId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-organization-team.ParamsDetails.json b/platform-api-docs/docs/create-organization-team.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/create-organization-team.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-organization-team.RequestSchema.json b/platform-api-docs/docs/create-organization-team.RequestSchema.json new file mode 100644 index 000000000..ca06904b0 --- /dev/null +++ b/platform-api-docs/docs/create-organization-team.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Team details to create.","content":{"application/json":{"schema":{"type":"object","properties":{"team":{"description":"Team details to create, including name and optional description.","required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true,"readOnly":true,"description":"Team numeric identifier."},"name":{"maxLength":40,"pattern":"^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$","type":"string","description":"Unique team name within the organization."},"description":{"maxLength":250,"type":"string","description":"Optional description of the team."},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true}},"title":"Team"},"avatarId":{"type":"string","description":"Avatar image identifier for the team. See [Create avatar](https://docs.seqera.io/platform-api/create-avatar) to upload images and obtain an avatar ID."}},"title":"CreateTeamRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-organization-team.StatusCodes.json b/platform-api-docs/docs/create-organization-team.StatusCodes.json new file mode 100644 index 000000000..0d5beb805 --- /dev/null +++ b/platform-api-docs/docs/create-organization-team.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"team":{"type":"object","properties":{"teamId":{"type":"integer","format":"int64","description":"Team numeric identifier."},"name":{"type":"string","description":"Team name."},"description":{"type":"string","description":"Team description."},"avatarUrl":{"type":"string","description":"Full URL to the team avatar image."},"membersCount":{"type":"integer","format":"int32","description":"Number of members in the team."}},"title":"TeamDbDto","description":"Details of the newly created team."}},"title":"CreateTeamResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicated element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-organization-team.api.mdx b/platform-api-docs/docs/create-organization-team.api.mdx index 08b2230a3..afe6a6dfa 100644 --- a/platform-api-docs/docs/create-organization-team.api.mdx +++ b/platform-api-docs/docs/create-organization-team.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new team in the organization identified by the given `or sidebar_label: "Create organization team" hide_title: true hide_table_of_contents: true -api: eJzNV9tu4zYQ/RWC6EMC+LZJtugaKNpcdgGjiybI5aVet0tLY5uJRGpJKo7X1b93hpRs2VZjL9qHfTEkaq5n5gzHS+7E1PL+kDsQqeWjFo/BRkZmTmrF+/zSgHBgmWAK5oyEmFTMzYBpMxVKfhUkyGQMysmJhJiNF/7zVD6DYp9RahB/7rB7Ms9Ekug5W+icOc1SocQU2FybJ5uJCJiIIrCWTbRhU6PzzDI9YSmkYzC2w1tcZ2C8u0G8iuy6FgX5QLFMGJGCQyXMa8kVvqC4DwS/SsoqE27Gt1Otm2IqT8HIaJ2YoQgMfMmlAXTvTA4tbqMZpIL3l9wtMvIilYMpGBTFLFLhwtGPZ7woRkEdrLvQ8YJ0Nt1T9CwGJ2RiCZ7I50deI41WlSMVkWWJjHyI3UdLesvdIPT4ESJHSBiCzEmw/ivBc6DbFlY5SvJYqikjAJlQMdNeRySsZmETlWFAG1N9PRQZH4JZi6s8ScQ4gQpvjC2+Vsmiem9IpalwRavsgiVPxctHUFMsf/+sR73isFFI+c+haH89b//x6VM8OvqlX3v7e9j+C49+rh0dHy/ftE5/Kn7gq0ytMwjWTlM9KIk1D8TxQM6lmzUwyAe5oboR68nb3j5P1w3VIQKRJ3IfPGBtA3HqFVhZXBWA5NpOImbboKORRFj3kMX/xQhacdJRYX3VKDTxLJwwg0aTm5mee0kmUxof6zr7wbHKlt0BsGHIlQXbo6OZc5ntd7uxjmzHwhecJx2pu1kiHEXdFpnsBgK0g8oxUSLPEi3i4M8GJoyRLwofS8tscIXw1pIKfim128B5/Fpszw9/YDOtbGDFSa+3y8/r3/7/CbBfanAgQb+dgK+X9r7iSRMfDlDdmEyrpnowyX79Dzhr2MPtR6p41UVVeX3pvcHyOrrUeSjHqxCdnux4+T0n/drFVl2nJUW3iHE1vnJ6x8hVOa5LduPNnCzKwR03GKo3Y2g36kYUOGtquAts9fKi+pbOq18CKV7jCNj+e6AS3ClOPfz3xmizE/lpA1Wq/YAp7cKugfF46Xe70ld5SAchgwRSSvI7TRc/WohyI93CbzQXIAyY85wuhuGIFgtcd2aalqJM+6r5/abPu3jD2O7Srz5FN2x4ZMs8V8tRTszg1VjE8deJEp3H69m403t3/gu7KUcmuyR5dn4z4BRIFecdARWSrke7yps88nJ/ovexF8KT8PChItHj3HlwqAC36+3p/YtIswTqM61c8/6F3BXO9WumdijVRHtjZQ3KJCmrffkTmhL31lKYGkhEvoE2sa0jij0kEz8iJvrX9QcMhAoT/LzpvHvb6dEZ1RR35VqS5a22sYG7sPxujcxVP39Xi3zZBA5eHN29uJJjmnkY0qF1h7SvU7P2q7199f9kRi2OAsvlWFjA0V4UdIy9YYge+PgsjAxbI3Z4LC09Y70nIrHbO2MdoaPbktPH7IC/Ao05lIdCLTiFkeT0ho9PsFj9BSlGKDjDdQj7nQIM3y5DGO17srDW3RlCRavSOEeQM/eqbH0y3Fzf3RO/yv8eqY5Jx4g5LWf46+MMG76nrT9b4q6nprmfWTzYJDaKTTJvkddn1YgElsxL3OsnUFi2ChhH7wRMUfwDm1oLQg== +api: eJzNV21v2zYQ/ivEYR8SQLaTtBs2A0OXlxYIVjRFXr7M9dazeJbZSqRCUnFcTf99OFJy5NhrUmwf+k2i7u25u+d4qsFj5mA8AU9YOJgmIMmlVpVeGQ1jOLWEnpxAoWkpWEgoLfyChLEZavUFWVAoSdqruSIpZqvwOVN3pMVHY7Nz+XEortm8wDw3S7EylfBGFKgxI7E09rMrMSWBaUrOibmxIrOmKp0wc1FQMSPrhpCAKckGd+dyHdlFLwr2AQmUaLEgT5Zx1aCxIBhDCAQSUIyqRL+Ax1D7poSuCrIqfQBmOQJLt5WyJGHsbUUJuHRBBcK4Br8q2YvSnjKykMDc2AJ9PPrpJTTNNKqT8ydGrlhn0z1HLyR5VLnj9KQBH3tNjfakPatgWeYqDSGOPjnWq7eDMLNPlHrOhOWUeUUufOX0PNNtIpRO80oqnQlOoEAthQk6mIuehc2sTGK2p8kToSj5nJwloKs8x1lOXb4tobzQ+ap73wFlV+GapO2CGgq8f0s68wsYvzzgXvGeLCv/OcHBl+PBHx8+yOneq3Hv7e/J4K/p3qtfe0f7+/Vh8uLn5gdYI3XeKp1tNdWNVrcVReKERC6VX+xgUAhyQ3Uj1qMfD57ydLGjOkwg9sTuowf0FInTr8Da4roALDfwqiB4nPQmgRydvynlfzHSJOCV58KGqnFoeIce7flOk5tIj4OkUAWPj4c6h8GxRiuuiMQkYhXR9nRv4X3pxqORNKkbOroli0NlRmWOnqMeYKlGkQCDqLLPlKjK3KCM/lxkwsyj0gJ1a1mcnw2hDyr6ZWiXkfPQ8OfN+REOXGm0i6w4OjjY5ufF7///BHha6vyZBP12An69tNcdT3bx4RmqG5Np3VQ3Nn9a/02V5+Lm8i1XvOuirryh9MFgex2dmiqW46spenG05eVdxfq9i627TluKPiLG2ezMmy0jZ+24btmtaZmv2sEtdxjqN2NsN+7GJoGXuxruBKVoL6pv6bz+JVCQc5g94x7oBLeK0w//tbXGbkX+YgdVuv1AaOPjrkESgvQv29JnVYRDUlBOBYP8TuE2CThKK6v8Kmw0J4SW7HHFF8NkyotFQX5heCkqTaha2G/GMDI2c6M6rD7NKG54bMvedctRxcyAbixiqYZpbir5MBu3eu8qfBHv25EpTlleHL8/Bw6ki/OKExVB96Nd42aP0O5P/D4LQpC0D286En1a+pAcLsDlw/b0+h6LMqf+TGvXvH8hd5fn/jXTO1R6boKxtgYtSEb1FH7OpkrJtcLcQJiGBtrMbT+jVKDKw4iYm98ePjQJcGGin8Ph4cHR8IAPuagF6h7K9lrbWMF93H4fzcx1Q39Xm3zbBZ7uPV++SjPMKk7p2LsTXti5W8fd4r7+QVlwj48nUNczdHRj86bh49uKLPNjmsAdWhXXxkkNUjl+ljCeY+4eL439DO1dtqTeF8/4F9iJoT1EvQIOI6/4DRL4TKv1P0gzbRJYEEqyIcD47TSGMbhmCw+6W1OoSTqN4zSl0n9Vtj8a3l9cXTPB2p+PwkjWsbjk7QyXMc644gfehrMactRZFYYWRJtMR9xk8yP2BlQ7M1HXUeLafCbdNOvEeH7nxDTNPxE8C2c= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new team in the organization identified by the given `orgId`. Teams al id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-organization.RequestSchema.json b/platform-api-docs/docs/create-organization.RequestSchema.json new file mode 100644 index 000000000..46c8f3d43 --- /dev/null +++ b/platform-api-docs/docs/create-organization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Organization details to create.","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"description":"Organization details to create, including name, full name, and optional description, location, and website.","required":["fullName","name"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true,"readOnly":true,"description":"Organization numeric identifier."},"name":{"maxLength":40,"pattern":"^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$","type":"string","description":"Unique organization name. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters."},"fullName":{"maxLength":100,"type":"string","description":"Full display name for the organization. Maximum 100 characters."},"description":{"maxLength":1000,"type":"string","description":"Optional description of the organization. Maximum 1000 characters."},"location":{"maxLength":100,"type":"string","description":"Optional location or address for the organization. Maximum 100 characters."},"website":{"pattern":"","type":"string","description":"Optional website URL for the organization."},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the organization was created."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp when the organization was last updated."}},"title":"Organization"},"logoId":{"type":"string","description":"Logo image identifier for the organization. See [Create avatar](https://docs.seqera.io/platform-api/create-avatar) to upload images and obtain a logo ID."}},"title":"CreateOrganizationRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-organization.StatusCodes.json b/platform-api-docs/docs/create-organization.StatusCodes.json new file mode 100644 index 000000000..0fc458fd1 --- /dev/null +++ b/platform-api-docs/docs/create-organization.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"paying":{"type":"boolean","deprecated":true},"orgId":{"type":"integer","format":"int64","description":"Organization numeric identifier."},"name":{"type":"string","description":"Unique organization name."},"fullName":{"type":"string","description":"Full display name for the organization."},"description":{"type":"string","description":"Organization description."},"location":{"type":"string","description":"Organization location or address."},"website":{"type":"string","description":"Organization website URL."},"logoId":{"type":"string","description":"Logo image identifier for the organization."},"logoUrl":{"type":"string","description":"Full URL to the organization logo image."},"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier for the requesting user within this organization."},"memberRole":{"description":"Organization role of the requesting user. Accepts `owner`, `admin`, `maintain`, or `view`. See [Organization user roles](https://docs.seqera.io/platform-cloud/orgs-and-teams/roles#organization-user-roles) for more information.","type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"},"type":{"enum":["pro","basic","academic","evaluating"],"description":"Organization type. Accepts `pro`, `basic`, `academic`, or `evaluating`.","type":"string","x-enum-varnames":["academic","evaluating","pro","basic","internal"],"title":"OrgType"}},"title":"OrganizationDbDto","description":"Details of the newly created organization."}},"title":"CreateOrganizationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-organization.api.mdx b/platform-api-docs/docs/create-organization.api.mdx index 642ff6da3..5ee51b681 100644 --- a/platform-api-docs/docs/create-organization.api.mdx +++ b/platform-api-docs/docs/create-organization.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new organization with the requesting user as an owner." sidebar_label: "Create organization" hide_title: true hide_table_of_contents: true -api: eJzNWG1v2zYQ/iuEtg8NYNlulw1rgGFLmxYI1i5FXr4szRZauthsKVIlqTiu5/++O1KSacmNm6Id9iWRqeO9PLx77qhl4vjUJgeXiTb4/2qQ5GAzI0ontEoOkucGuAPLOFMwZyjDlfjI6SWbCzdjbgbMwIcKrBNqyioLhnEUV0zPFZhhMkh0CcbvOM5bhSeRIhSpNTzT+SI5WHZciGVZDo4LaZnTLPOayEKmlQPlaCsvSykyLzt6Z2n/MrHZDApOT25RAmrUk3eQOdxYGnLOCbD0No7uoW4MmFCZrHICQfECf99UUtaPXOVMez1cskjrgEkdfA0yc5hYEUIiRISBnE6GNP2BinCZ9NEh3R+IyKNgBWIzBYNCN9oU3IWln/ZJGyrmE4lSzlRARnl+ouSi+X0PAKoqwIiMiRyBFzeCjnpV+4e2C373CtTUzZKD/TG6x50DQ0r+uuTpx8P0z7dv86tHvx5Ev/65TP/GpV+ipb295ePBDz+vvk/aiK0zCHHS9e1CCcygzfwkX4bsdWUdmwB7ku6PWTbjhmfoih0w67hxHnYg6CmZuSxnvIksliWpDHOaEo0LxWaLcgbKoj1WqRxFMm2wSCbg5gAq2upBac9vE5jH4/GusF5SDuXClpIvfDwMz9DXXBwpBsnvRFEVDFV2jW8o7Nrf6cDJlqxl+uZ+F3o+NFn+cABa+40KgpznOaJtH45FXV/kxjojd+ZW60O9nV2cvtpu2+ONZBA4Li7CVnVbgySXOuGr+v66O0chTNaiZHNMup5VNke+DSSUB7S5dRdl/h97QFZZFcyiG+iHE46oZYM3QjZM9fFW1zatvkI5Jgo+hYhlPnHoZwDsMsDO+C3H0r56NHOutAejUa4zO7TwAbvQUOgR1pIjDFJeilHALQ1b9ojOq1Jqnge7NjD3xNc8Z+Q4Oz7ajK7fz05DM0OpVczjBKxfsKVWNhD1k/F4S6P5/du1tPulS76gg1jLTbSWwJU/mtJAFnKqjgR1H39mo/nyRvKFtN+l3a9Cs1vodAdzbI4M7aseKT5AzRYi7HLbA7RFlDb8RrXZqL0w8jNPgvgVK7FHM7I16pUWUEzAfFkKvvZ7tyRfG0N3qKUBQRD3CduPL7hyqiXsmBsNijT9s2NhyA6zDEpn2bUfna8H7JrnhVD0UCADEQvhM/p3fStgfl2z3oZ+7yoZsbv5L5O6ykc09qdIc6kDXtiR3/tdHGBKOlO/vufRKXDWwWk3IOwR6HdQQGT9pYIiSRqAPK/RyKnxQqANDbJ3KYmmt9xQ3dnP2hM1Fg/5qrG/bO0ir+HGCbciw/884zkU/hFuuaw4gd6/62wgSRqjI0GFdA5eoz+ZWmV9IGu119vg2BLldp8GHc8poXGP7IR9Tvo/1WOPJkdO9zL+qL6x1MmHtzm5aMaGbkLvaG+hgVF/Q8H9bS3sGXbQOr0f0sviSw/CZLHSd192GsEet8RhvDBGm57nP2yp1uayypTG24GUeo7+eOmnfemjKoQDDCQUFOP/NFp8aSGrjHA44l0uk2fADZjDisbwy6vVFVWbm2m6oJfaHxoOyPgu8fyQ0G5zi2O031wRkycNveAYNfRUsuaYXvKd+TfsTU097DnJs8M3xwmZbjw7I2hCmLF/baRkkVzxYjSdeCGqFv/wsqH8d3Pn4SDIT9dfFl7c4QQbGLo7FoVpI5qR29HhU42qXV638fVa24vbw1l31miJONSHVx9bjRLBsgtAOg6R4YAahP29NPM5t3k48ZFg2gnpO+KN/m39Ah2hkw12Hg+f/jgc0xqlQcFjdOrxegO73kDUZv/X+HJUn7uDO0dtS/jrQxXmiJCf689WM0pb/L1cIncCDhurFS2jfkMpj4/IviJ87cCMxw145cHsoYR+DwtyOLieenIlcVmR9V4RrwbNjtAd7pWNK+vNydk5ZWv9lavQOe0xfE4XMPzr76LhO5EvAr+2xPucmla+5pOgk3Kbb5ZGpxR8VPUrrhaRhwiPlzjX70EhRIM6FEe/0V1U/i9eiAjx +api: eJzNWG1v2zYQ/isEtw8NINlOGwybgaFLmxYI1ixFXr7M9eazdLHZUqRCUnFcT/99OFKSZcuNk6Id9k2ijvfy3PG5o1bcwczy4YhrM7N8HPEUbWJE7oRWfMhfGwSHlgFTuGDazECJz0Af2UK4OXNzZAZvC7ROqBkrLBoGloFieqHQ9HjEdY7G7zhNG4XnLUU84pWGVzpd8uFqy4W2LEvRgZCWOc0Sr4ksJFo5VI62Qp5LkXjZ/kdL+1fcJnPMgJ7cMkc+5Hr6ERPHI54bcs4JtPS1Hd1T3YiYUIksUgJBQYYRuymkrB5BpUx7PSBZS2vEpA6+BpkFTq0IIREiwmBKmSFNf0CGPOKkj5L0cCAibQUrlMMZGh7xG20ycGHppyPSVkgJU4l86EyBZBTScyWX9fsDAKgiQyMSJlJUTtwISnVZ+Tdc8Qzu36GauTkfHg0inoNzaEjJXyOIPx/Hf374kI6fvRy23v4ZxX+Pn738tbV0cLA6jF78XP7Im4itM0LN+LZv10rcFrhZn+RLj50V1rEpsufx0YAlczCQODQ2YtaBcR52JOipmEHmc6gja8uSVAKKUaGBUGy+zOeoLNOGFSpFYxNt0LIpugWiam31oDT52wTmcDDYF9ZbqqFU2FzC0sfDbrTxZ64daY+dwb3IiowdDgbbxjcUbtvf68D5jqpl+uZhFzo+1FX+dAAa+7UKghzS1KC1T8eiOl/kxroi99ZW40O1nV1fvNtt2+MNDgPHtQ9ho7o5gyQXO+FP9cPn7kpkaB1kOVvMUXWssgXYioTSgDZYd52n/7EHZJUVwWyPl2XEnXBELRu8Eaphpk93urZp9Z2eaSYymGGLZb6Q9EtENgqwM7gDB2b8bO5cbof9fqoT27N4iwZ6QvdzCY4wiCEX/YBbHLYcEJ0XudSQBrs2MPfUn3lg5Dg7PdmMrtvPLkIz4yWJrXmcgPULNtfKBqJ+PhjsaDS/f7+W9rB0DktKxFpuqrVEUD41ucEk1FQViTaz00c2mq9vJF9J+9u0+01odged7mGOzZGh+dQhxSeo2UGE29z2BG0tSut9p7NZq7028pGZIH51ukszsjHqlWaYTdF8XQme+b07iq+JYXuopQFBEPcJ240vuHKhJe6ZG42WWPfPLQs9dpwkmDvLJn50nkRsAmkmFD1kIPzkMYko75M7gYtJxXob+r2rZMTu579E6iLt09gfg0pjh5DZvt/7QzvAmHTGfv3Ao5Npg0yogLBHoNtBURWZv1RQJLwGyPMajZzagNOGBtn7mETjOzB07uyj9rQai4e8rO2vGru50TziU7Ai4RGHBFLM/CPegSyAQO/edTaQJI2tlORGUx68Rp+ZSmWVkLXayS44dkS526doy3MqaKNAboV9Rfq/1GNPpidOdyr+pLqxVMWncCGX9diwXdB72ltoYNTfyogf7WphryCty/spvax96cnQWpg94rJTC3a4pR3GG2O06Xj+YsdprS+rTGnHQEq9wJR76V+60idFCAcZSswoxv9ptGXELSaFEW7Jh6MVf4Vg0BwXNIaPxuWYTpuba7qg59onLQf6xj0/cNpt7tBYv7kgJuc1vUAuep5K1hzTKb5L/4W9r6iHvSZ5dvz+lJPp2rNLgiaE2faviZQskitejKYTL0SnxT+8rSn/48J5OAjyi/WfhTf3kOWBobfHojBttGbkZnT4UqNqltdtfL3W9OImOevO2loiDvXhVWmrUCJY9gFI6RAJ2krY30sTX3ObyWmnBDMQ0nfEG/3b+kMZccpssHPYOxw87w1okeoggzY81Xy9AV5nImrK/1v8OqoS7/DeUd8S/v5QhEEiFOj6v9Wc6nY44qvVFCxeG1mWtHxboKGaH0f8DowIvztG4zLic4QUja/oT7gkh4PrsWdXEpcFWe+c4jKqd4T28KBs+2i9P7+8onKtfnNlOqU9BhZ0A4NFuIyGH0X+FPi1FZegZoU/9DzopOKGzbOxdRZ8VNUnUMuWh6tVkLjSn1CVJY+qUBy983JcluW/Av0JFg== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new organization with the requesting user as an owner. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-pipeline-secret.ParamsDetails.json b/platform-api-docs/docs/create-pipeline-secret.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/create-pipeline-secret.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-pipeline-secret.RequestSchema.json b/platform-api-docs/docs/create-pipeline-secret.RequestSchema.json new file mode 100644 index 000000000..03cc6e8f9 --- /dev/null +++ b/platform-api-docs/docs/create-pipeline-secret.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Pipeline secret create request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"title":"CreatePipelineSecretRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-pipeline-secret.StatusCodes.json b/platform-api-docs/docs/create-pipeline-secret.StatusCodes.json new file mode 100644 index 000000000..4c4f3d4b6 --- /dev/null +++ b/platform-api-docs/docs/create-pipeline-secret.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"secretId":{"type":"integer","format":"int64"}},"title":"CreatePipelineSecretResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-pipeline-secret.api.mdx b/platform-api-docs/docs/create-pipeline-secret.api.mdx index ae264ecd2..f23484ddb 100644 --- a/platform-api-docs/docs/create-pipeline-secret.api.mdx +++ b/platform-api-docs/docs/create-pipeline-secret.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new pipeline secret in the user context. Append `?worksp sidebar_label: "Create pipeline secret" hide_title: true hide_table_of_contents: true -api: eJzFVU1vGjEQ/SuWzwTSNq3UXFoSpVLUQ1BI1UMUKcPuAE6M7djeELTiv3fG3gUClFRVpV4Q6/l682aeXcsIkyBPb6VTDrUyeBSw8BiDvOvIEkPhlYvKGnkqzz1CxCBAGJyL1l9kf6GMiFMUVUAvCmsivsSu6DuHphT3X+bWPwYHBV6W9yJaUaRcKWIdD2LltkohO9I69MAYLssVikFTfZiCycmBhxlG9NxMLQ19kPNGWfJR3MVThX4ht3v7uSpsqhl6VQhVoolqrNCTcyimOAN5Wsu4cJxYEbpJMo2tn0HMR59O5HJJvHmkKiGe2XLBMa9LDbaIa6hoYihjat1EjgTntCpS872HwOH1LhY7esAiceCZqqgwsDVTsPIK0SszkcuOfAZd7bOQKaqo8TckXzcAl+zIaJVHGkj0FaaD4KwJufT74+Pdvq++/7veMnW8D38ykbf6ysi5MXI92Yf9DMq/GdCapVs5wxBggiyrw721jgcHdOG99TvIP+xhvRWPMDYK0NrOCQ+7E4eVV3GR9HKG4NH3qzilzzveYRLT1LLgnA1ZYGyTvZ17gjP551Z4ldfkNY3RhdNeD5zqFtpWZTfgEwHpKrsjvWGyiIGGyJMT5+wv+oNLyTBalEMmNRO0iXXFEVdshcrfo+REJ/nPt3YnHuYxdc/Dul7L9OIFZk7jWjct6Su5bAhImbFNpZthNB0w5LeaY6pUQZdoduZNgiJt0mviNumiZVI6rfPYfl0bWMnEeq7zrvv5Y/eYz3hcMzAbneSl376wt6HW67X+bzd9M0v+7DkNdF9TQ4mYutm//e/UlFeUbHU9goA/vF4u+Thf9byVpQow0izEMeiAB1p/4yHYi/ARFztvTbs1aYmfwSuun7RFcBFKysbAcuh5Ln90w9nXsTuXy7LTRvSLAl086Lup4cHV8Ia10DxIM1tyjIc5HfIv4eR3lqOTxNJZLTWYSZXuIplzsnLgtfC2hJa6akxgFhsIaTjJ48Y+oqEBtbxF/ia4lPwXrJD6eg== +api: eJzFVcFuGjEQ/RVrzhsgadTDXloSpVLUQ1BI1QNCyrA7gBOv7djeELTaf6/GuwsEKKmqSr0g1p7xvPdmnl1BwIWHdAJWWlJS05mnzFHwME0gJ585aYM0GlK4doSBvEChaSW6eNHEC6lFWJIoPTmRGR3oLfTE0FrSuXj8sjLu2VvM6DZ/FMGILJ4VM7b5KDZhmyMgAWPJIWO4zTcoRm31cUyGBCw6LCiQYzIVaCwIUtgpCwlIZvFSklvDPrefm8K6LMjJTMicdJBzSQ4S8NmSCoS0grC2fLDUgRZxa25cgaFZ+nwJdT1NwNFLST5cmXzNOe9LjfaEa6VocyCBSF0HzkRrlcwi+f6T5/TqEIuZPVEWNXAsVZDkebeRYBPlg5N6AXUCr6jKYzt1AkEGRb8R+b4FWHMgo5WOckiDKykueGu0b0pfDAaHvO++/ztujXQ8D3/SkY94NciZWJ3A5THsV5j/TYO2Kk2gIO9xQWyr09y6wJMNunHOuAPkn46o3plHaBMEKmVWlMejPGWlk2Ed/XJF6MgNy7CEdDLlGS4oLA0bzhrfGIz3oH9wT/BJ7rUzXukUpLAMwfq030cre5kyZd7z9EIOe9IcWG8cd8RIYeDOiWuOF8PRLTCMDuWYRW0E2sW60Ygrdkbl71kMgqT9862biadViOy5Wfdbm968YWEVbX3Tib6xy46BpJ6bWLptRsuAIX9EjqWSGfk2mCcJszhJ74XblYsKlCqO89x83W6wk8n5ps5573xw0RvwIverQL1DpZn6/Rt7H2u1nev/dtW3zeTPvlUoNROKylTtAB5/qJY8o+kEqmqGnn44Vde83Nz1PJa59DhT7MQ5Kk8nqH/wEhxF+Ezrg8emG5s4xa/oJNeP5kpgSZiTi8Ca1Oum/NkDn77NPbhd6qTLGGYZ2XAydtfEo7vxA5uhfZEKk3OOwxUk8TeF+NBydvRYXKtAoV6U8TKC5ky2Dr533p7TIqt2C/V6B2FVNREP5pl0XUOnW+BvqKd1Xf8CGcv6nw== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new pipeline secret in the user context. Append `?workspaceId` to crea id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-pipeline.ParamsDetails.json b/platform-api-docs/docs/create-pipeline.ParamsDetails.json new file mode 100644 index 000000000..efe34fa5f --- /dev/null +++ b/platform-api-docs/docs/create-pipeline.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, creates pipeline in a user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-pipeline.RequestSchema.json b/platform-api-docs/docs/create-pipeline.RequestSchema.json new file mode 100644 index 000000000..af3529238 --- /dev/null +++ b/platform-api-docs/docs/create-pipeline.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Pipeline creation request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Pipeline name. Must be unique within the workspace."},"description":{"type":"string","description":"Pipeline description."},"icon":{"type":"string","description":"Pipeline icon URL."},"launch":{"type":"object","properties":{"id":{"type":"string","description":"Launch configuration identifier."},"computeEnvId":{"type":"string","description":"Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted."},"runName":{"type":"string","description":"Custom run name for the workflow execution."},"pipeline":{"type":"string","description":"Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)."},"workDir":{"type":"string","description":"Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted."},"revision":{"type":"string","description":"Git revision, branch, or tag to use."},"sessionId":{"type":"string","description":"Nextflow session identifier for resuming failed runs."},"configProfiles":{"type":"array","items":{"type":"string"},"description":"Array of Nextflow configuration profile names to apply."},"userSecrets":{"type":"array","items":{"type":"string"},"description":"Array of user secrets to make available to the pipeline."},"workspaceSecrets":{"type":"array","items":{"type":"string"},"description":"Array of workspace secrets to make available to the pipeline."},"configText":{"type":"string","description":"Nextflow configuration as text (overrides config files)."},"towerConfig":{"type":"string","description":"Platform-specific configuration options."},"paramsText":{"type":"string","description":"Pipeline parameters in JSON or YAML format."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"mainScript":{"type":"string","description":"Alternative main script filename. Default: `main.nf`."},"entryName":{"type":"string","description":"Workflow entry point name when using Nextflow DSL2."},"schemaName":{"type":"string","description":"Name of the pipeline schema to use."},"resume":{"type":"boolean","description":"Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)."},"pullLatest":{"type":"boolean","description":"Pull the latest version of the pipeline from the repository."},"stubRun":{"type":"boolean","description":"Execute a stub run for testing (processes return dummy results)."},"optimizationId":{"type":"string","description":"Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"optimizationTargets":{"type":"string","description":"Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to each pipeline run."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"launchContainer":{"type":"string","description":"Container image to use for the Nextflow launcher."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the launch configuration was created."}},"title":"WorkflowLaunchRequest","description":"Launch configuration for the pipeline."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to apply to the pipeline."}},"title":"CreatePipelineRequest"},"examples":{"BasicPipelineCreation":{"summary":"Create a pipeline with nf-core/rnaseq","description":"Minimal pipeline creation request using nf-core/rnaseq with the `test_full` configuration profile.","value":{"name":"rnaseq-pipeline","description":"Minimal nf-core/rnaseq pipeline configuration with the `test_full` profile.","launch":{"pipeline":"https://github.com/nf-core/rnaseq","computeEnvId":"your-compute-env-id","revision":"master","configProfiles":["test_full"],"labelIds":["label_id_1","label_id_2"]}}}}}},"required":true}} diff --git a/platform-api-docs/docs/create-pipeline.StatusCodes.json b/platform-api-docs/docs/create-pipeline.StatusCodes.json new file mode 100644 index 000000000..6ae373322 --- /dev/null +++ b/platform-api-docs/docs/create-pipeline.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipeline":{"type":"object","properties":{"pipelineId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"repository":{"type":"string"},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"},"userFirstName":{"type":"string"},"userLastName":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"visibility":{"type":"string"},"deleted":{"type":"boolean"},"lastUpdated":{"type":"string","format":"date-time"},"optimizationId":{"type":"string"},"optimizationTargets":{"type":"string"},"optimizationStatus":{"type":"string","enum":["OPTIMIZED","OPTIMIZABLE","UNAVAILABLE"],"title":"PipelineOptimizationStatus"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"computeEnv":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"}},"title":"PipelineDbDto"}},"title":"CreatePipelineResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-pipeline.api.mdx b/platform-api-docs/docs/create-pipeline.api.mdx index 6c54e6913..9be60f26f 100644 --- a/platform-api-docs/docs/create-pipeline.api.mdx +++ b/platform-api-docs/docs/create-pipeline.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new pipeline in a user context. Append `?workspaceId` to sidebar_label: "Create pipeline" hide_title: true hide_table_of_contents: true -api: eJzNGmtz2zbyr2DYL7kZU340uTb+cqfY7o1aO/b4cZ2rxxND5EpCQhIsAErRefzfuwvwAVKUTWc8ucsHRwQW+8K+yYfA8LkODm+DXOSQiAx0cLcTxKAjJXIjZBYcBkcKuAHNOMtgxSpAJjJcKTQoFsnMwFczYuM8hyxm9/9YSfVF5zyCSXzPjGSRRcHMAjrna8AaSbATyBwUJ+KTuCZ/UR7D7ZwrnoIBRYw/BBk+IJhHEmEEMf5nAWoddMX5vSaZFSkoETERQ2bETIAascmMyVQYA/FOybV+SmTErqMFpDw4fAjMOidOBG7NQeHWTKqUG7f097fB4yPqVgGypc0HGa/pTJu3SkpHGtdYCY7ILMnM0CGe54mILMDuZ00nHzbZkNPPENHBXJFCjcC7PazUVUNpo0Q231BSzQiBj9hZoQ2bAisygeywlTAL1AVdZ632UfDYQTKYhrdssYjoRccJnN1cntqzCS+yaPG8GkT8PIVTi4vueibmhTNJ31iIXiTTvDBwki0nAzAeOWgG2VIomaWIykPIVgtQHS9ZiSRhqshG7BhmvEiMJn9q3CZXIuVqzaI+zLUtW1YRy8dBl3+Ety1Tomqvn6EZ13c9S+SKwVeIivq6Kl5fcGUKcqmFkcg4Xhx7A6P5aIfdL4zJ9eHu7hztq5iOUKbdDL2MaIZC7i4gSeT93yxR4uVYqOdpkruzWCg0AiKXc7Mo9VyLQw6rUogFxaiZSCjW4T4qQaHqWorvU/OqTaGrdVgKPcgf/iUMq6B32FRxNL4dRrrnc6KNgcdi1KB1GRyfQ/mx1B4rz/jGRreqQBcpHmQzjmLHdOW6NGuy+QslrTo8QlwpTjFVGEj1JgPdGBCMCZ7JGatZabtT7khYQ7Mapti2tjxQoL0CjITmVRiwcVs7fEQo5V+A8SUKzqfIAK74jlcbmXWzV2Sjcd2X8eLUdo1afMG1t3XNkRbusDdyCUqhKegSwBm9cywjV6CO7PIAh064oSQX6hwiNKuoQ1FaQGdSNm3rYQLUgaLJ9ZR8f706/0gO8Z/x2SlzydWhVnBZZFcWwfPIx3GMadytoJ65KeMZWBqk+GwWujxSQWGUJT+UCLCUX8hhahWjAUfoXKBH7AqA3V5g5OBYBGGAMyGFUIdC372polssIz3S8CcWOSOManmlwyiRRbzrCO/yeIn+D/EPKFuI+MIKX1jic7dFq68jOp+hlhnHbLMpGlvwJdjYlwDFtf+FpCkXw8VMUJYMTRC5pnOVxGTmrqApY/ohu6f9UTa7t0QwOKr1sCT5e50M6QwqAbOIS5eYXTKMNi0rOb46PXDB25Zpw0gQFIWMVkHgEPj5wAZxH91UygR4toHvJLPRxcETBvxluDI9iZ3NFFYARDjhWPrpIiJLmBVJZRSlDVw6XLxBgRf3QgOIOIoUOq5+cP+FPKwQkiWUtl4kySkV5GaArBcIXPJPJxhGPJsAu+qs5WxKEndPppiiYw3RqvMg8is8Y6smWzAhVTKBN40XYbQvVMbiIk3X9haSyrgpTqbiv3XT85xlnHvw2+vT0k2bokvLQmHi8akNvatKYaF/eJcSyVLAalOKa67m7Yy5vSROeaiBIj3GFpYIvC28JR8ZVkAW23eXCNMxJJN4SOLf3vVtLQUsdjY5dnUPFmjzjH4B+kNjoFT7E44F8PhXOT3Ki+ep/niwGUuKdIrxHakeXdxoivMysvquivs6VBEh9llOfapnkKJjnE2/hbI7W1G0sWUbScq/Kcz5dI3e47VzWI4YDNMwoNyvQRn2RXMo4+QmSYe4bOJi1IQbM/T6Xi0gwYVoLLBB9hoXMZamuYv+LvD0dI8rrMHcWIG6Ayq3hEnASyeu57ysu/4BHWklW6tc/J6WSxV7T83qSdee4VTSUcL9yqmosOx84FpEFcxROQCxow0MmNjj1ngw1Hr9MfZzWK9F2KvtYs5Hd9+0QJGhMSTNoe50pczWbTQONcl0T7H8Eya/5L6/e6Ex0JInBTQDlsAhCfNmbtXPVIdow2Pbbvp48ag3Y4+mGw/62umuptrzi2CN8TQs10JsckNB07Smh8UyTBtrK90O8TaoOaMRYmN/t+73JxF/2g92moeD4O7R/nMzMeyfkQGjCnAlTY59g7OLg729zUnZ+W+vNxLrGWA8A9nK0U/5T/+07blJ2dYZmFVNVaf0blOXO5g7Au4vRcvNX4TS5kmIU/4EgFTzwbwg7FY8/mx3GLb6xFacZNFTkQjTr8cYbKvTU//Z4KrNTR6/IF8MqPGGFlAduCvDTdFbZ0FWpOR+5xfXk7PJHyfHuFb+Hn84PcGnm4/jf48np/bpronWVQw+3yRTZZYheWXI5PWbfKcOtT3O4QrC/msTumz7tm6vkaaItm1PaE6Yy4RvNYyXFxJ+ljwlzR5Pj420y01o/rZx9lMqrGrhLVqc94clP6PXzDUMd+1nc6dbB7goH7gs8LYvzn/AyvAb3oE0GeU2wMpMYyloLfxJJVaATwp+opRUG5z/2JOhqrdYLJPGlr8r5MdCv9+EPi6cOMAw8NBY+f9VWjuAjgplA+ctVm3AFahxYbD6uL2jN1wpmIWkYoIGOfZ9He0FdcOl6aUZdlnVC7xCJV6xwnMxsg1a07lt1E5XdodV00d2RPBsfDEJiH7F3hXppywtPSZrcYli9f7O+rEFwhX345fKWT+vjNUJ6f2yeXt34kpXr+Tb0pLUyy6nN89N0Ubu26x3arJ6vX6B0yx51V69Vr8a8U42BVy95r1G8El3q7py664zj/c3Nsfk/q4/uG4ItcbMnjzekNhbbc13vfX29LPZ8IeFfkKsp3ueGryBnK8wN1OjerQ9eXIr9XjIPXZze4OoN6X7JlCXyXt3nSZ/r6f93utpiT2789MP1s0Hb8O9n8KD99f77w7f7R8e/Dza+2n/j3Z7iHQpuWUzaV2j9PvSw8ilnnM+cmURgS6BKWjxyAattmP77owaF4nN9TP5z2aDcrub0+He/uj9u9FeNeROeeZ5WtkHbmuuHprQ+f2/XiijCz3SyEnYwsCq4qEMhZ2vLRYUJnHx4WGKTdmNSh4fadl9vUABMhaaBrd4pzOeaHhC2Nf+tqFXli9ArXj7e4uyJAtsAF5yJYhhmxCcEZOdoiTu6JHjN7wm7M3ZjRz3uFOdGEcR5OZJWD/xXJxfXVMcL7+xSGVsO3K+Is/Gv8in80zMajZ/0toDOkU2L2xKDBxOivq8nTQ6ScJKVdXB2drjEG/TQlzLL5DhjVZ6M/SM7CLyvwAUIoAZ +api: eJzNGtty27j1VzDYl3RGN3uz3a5eWsf2drTrxB7b6U7X44kh8khCAgIMLlJUjf+9cwBeQIqy6UwmrV8sAgfnhnMnd9SypaHTO5rzHASXYOj9gKZgEs1zy5WkU3qqgVkwhBEJG1ICEi4JI86AJomSFr7YETnJc5Apefj7RulPJmcJzNIHYhVJPApiV9A6XwFWSOiAqhw0Q+KztCJ/VRyjA5ozzTKwoJHxHZUsAzqlEUk6oBwZ/+xAb2lbnD8qktJloHlCeArS8gUHPSKzBVEZtxbSQcG1eUpkOqAmWUHG6HRH7TZHTri0sARNB3ShdMZsWPrra/r4eD+gGj47MPaNSrd4pslbKWUgzZUkBTgdUE9SWjzE8lzwxAOMPxo8udtnQ80/QoIHc40KtRwM7gZ1VVDGai6Xe0qqGEHwEXnrjCVzIE7yzw7IhtsVl/46K7WP6GMLSW8a0bLHwpMXHUdw8v76wp8VzMlk9bwaePo8hQuPC+96wZcumGRsLEgvUVnuLJzL9awHxtMATUCuuVYyA2kjhGSzAt3ykg0XgmgnR+QMFswJa9CfarfJNc+Y3pKkC3Nly55V7eS7Xpd/6oxVGVL1108WSld3vRBqQ+ALJK66rpLXF1yZhlwZbpXe4sWRVzBajgbkYWVtbqbj8ZLblZuPEpWNJXyxSHPI1XgFQqiHv3iiyMsZ18/TRHcnKdeQeHI5s6tCz5U46LA6g5RjjFpwgbFOAzFWaUibiu9S86ZJoa11WHPTyx/+yS0poQdkrplMVgOCumdLpO1McDIDxhTB8TmU7wrtkeJMbGx4qxqMy7hckgXjAlK8clOYNdr8lVZeHREhpjXDmMotZGafgXYMoCcIT9SCVKw03SkPJLyheQ1jbNt6HjDQ3kCiwX4TBnzcNgEfEsrYJyBszbhgcwG4EjteZWTezb4hG7XrvoyXoLZb+GJfcO1NXTNDMGmRV2oNWvMUTAEQjD44llUb0Kd+uYdDC2YxyQ1NDglf8KRFUXnAYFI+bZt+AlSBos71mHx/u7l8hw7x75O3FyQk14Baw7WTNx7B88hP0pQwElaIXTFbxDPwNFDxcjEMeaSEyjVHP1SEy7X6hA5TqTjXKgFjwIzIDQC5u9JAmExJrowdYggNKMz9qzK6pSoxIwOfQbMRV+O81GEilEvHgfCYpWsmE0h/yDUMmUyHJb5hgS/cFq5+G9HZwoImTIgO0ciKrcHHPgEY1/4XkmaM9xdTWNCSWb4GgudKidHMQ0FTxPQpecD9kVw8eCIgrd72S5J/VMkQz5BccWlDutysQBJnGlZydnNxHIK3L9P6kUAoDBmNgiAgiPOBD+IxurlSApjcw3cufXQJ8IhBg7FM247EThZaZZ6wYMYS4xK0hIUTpVEUNnAdcLEahXbyhQaQsGQFw8DVD+HfkA1LhGgJha07IS6wILc9ZL1yQhT84wmyBu0TYFudlZx1SRLuybr5tZN9tBo8CP3KurmvmnzBBMaiCbyqvUiDdVqS1GXZ1t+CKI0b42TG/1M1Pc9ZxmUEf7g+Ldy0LrqMcjoBElPre1elwobx4TEmkjWHzb4Ut0wvmxnzcEmcsaEBjPQWUiK4sXhLMTJiA7bvLpFgcxCztE/iP9z1HSwFPHYyOwt1jzF8KfEXsGRVGyjW/ohjBSz9Tc1Pc/c81R+P92OJy+agkerp1XuDcV4lXt9lcV+FKiREPqp5TPUtZEpv386/hnI4W1L0seUQScy/GSzZfGvBRO3cqZKWcQk9yv0KlPCMLaGIk/skA+KiiUuZhTBm6PS9SkCEG1qewR7ZW55hLM3yEP1D4OnoHjfMFGMF7A6w3OJWQJROQs95XXX9PTrSUrZGufg9LRcr9o6aNZKuOcMppcOE+4VhUeHZecMMT0qY02IA4kcbLsMet8JDWNwf2xXWa4nSMNaSGfi8b4Fc8oyJ+lB7ulJk6yaagBplesBY/mHhhHjo7l5wDLRmwkE9YKEByTCv51bdTLWI1jw27aaLl4h6Pfaou3Ha1U63NdWcX9CtcnpYrA1Broccp2l1D0szZqy3lXaHeEcrznCEWNvfXfj9gacfjuigfjim94/+L8zEuEbns9pBKGlyJU2wi+PJZH9Sdvn7txuJdQwwnoFs5Oin/Kd72vbcpOzgDMyrpqxTOrexy+3NHQJ3l6LF5q9cG/skxAV7AkDpZW9elF4exBPPdvthq04cxIkWPeeC2249puBbnY76zwdXY9/n6QvyRY8ar28B1YK7scy6zjoLpMvQ/S6vbmdvZ3+en9FB+fvkzcU5HdD3707+dTK78E/3dbQuY/DlPpkys/TJK30mr1/lO1Wo7XCOUBB2Xxs3Rdt3cHsrWcaTQ9sznBPmSrCDhvHyQiLOkheo2bP5mVV+uQ7NXzfOfkqFZS18QIvL7rAUZ/SKuZrhtv3s77TrgBDlacgCr7vi/BuWfs07kDqj3NEMjGFL8Bb+pBJLwCcFP9da6T3Of+zIUOVbLCKV9eXvBlLqoX/Zhz5zQRwgIADHyv+v0voBdOK0D5x3O/oGmAZ94uyKTu/u8Q1XBnalsJjAQY5/X4d7dFy/YkQUel2+wHNaRMUKy/nIN2h157ZXO934HVJOH8kpwpOTqxlF+iV7N6iforSMmKzERYrl+zvvxx6IDoofv5bO+nFjvU5Q79f127vzULpGJd+BlqRaDjm9fq6LNnTfer1Vk1Xr1Quceimq9qq16tVIdLIu4Kq16DVCTLpd1RVb9615fLyxPyaPd+PBdU2oMWaO5ImGxNFqY74brTenn/VGPCyME2I13YvUEA3kYoWFmRrWo83JU1ipxkPhsZ3ba0SdKT02gapMnty3mvxJR/s96WiJI7uL0w89nhy/Hk5+Hh7/cnv00/Sno+nx30aTn4/+bLaHd5N7TG5yobxrFH5feBi61HPOh67MEzAFMAYtlvig1XTs2J0hY1z4XL9Q/6g3MLeHOR2d0qPR0eR4NCmn3BmTkasVjeCh7mpXx87v//lCEV7wEWdO3FcGXhe7Iha2PrdYYZyc3tHdbs4MvNfi8RGXw+cLGCFTbnBym9LpggkDTwj7rT9u6JTlE2z3PrgoajLqI/CaaY4M+4wQrBgN9W5XHD0N/A5vEXt9di/JPQ7KEydJArl9EjbOPFeXN7cYyIuPLDKV+pacbdC12Qb5DK6ppM8Pfm1HBZNL53MiDTgx7LNm1mhlCS9VWQjLbcThbhcgbtUnkI+PtNSbxWf6iM3vfwEBooA+ sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new pipeline in a user context. Append `?workspaceId` to create the pi id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-token.RequestSchema.json b/platform-api-docs/docs/create-token.RequestSchema.json new file mode 100644 index 000000000..86de9a7f5 --- /dev/null +++ b/platform-api-docs/docs/create-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Access token create request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"title":"CreateAccessTokenRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-token.StatusCodes.json b/platform-api-docs/docs/create-token.StatusCodes.json new file mode 100644 index 000000000..c8f55e8b8 --- /dev/null +++ b/platform-api-docs/docs/create-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accessKey":{"type":"string"},"token":{"required":["name"],"type":"object","properties":{"basicAuth":{"type":"string","deprecated":true},"id":{"type":"integer","format":"int64","nullable":true},"name":{"maxLength":50,"minLength":1,"type":"string"},"lastUsed":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"}},"title":"AccessToken"}},"title":"CreateAccessTokenResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicated element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-token.api.mdx b/platform-api-docs/docs/create-token.api.mdx index d36dd3b55..5c1342cac 100644 --- a/platform-api-docs/docs/create-token.api.mdx +++ b/platform-api-docs/docs/create-token.api.mdx @@ -5,9 +5,9 @@ description: "Creates an API access token with the details in the given request sidebar_label: "Create token" hide_title: true hide_table_of_contents: true -api: eJzNVU1P4zAQ/SuRz6Etu7ASPS2wrIRYCcTHqeLgJkNrcOxgTyhVlP++M3bShrYCtOKwl6rxvJl5M/M8rgXKmRfjiUD7BMaL+1Tk4DOnSlTWiLE4dSARfCJNcnx1nsgsA++TgE4WCucJziHJAaXSPlEmfM7UC1kdPFfgMZnafDkQqbAlOMlRz/NV3FuOQ7YWe0JQMa43KBz3c2bBrwtOrpk1CAbZTZalVlnIMXz07FsLn82hkPwPlyVQNDt9hIwdS8eMUIFnq5EF9FAenTIz0TSpQIUaVowjmcD7uuXQMIoJKQdUGroKwoEvrfEx+rfRaLuuy4uvox/ncgHLHTWkcbhsWbOcxIpp3u8HnkqvsuMK59uBWSqlA2LcK1vlPaCi2mbgCPlgXSExHv04oANTaS2n3NjWsRtAIV//gJlxwsNRKgplus/9dLsyLT3eech3sVvlzInhHiqKTx78EUf5aaeeCHrj/0gccfysDsId7BLAicz/Rcj9IRaUT84+MccO+K7Ez5yzbov59x3S7e5yYiwmUmu7ID4BfbSN/lXFciBPQEPBRf6n5ZLRQ1Y5hXSRJrU4AenARflP7htKWwDOLS+w0oaplZJtYtjuT/Z3L+B8cK+cJtscsfTj4VCWapBpW+UDD8/Uv4GyYnPd3gRLcqUlshKTU8bz5hWcvON2w82JhfYZrmrljEwlwOh7GkB0Ev/87jT+uMDQEG769XoFn73KotSwXou9C6fMgw2Z2h62hJnhR7VwZxRdkBbMApBZEMDbPvW7QxpQOqyNB/tzbSAi3OSYZ39wdDgY8RnPpJCmRzzey/h2bBKs1xr8wmeuHQHCKw5LLZVhYqHAuhVL/7Gds4ropK5p0cKd003DxxTSsQLp74t0Ki5KEiA5gMxplKyuJ9724jTWsHfLeRmuK86/daeatPPgLVXiu9i+0K8ub25ZOu3bXNicfZxc8LtNv2MRHnf2DooMZzVtZjOrwhUUMSYLTb7V6YYuQ1WtSZpljyG1JyDCaqUWpW0pca7NPQX/C+u7CPk= +api: eJzNVU1v2zAM/SsGz2qS7guYT2u7DRg2YMXanYIcGJtN1MmSK9FNA0P/faDkNG5TrMPQw2629Ci+Rz5RPTCuApRzYPeLbICFgppC5XXL2lko4cwTMoUCbXFy/qXAqqIQioQuNprXBa+pqIlRm1Bom35X+pZs4emmo8DF0tXbCShwLXmUU7/U9+deyjmgYMCeunoLZf+Iwsk4Z5XidoeDgspZJssShm1rdJVyTK+DxPYQqjU1KF+8bQlKcMtrqiSw9cKINQXZtdjQCBXYa7uCGBWwZkP3jDOZxPvHwCEKSghpTzWU7DtKC6F1NuTTX81mh7q+f305+rkvX2n7hAaVmys7e5bzrHihnjl4iUFXJx2vDw8Wq7SeKuSRbF2PgNoyrciDgivnG+S89O4NKLCdMbiUwg6BuwY0ePeN7EoSvp0paLTd/R6rQ2UGA/8MVD/F7j5njUxHrBuSCPnJrfzroJEJRu1/zhy5/eKOqODNUwY4xfpfjDxuYkMh4Oov+rgD/tHin7x3/oD56yesu7vLhXVcoDFuQzUk9PtD9Mcuy6G6IEONiPxP5UYFgarOa95COe/hlNCTz/afL+JCQUO8djLAWpe61qLswXSYnxLvb8mHFN55AyWsmdtQTqfY6kllXFdPAt2Qx4l28HjcXqSd4twgixOLM8HL5AVJvuN2IcXJQscM77VKRqGSYFDCMoFADR+fdx6/3nAqiBT9x34Ef7rDpjW0H4ujC6ftlUuZhhoOhIXhc1qkMrqiMIDFAFglAzys07g61KA2aWxcuQ/7jahAipzzHE+OZ68mM1mUpjRoR8zzxcyPx2OG/d6EL/jODT1guuNpa1BbIZYU9oNbxq/tWmxUzqHvlxjopzcxyvJNR14suFBwi17nSTlfRAVrwpp8stcvGfdwljUcXUpegZtO8h9cqqh2ETKmWv4jduz08+8Xl+Kd4XFuXC0xHjfycOMGSkivu0QnS6a1HgzaVZfuIOQzxWn40KiPjJlUDVtotyOGfZ8RabbGCGqQkvsaFzHG35DnCR4= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates an API access token with the details in the given request body. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-trace.ParamsDetails.json b/platform-api-docs/docs/create-trace.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/create-trace.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-trace.RequestSchema.json b/platform-api-docs/docs/create-trace.RequestSchema.json new file mode 100644 index 000000000..aec24bb98 --- /dev/null +++ b/platform-api-docs/docs/create-trace.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Trace create request","content":{"application/json":{"schema":{"type":"object","properties":{"launchId":{"type":"string","deprecated":true},"sessionId":{"type":"string"},"runName":{"type":"string"},"projectName":{"type":"string"},"repository":{"type":"string"},"workflowId":{"type":"string"}},"title":"TraceCreateRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-trace.StatusCodes.json b/platform-api-docs/docs/create-trace.StatusCodes.json new file mode 100644 index 000000000..08c043aae --- /dev/null +++ b/platform-api-docs/docs/create-trace.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"workflowId":{"type":"string"}},"title":"TraceCreateResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-trace.api.mdx b/platform-api-docs/docs/create-trace.api.mdx index 730969c61..d3e9c144a 100644 --- a/platform-api-docs/docs/create-trace.api.mdx +++ b/platform-api-docs/docs/create-trace.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new workflow execution trace." sidebar_label: "Create workflow execution trace" hide_title: true hide_table_of_contents: true -api: eJytVU1PGzEQ/Ssrn9OEtrRScyogKqFKBUGqHhAHxztJDBvbjL2EaLX/vTP2bnbzAaiolyjr+fCbN/PGlQhy7sX4VgSUCsTdQOTgFWoXtDViLM4QZACfyczAKltZfJgVdpXBM6iSXbIYNxQDYR2g5KOLfBM3iUkHwkmUSwiAfFUlDH2QD2fzjjwoYiA0X/dYAq7FLog/rWNmyiWgVpnOwQQ904Dk7NUCllKMKxHWjhNrE2AeTTOLSxnS0ddjUddUIALd4sOpzdccs31VRJypiD5rPCmPspTSBPaXzhVaxUpH956Dqn0EdnoPigMdMi9Bg2drIUujFkzQxtMH1GYeS3YIlBfIGrCEmgoD7xtCd/3JiqX5FYk8YKNrGcCLdgRnvQ4W1wfNbZ8P3kz2oEMBLVup1dcNV3VdJ4o19ipB8M4an1j4dHS0T/zlz/9H85J4k/PDlb+rtASeayOP40PwT2X+nnHpiLrdoKYRfW95PfzniBb3kH8+QHyr28zYkMmCuCE8dRw/VaIO66jZU5AIeFKGBX3esY5I0AvLWqdRiiAl28QoboRRkhCrE/CpFX6JBXksQnB+PBpJp4eqsGU+9PBIIIba7kn/Jlqyq0IG1nJ2xv7ZydWFYAgtwhsmNJHTx7nhh29sFwV/T6MTnaQ/P9otcb8KsXJu1HW3Js6f5dIVkfCeJDvpbpTYHW0JsOfZ01132p/J3qhqM7OxiKalDRdc/Fs0Mela0d5OzjyPUsV53G5Bn3gaSV3EVTmz3zsDAeH+pXs+Dr99GR7FDUNNX8o4zs06T2J58Y3YxVx1KvmHV6ZpaIDnMHKFpEeDsMSaqmYA26eMqk4jSHOy4AklS1VNpYffWNQ1H6fXhgcz115OC9bhTBYeXoH6xlt0EN8DrPeeuydZlOwZ5/hJoub7o7QILsicsjGwFHqWrv8w4exd7N5uqQdtxIlS4MKrvn0JX13eTFgOzZu4tDnHoFzxzNIv4eQXnqOjyuIZv2dmXsZVJFJOFo/c1t6O1mJVjUmadQ8hNSd6TOwDGGpQy1vgb4JLyf8CTtoC+Q== +api: eJytVcFu4zgM/RWDZ23SzhR78GnbYhYoBtgW0y72UOTAykyi1pZUSm4aGPr3BWU7cZvMDKaYmy2S4uMTH9lBxFWA8h4ioyZYKKgoaDY+GmehhEsmjBQKLCxtio3jp2XtNgW9km7FpchxM1DgPDHK0VW1i7vLlyrwyNhQJJZUHVhsCEqQ24JHTVcVKDCS7rkl3sJ7EP+NjoVtG2KjC1ORjWZpiEFB0GtqEMoO4tbLxcZGWmXT0nGDsT/68wxSWihgem4pxAtXbSXmbaqMuNAZfTF4ggLtbCQbxR+9r43Olc4fgwR1hwjcwyNpCfQsvERDQaw1tlavhaCdZ4hs7CqX7Jk0RqqgjNxSUhAohIHQ9/5JAbf2n0zkEZtnJwC+a2fyLpjoeHvUPL7z0cxJQTSxppGt/qm/DVyllHqKDU8qYQre2dCz8Onk5JD466+/j+aGQsDV8co/VFoPXmpLCs6Owb/A6iPtsifqfod6oT5c3gT/F2bHB8g/HyF+1G1hXSywrt2GqnxVIN2yidus2QtCJj5v4xrK+4XoqKG4dqJ173LRHsUG8zwR5r2ERJ3EL6PwW66hhHWMPpTzOXoz07Vrq1mgZ2KcGXcg/dtsKW5qjKLl4lL8i/ObKxAII8JbIbQnZ4pzx49kHAeF/D9kJ1DDx9/jlHjcxFy5PNS3/Zj48oqNrzPhE0nupbtT4v7ojQAnnhPd7U+nPTlpVWOXLhcxPOnAhRT/M5qEdKMpDM7Sj6hzP759ginx1KCp86hcur/2hqRA3q/Pczo7Pfk0O8kjxoXYYO7nYZ73avnukngPutvL5BfWzPCikV7j3NdorGDJRXVDB467TMHQgwsFa2nR8h667gED/ct1SnLcrxvpzMoEfKhFiEusA/0A6k+W0VF8T7Q92HcvWLfimRv5BdlI/qwtBWvCijgD60Mv+/R/3Mnt+9iD4ZLUGHGuNfn4Q9+phm+ub+9ED8NSbFwlMYwbaVrcCE5Z8RKdZZbPZKHZVZtnEfR3inrwrfjeiS1XNZjQbicIu673uHNPZFOCkbco/5AWKaX/AdQ/Ax4= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new workflow execution trace. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-workflow-launch.ParamsDetails.json b/platform-api-docs/docs/create-workflow-launch.ParamsDetails.json new file mode 100644 index 000000000..fd16b7347 --- /dev/null +++ b/platform-api-docs/docs/create-workflow-launch.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"sourceWorkspaceId","in":"query","description":"Source workspace numeric identifier","required":false,"schema":{"type":"integer","format":"int64","nullable":true}}]} diff --git a/platform-api-docs/docs/create-workflow-launch.RequestSchema.json b/platform-api-docs/docs/create-workflow-launch.RequestSchema.json new file mode 100644 index 000000000..6b4e7e2e6 --- /dev/null +++ b/platform-api-docs/docs/create-workflow-launch.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Workflow launch request","content":{"application/json":{"schema":{"type":"object","properties":{"launch":{"type":"object","properties":{"id":{"type":"string","description":"Launch configuration identifier."},"computeEnvId":{"type":"string","description":"Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted."},"runName":{"type":"string","description":"Custom run name for the workflow execution."},"pipeline":{"type":"string","description":"Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)."},"workDir":{"type":"string","description":"Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted."},"revision":{"type":"string","description":"Git revision, branch, or tag to use."},"sessionId":{"type":"string","description":"Nextflow session identifier for resuming failed runs."},"configProfiles":{"type":"array","items":{"type":"string"},"description":"Array of Nextflow configuration profile names to apply."},"userSecrets":{"type":"array","items":{"type":"string"},"description":"Array of user secrets to make available to the pipeline."},"workspaceSecrets":{"type":"array","items":{"type":"string"},"description":"Array of workspace secrets to make available to the pipeline."},"configText":{"type":"string","description":"Nextflow configuration as text (overrides config files)."},"towerConfig":{"type":"string","description":"Platform-specific configuration options."},"paramsText":{"type":"string","description":"Pipeline parameters in JSON or YAML format."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"mainScript":{"type":"string","description":"Alternative main script filename. Default: `main.nf`."},"entryName":{"type":"string","description":"Workflow entry point name when using Nextflow DSL2."},"schemaName":{"type":"string","description":"Name of the pipeline schema to use."},"resume":{"type":"boolean","description":"Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)."},"pullLatest":{"type":"boolean","description":"Pull the latest version of the pipeline from the repository."},"stubRun":{"type":"boolean","description":"Execute a stub run for testing (processes return dummy results)."},"optimizationId":{"type":"string","description":"Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"optimizationTargets":{"type":"string","description":"Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to each pipeline run."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"launchContainer":{"type":"string","description":"Container image to use for the Nextflow launcher."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the launch configuration was created."}},"title":"WorkflowLaunchRequest"}},"title":"SubmitWorkflowLaunchRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-workflow-launch.StatusCodes.json b/platform-api-docs/docs/create-workflow-launch.StatusCodes.json new file mode 100644 index 000000000..831a0c581 --- /dev/null +++ b/platform-api-docs/docs/create-workflow-launch.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"}},"title":"SubmitWorkflowLaunchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/create-workflow-launch.api.mdx b/platform-api-docs/docs/create-workflow-launch.api.mdx index 14c2eb498..2d50cbe16 100644 --- a/platform-api-docs/docs/create-workflow-launch.api.mdx +++ b/platform-api-docs/docs/create-workflow-launch.api.mdx @@ -5,9 +5,9 @@ description: "Submits a workflow execution." sidebar_label: "Launch workflow" hide_title: true hide_table_of_contents: true -api: eJzFWG1v2zYQ/iuE+iUD4pek7brm09IkG7KlTRCnKLYgQGjpZLORRJWk7HqG//vuSL1QlhM7RbB9SSzyeHc83j33sgwMn+jg6DaYS/UQJ3Kug7v9IAIdKpEbIbPgKBgV41QYzTiriBh8h7Cg7X6wH8gcFKeP8wipTxRwA19KygteZOEUiXKueAoGFElbBhl+IDEx1DkPAY/uB4KkfStALYJ1Hb5UhCwrUlAiZCKCzIhYgEJiHU4h5cHRMjCLnBiLzMDEbsVSpdy4pZ/fBKvVfi1dy0KF8GVXHUaWnM2fVkXBt0IoQFPEPNHwHN32g6xIEj5OkMqoAlarO8cPtPkgowXx6JrFPkhi7cxKYuQUSpSSGTrC8zwRoX2hwVdN55ZdpeT4K4R0MFf0nkaApl3HdzudiDwabZTIJh37OV9gqFksJoVzGc92/WBFaqd5YeAsm53vwPHEUTPIZkLJLEVWHkM2n4ICZqbAcpFDIjJ8PJEkTBVZn51CzIsE3dpI70lzJVKuFizcxDlmEgPBQGRVRS6frB9t1bLQRqYklZHjMXx1q9SmaEK+la7bGV9Vt1KQSy2MRMU/X1+wPehP+vvsfmpMro8Gg4kw02LcxzsNMvhuSGZPyMEUkkTe/2SFki6nQm2XSR7HInTw0IrLuZmWdq6vQ/6tUogE4gCLRQIIHbiPRsCwaBt+k5nnbQnrVoeZ0MI58dOa/i4Mq6j32VhxdL59RrbnE5JdaLAcNWhdgtc2lp9K67HyjO9s9KoKdJHiQRZzvHZET65Ltyafv1LSmsMTxJXihDTCQKq7CqzWNTgmeiZjVqvSDqfcibCOZi1Mwb+wOuB91QhCBeZFFCB2aAfLjwSl/AEYn+HFCcBoxQ+82slsmL2gGk3oPk8XZ7YbtOIznr1ta46ycIftyRkoha6gSwLn9C6wjJyDOrHLOwR0wg3lhJ7OIUS3CtckSkvoXMomVL3bBWqgaLIwRin7Y3T5iQLir+OPF8zlIsdawXWRjSyD7cyPowhLA7eCduamxDOwMsjwWdwr81NJhShLcSiRYCYfKGBqE6MDhxhcoPtsBMBurxA5eBYxBDjTIwh1LPTdXoVukQx1X8M3LEL6iGp5ZcMwkUU0cIIHPJph/EP0Cu/WQ369il+v5Odei1Zf5uo8RiszjtmmezU25TOw2JcA4dr/cdOUi92vmeBdMnRB1JrOVTcmNyegqTH9iN3Tfj+L760QBEe12C1J1pWMPYNGwCzi0iVmlwzRpuUlp6OLQwfeto7ZTQRREWS0CgLHwM8HFsR9dmMpE+BZh99ZZtHF0RMH/GW4MhsSO4sVVgAkOOHaMF2E5AlxkVROUfrAtePlVdr4cM90gJDjlXpOq1fuX4/3KobkCaWvY615gSlamx3ueoXEpf50giHi2QS4bs76nk1J4t7JFGMMrF2s6iKI4grP2KrJFkwolVxgr4kiRPtCZSwq0nRhXyGpnJtwMhX/1E3JNs+49Ogfr0/LMG2KLtc/MF/arm9VGaznHx5QIpkJmHdvccPVpJ0xHy+JU97TQEiP2MISga+Fr+QzwwrIcvvPb4TpGJLzaJfE/3gD92gpYLmz81NX92CBNsnoF2A8NA5KtT/xmAKP/pDjk7zYLvX1YRdLinSM+I5ST64+a8J5GVp7V8V9DVUkiH2VY1/qR0gxMD6Of0SyO1tJtNjymEjKvylM+HiB0VM+AEEEliMGYRp2KPdrUoZ90QRKnOyKdIzLJi5CS7gxwMbYqy9IdD10FuiIvcFFxNI0d+jvgGdD9zjHGix0kvrU2gdGGOqeg/b84bpsi30KN9V4jG7lN/K2F7eJIcfqy9Xvh8Nhtx2//PPlOu8KsDfh1/Z7OE3pIkj6ZpOuH9BHfmBc0FjlNsA30ugUNDF6+i4V4ZMXOVNKqo7mrzdYuZo3sUwaGwhz1GdlW7mwUMIs7IjpA2DXqY4LM8XPOxqlYOU7lTSjopLIzqRoLxhUpi4zKM2TELWqUVWhEiSqQJDnom8Br0HC7qDI7rCqmmcnRM+Or84D0qJSckQ2dfbxVa1NRBKr0ZZNmJYIV9yP36oo+jp3jk1vdd0Mi86+c6ov20McGtM0gdgetjTr9WSjWWqGEs1aPTPwTtbdebPm9de+6HZDfFtt3a01qv5Gt3/0d/2OrhHU6r+8+3jdk7faany89XZb0Gz4VXSz6pW9nhm8StU3mCs2CWLaJZlbqesm97le2DSMNhYLzXaTeW+Hd2vZb7ghLw035AovR/gAj1B4+KY3fNc7fH9z8Pbo7cHR4S/94buDv61XiiyW1qkruHKxQcGwLWwoCAXWeiUxQRQPLUS1Q9IPRDSxSGzujOWvzQYqUlasuHfQf/+2P6zavZRbhCtHwuWMskKEdR2XDVBuHYuXYUwjAqqVRGaHMKT5skSeZuoeVOYmR54SOuHmcjnmGj6rZLWiZTeUJkSKhKbOoxkxP6rjlrH5RhUfYNGZzM94UhBlQNPz3cXvNjF/QotNE/pGlzv6UMINzBHinR+Tq6KRHIMTp0vvhmQ0Zzs5ju7lThxja5abJ2n9VHJ1ObohTC7H86mM6Izi9KT0F/V0wYlZzeZPWiNIziaFTYmB40mxwtsJYA3w7a2qqjlbeBqio1iKG/kAGTpLZT1D36guMv8XirgtZg== +api: eJztWVtvG7cS/isD9iUJdLObXo6e6jhu4dZJDFtBcKoYELU7khjvkhteJKuC/nsx5HJ3dbGlFMY5D+e8JBY5nBkOZ7657IpZPjWsP2QLpe8nmVoYdtdiKZpEi8IKJVmf3bpxLqwBDpEI8AETR9udz/KzfPVqoGCo0bgc717MrC1Mv9tNVWI6Br+i5h2hukXG7UTpvJ1kyqXdjDuZzLoJT2bYDke/C/+1eTvKaWsnXzbkvnrVh1+FNrYFGq0WOEewM4TADBIlJ2LqNCfNwBkhpzAc/XYxgG7k0F3Fvy7TdanE6LDOvBDdYJQx1tqF4y87MJihhFylYrL0+mg0hZIGYbwEg9aSIiM69lboEVjlieY8cwgTrXIYhZvTbot+zIURSj5Bea7yXNjLdNQCLtO46g+MrHY46kB4NX/eayYwhYIvM8XTwFcYQJkWSkhLC4GFp48X7HyWrMVUgcGilynrs3ON3OKnkuLKW4C1WME1z9GiJmdaMclzZH3vVKbgCV6mrMUEOdNXh3rJtl3sUyQE6XLUIgGRorSktWYtZpIZ5pz1V8wuC2IspMWp36Ln4TYs/fiardetSrpRTif46Vgdbj05LJ5WReNXJzSmrD/hmcFv0a3FpMsyPs6Q9emR1uu7wA+NfaPSJfHYNYuPt9LBS2LWYomSFqWlI7woMpH4F+p+MXRutauUGn/BhA4Wmt7TCjS0G/gephNpg8ZYLeR0x35X+4Kwtl2HrUntvHAWL+T88giO54EaUM6FVjJHaRsMYTFDHRy2EAVmQiIsRJaBdrIDb3HCXWYNuXb9pIUWOddLSPZxnoDKhbWYelW1k++9Hx3U0hmrcpIK5HgwUXojihpgSXyjrocZX8dbaSyUEVbpJXy8uYIX2Jl2WjCKoDUVdubGnUTlXYkP1kOTUN0ZZpkavfRCS+w5LJM8DlKhMfHiCm5npZ2r65B/6xxTwS3CRGRogGsEY5XGdNPw+8y82JSwbfUS+w5r+puwEKlbMNZcJrMWkO35lGQ7g56jQWNK8DrE8n1pPSjPNJ2NXtVDJGH5hIsMU3pyU7o1+fy1Vt4cDUFca05IIyzmZleB9bYGZ0QPagKVKpvhVAQR3tG8hSn4l14HZ1DfYqLRPosCxA5M4EeCcn6PwOdceACLmSk6c+VkPsyeUY06dL9Nl2C2AT7Yb3j2TVtzAxYfLLxQc9RapGhKguD0IbCsWqA+98tHBHQsJ0yBiZiIZEui8oTBpXxCNcddoAKKOguDkPD77Yf3FBD/Pnt3BSEXBdYab5y89QwOMz9LU+AQVsDOuC3xDL0MMryclJVQpCq0oDhUIORc3VPAVCYutErQGDQduEWE4bVGX8EUyliq9koW5hvLSJ7OuUww/a7Q2OYybUd+7ZJfeC1afZ6r84lFDTzL9lwNZnyOHvsyJFz7b9w05+L4a2YWteRWzBHoXLwxuTkBTYXpfRjRfkdORl4ISquXxyXJqpLxZyBUnT5dLqh2DrV6Zcq3t1enAbx9HXOcCKIiyNgoCAKDZj4IdW6D3VipDLnc4XchPbrEuthXyJZruyexh9o8dCLGgnEJecLEZdEpSh+4CbwajZR28vk7puDrLsuuuKVy8fBdr12WlfrTCZij9glw25zVPeuSJLyTdeMbJ4+xaoggiivrxr5q8gUTGt8lvaijSKN1WkLq8nzpXyGLzk04mYu/qqbkkGd8aNA/Xp+WYVoXXaF/gKa0Y98qGqzdPNylRDIXuNi9xYDr6WbGfLwkznnbICG9xRQyYSy9UpMZ2MDtP36jjI8xu0yPSfyPN3CPlgKeO1y+DXWPMWIq6S/kyax2UKr9iccMefq7Gp8X7rDU7093scTlY9Qk9fz6oyGcV4m3dyzuK6giQfBFjZtS32Gu9PLd+J9IDmejRI8tj4mk/JvjlI+XFk35AAQR50paLiQeUe5XpCByPsUSJ3dFBsZlE5dyi2EMsDf2qgsSXduKHHfEDkROWJoXAf0fHeEsuIEkSOpQa8+ssNQ9s835w03ZFjcpwvjjMbp1s5H3vbhPDH5o4x3mtNfbbcc//PF8nXc9htpTDh+8R9CULrJusdf7dH3D038yLqitMmQ5GsOnSAPBp+8SCZ+8yIXWSu9o/v0eK8d5E0hlfSAsMPWsDCZOC7v0I6Y3yDXqM2dnrD+8o1FKjnamaEZFJZGfSdEeq2d/WZxWGdTzOKpyOmN9FkGQF6LjAa9Gwt1Bkd+BWM3DOdHD2fUlIy2ikrdk02CfpqqViUhiHG35hOmJWKv849cYRV8WwbHprW7qYdHFA6f6cnOIQ2OaOhA3hy31ejXZqJfqoUS9Vs0MGier7rxea/TXTdGbDfEwbt1tNarNjd3+sbnb7OhqQRv9V+M+je6psbrR+DTWN9uCeqNZRderjbK3YYZGpdo0WCg2CWI2S7KwUtVN4ed2YVMz2lss1Nt15h327rayX29PXurtyRWNHNEEeHbaO33d7v3UPv3X4OSH/g8n/dOfO72fTv70XinkRHmnjnAVYoOC4VDYUBCKBE1JTBDFEw9RmyHZDETMuch87pyoX+qNdYuVFSvrs5POSe+004v9Xs49xJUz4XJIGSFhW8lVjZT//+zxv/3Zo4RpGgGRQYT0QzbyzFWZWeqPZiyGEwHVjLJPf8hWqzE3+FFn6zUth48OlHFSYaizrD8hPOqCBz6L7FXxHpc7X168JVmfMfo6crz4476IPKHFvi8wtS539EOL8EFkeFfWzwRFw1XJ4Dzo0h6QjPrsTg1D9wonzpIEC/skbbNUuP5wO6CcW35+yVVKZzSnJ6V/+6wEXyV9KvdrlHLl1PmShwWehIV8M8FvJXR/q9gVyWVDw9UqUAzUPcr1mkXrWfrN1nfr9fpvFeuP0g== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + Submits a workflow execution. +**To [resume](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run) a workflow**: First, retrieve the launch configuration using [`GET /workflow/{workflowId}/launch`](https://docs.seqera.io/platform-api/describe-workflow-launch). Then modify the response by setting `workDir` to the value from `resumeDir`, `revision` to the value from `resumeCommitId`, and `resume` to `true`. Submit the modified payload to this endpoint to resume the workflow. + + + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-workflow-star.ParamsDetails.json b/platform-api-docs/docs/create-workflow-star.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/create-workflow-star.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-workflow-star.RequestSchema.json b/platform-api-docs/docs/create-workflow-star.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/create-workflow-star.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/create-workflow-star.StatusCodes.json b/platform-api-docs/docs/create-workflow-star.StatusCodes.json new file mode 100644 index 000000000..0c75e33c9 --- /dev/null +++ b/platform-api-docs/docs/create-workflow-star.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"}},"title":"CreateWorkflowStarResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"409":{"description":"Duplicated element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-workflow-star.api.mdx b/platform-api-docs/docs/create-workflow-star.api.mdx index 4f4da0bec..3a5d329d4 100644 --- a/platform-api-docs/docs/create-workflow-star.api.mdx +++ b/platform-api-docs/docs/create-workflow-star.api.mdx @@ -5,9 +5,9 @@ description: "Adds the workflow identified by the given `workflowId` to your lis sidebar_label: "Star workflow" hide_title: true hide_table_of_contents: true -api: eJzNVVFr2zAQ/itCTxuEONu6Qf20rNugDNbSbOyhFKrY51itbKmSnM6Y/PfeyXac1CGlD4M9JZG+0/fd3XeXhnuxcjy+5o/a3mdKPzp+M+EpuMRK46UuecznaeqYz4H1GCZTKL3MJKRsWYerlVxDyW57xHl6y7xmta4sU9J5pjPmvLAWI7ZMUz7h2oAVxHOeItOZBeHhTwdYYABCjLCiAA+WdDa8xB8IHZgQIkmmET7nz7X3byG7leVqUE4vW3ioJErisbcVTLhLcigEjxvua0MkbRDfbCZ7vM6IBAbihwpsfZA5AFlZFWBlss894pKlh1W4yrQthG+PPp0g+w1JdUaXDhxFvJ/N6GOf7+IHhiYaXyk93QpjlExCbaM7R5BmTKqXd5B4KrKlTnjZEuwU91AxuJdewcF+XXU6EUbAk9mHA0r7nrNSeyYUhmIPAvpkjP6JmExXZfqa9IbOXvMCnBMrIF8fz7oHHk35m7V6nOXpWPfXqhWIjgcFBcn+TxPAS5yvXNMEGu3CuzRLMY96I0TNYIlN5NrBdGDX/VRWViE+9964OIqEkdNE6SqdOnjAZk+lHs3HItywSyU8GZ6dEZ7NL885+d1BUlnp6wVVpM3uCwgLdl6Rsm2CxNhPE/1eBhCetF++96N09+hDFWSZ6RDeVaNTQbQvCaR0ZQKuA1MrRRJauZ/8bsrYTanCJGf683CBQqhyLc+76enH6YzOqPiFCE7otg2N1HZhPlfYDHb6pzu6K7WHvz4ySuDOQ60h56YzyvD3gfB4bzUHr2BDczIWAptmKRz8tmqzoeN2d5KDUunEUpHjM6EcHMn1hc16UO491KPlvRaqImQw3FpYSfyv1PLmqhvUt+zoX81BUd2hKOtdNbtiuzJubhCdg0jxLdLXAuZJAsbvhI5WCiW2He3Li8UvnIEnWQfGSg== +api: eJzNVdFq2zAU/RVxnzYwSdqVwfy0rNugDNbSbPShBKpY14la2XKl62TB+N/Hle04qUNKHwZ7SiId6Zxzde5NBSSXHuJ72Fj3lBq78TCPQKFPnC5I2xximCrlBa1QdBihFeakU41KLLZha6nXmIuHDnGlHgRZsbWlE0Z7EjYVnqRzqHa3+BFEYAt0knmuFMRw6VAS3rWAGUkHERTSyQwJHeusIJcZQgw9E0SgWWYhaQUvtXd3CU9O58teOd/s8LnUDhXE5EqMwCcrzCTEFdC2YJLmENR1dMDrC5lgT/xcotseZQ5AkZcZOp0ccg+4dE64DFupdZmkZunjBdT1nKX6wuYePZ84n0z445Dv+gdEkNicMCfelUVhdBJqO370DKmGpHbxiAlxkR2/BOmGYK+4x4oBpMng0fe6bXVCXTPwYvLhiNLuzUVuSUhj7AYVBPTFEP3Tkkhtmau32Otf9h4y9F4ukXN92nUHPGn5m3N26PLTUPfXshGISqDBjGX/pwbqCDKkleUOLKwP93IvxTDugjCu+kjUY980pke37rqydAZiWBEVPh6PZaFHibGlGnl8RidH2g76YxZ2xI2RxIEXl4wX05sr4Lx7TEqnaTvjijTuvqB06KYlK9sZZMaum/j3IoAgar9871rpcUOhCjpPbTjeVqNVwbSvCWS7OkHfgvkpZRKe8tD8vmXMpDahk1P7ud+oI+DKNTxno7PJ+WjCi1z9TIYotOOGe2o3MV9KrPo8/dMh3daa8A+NCyN1zlqD6apNSv//ARHEB7M5hGUewYqTFd9DVS2kx9/O1DUvN8OTI6S0lwvDkU+l8XjC6yuj9ajcJ9wOpvdampKRIXFr6TTzv1HLu9u2U9+Lk/81R0W1izLf7qvZF9uWsZ7XEaxQKnRBXwOYJgkWtHd0MFPY2K63b65nv6Cu/wKhpcZv sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds the workflow identified by the given `workflowId` to your list of starred w id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-workspace-participant.ParamsDetails.json b/platform-api-docs/docs/create-workspace-participant.ParamsDetails.json new file mode 100644 index 000000000..92b9288dd --- /dev/null +++ b/platform-api-docs/docs/create-workspace-participant.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-workspace-participant.RequestSchema.json b/platform-api-docs/docs/create-workspace-participant.RequestSchema.json new file mode 100644 index 000000000..598759415 --- /dev/null +++ b/platform-api-docs/docs/create-workspace-participant.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Participant details, including member or team identifier and workspace role.","content":{"application/json":{"schema":{"type":"object","properties":{"memberId":{"type":"integer","format":"int64","description":"Organization member numeric identifier to add as a workspace participant. Provide either `memberId` or `teamId`."},"teamId":{"type":"integer","format":"int64","description":"Team numeric identifier to add as a workspace participant. Provide either `memberId` or `teamId`."},"userNameOrEmail":{"type":"string","description":"Username or email address of the user to add as a workspace participant. Alternative to providing `memberId`."}},"title":"AddParticipantRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-workspace-participant.StatusCodes.json b/platform-api-docs/docs/create-workspace-participant.StatusCodes.json new file mode 100644 index 000000000..3c57495b7 --- /dev/null +++ b/platform-api-docs/docs/create-workspace-participant.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"participant":{"type":"object","description":"Workspace participant details.","properties":{"participantId":{"type":"integer","format":"int64","description":"Participant numeric identifier."},"memberId":{"type":"integer","format":"int64","description":"Organization member numeric identifier."},"userName":{"type":"string","description":"Participant username."},"firstName":{"type":"string","description":"Participant first name."},"lastName":{"type":"string","description":"Participant last name."},"email":{"type":"string","description":"Participant email address."},"orgRole":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole","description":"Participant role within the organization."},"teamId":{"type":"integer","format":"int64","description":"Team numeric identifier, if the participant is a team."},"teamName":{"type":"string","description":"Team name, if the participant is a team."},"wspRole":{"type":"string","description":"Participant role within the workspace."},"type":{"description":"Participant type.","type":"string","enum":["MEMBER","TEAM","COLLABORATOR"],"title":"ParticipantType"},"teamAvatarUrl":{"type":"string","description":"Team avatar URL, if the participant is a team."},"userAvatarUrl":{"type":"string","description":"User avatar URL, if the participant is a member."}},"title":"ParticipantResponseDto"}},"title":"AddParticipantResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-workspace-participant.api.mdx b/platform-api-docs/docs/create-workspace-participant.api.mdx index 0568420a7..2227fd7b8 100644 --- a/platform-api-docs/docs/create-workspace-participant.api.mdx +++ b/platform-api-docs/docs/create-workspace-participant.api.mdx @@ -5,9 +5,9 @@ description: "Adds a new participant to the workspace identified by the given `w sidebar_label: "Create workspace participant" hide_title: true hide_table_of_contents: true -api: eJzNWFFv4zYM/iuCnjYgTbLtNuDytLSXAcXapcil2ENRoIrNJGptyyfJTXOB//tIybGVJk3SYAXupbVlivpIfqTIrLgVM8N7d3yh9JPJRQSG37d4DCbSMrdSZbzH+3FsmGAZLFgutJWRzEVmmVXMzoHVO5mMIbNyKiFmk6X7NpPPkLGHWuQyfmizMX4I9UQiYxNgIHGHZvgis1g+y7gQCSsMLilcZRZE2uYtrnLQgoBdxgjtQoOw8O9a/02jFkXxEJGCBU0WrniGL7hF6RlubXFJpuXCzvlre4d6JjL53Z3CsiIFLaPGOE0oNHwrpAaEYHUBLW6iOaSC91bcLnM6RWYWZqBRdKp0Kqxf+uMTL8tWDSXwy15AtX0fgObebwdjz1W8pD2bZwcuZTFYIRPTwghFSRHLbMZSSCc+RBSgABcGMg64oVUCBDVSCAWjg+eIPE9k5LzceTR02GobuZo8QuSCqSnyViJB8as/lihw2Ma94a3wb/uV6C3imAmifmNHQNw2u9EKeVpT92GN6oH88UAOIcLzssX98ylox+TWj4ZHafYPcnKoBylGOMBprMYwb6G6xQ1EYtIEtIXAaDCGqanLfJe4R2DsJ5Y0WSwUJJ47yESsBm2bcoZbaRPwxSig5MhTFyXK12ngFkyuMuMp82u3u83u4d//HycDu3YJv5XS+XaCtffpPo1GYRrvKiLorY/PqQ2uHSZZiLmoCOdUTKU29v063DZWa0nEKUpoV6MDjkuXUMFGujgleCONVLITB6AT6XpWi8yFwbvWcTZJxEThVag03dgvZyR69iycl8xRe9YpNazO34ea6jdbYCGRmctvFQT8Yyoc3jK+lIQJIk3dClRnHhdBfwaKHqF1YfK3wnG8f+py54E6PfuuVpKgtH+LANeD6/PBCBfGg/41/rsYXl31z4ej/ng4CmMZ6ByTqspL/Wdhhb7VR3DVuUo4eXY7ujrCYZSb7ziA7o6jDvDE3Sz/G7XfV/cvVu29IbwUXREo9GnXLXAuYlY1Qe+5Dpr75g6TzBgxAxeKA52LF9xyU2jCQGult5D/tuP+WnfDLFOWiSRRC8TjpD9vS38pvDnYEiSQQvbDWosfDUSFlnbpWvdzEBo5VmBv3Lu7p54V+/q5ogkgL3yrT594B8uS6axci192mpmmswpa7bITMM10sBJzOk4/rweFgljM59bmptfpiFy2o0QVcdvAN/R2W6otSn91X9hNIiwVO3ZB8qx/c8kJ69qUr+RL75fQoNo1dCKvund6nzghXPEPf63L6OPCOv9RjEZN7z54EWnu61ZzlXebytzd0efV4aDxY6ocmCoqlU1kxCFzyXkS3VwJE6VE5Ci16crQgdXN6Y79s/mAQCgO/pxf2p9/b3dpLVfGpsIxspqd/OS3u618DXjVsPzHGmarwFt4sZ08ETgBUjn1RdRT+o66A4OivfXcGkzquLo5QobExleiNvJvjs4jTavVRBjAGl2WtIzE0ZRe+IhtgxQTCjvSP5aGnpExU5EY2OPLn0ZVTfiZHTEz7zS2WhTZkhOMpKA3fHyCZT2r08R8EqhDc/MJiEJ/l/coPgcRY5KS47zEhUdy5q7fRsNWcSWr/I5+FEFu98qGFe/mdkw1oZrWUxXTFi0W9EMA/nVglXOMKzVubYXdbjYrXCnmXiVVELFZgF4VHGfUTncgk5zEWD1Bhmxae8fSO/mlLP8DZ+Fn8w== +api: eJzNWFFv20YM/isHPm2AartdMWB+mpN6QLBmDlwHewgChNYx9qXSnXp3spsJ+u8D72RLrl3HCZahb5bEIz+SH3mkK/C4cDC8gbWxn12BKTm4TUCSS60qvDIahjCS0gkUmtaiQOtVqgrUXngj/JLE9qRQkrRX94qkmD+Gbwu1Ii3utiIX8q4nZkva0ZOiFnMSpPySrEAtlJZqpWSJmSgdWWGsQOEJ8x4kYAqyyMAuJAzh3BJ6+nuj/6pVCwkUaDEnT5Y9rEBjTjAEYxcXEhJQ7FqBfgnf+juxC9Tqn2BF6DInq9LWOcsoLH0plSUJQ29LSsClS8oRhhX4x4KtKO1pQRYSuDc2Rx9f/foe6jrZQunE5SigrX+vgOY2Hifnz4x85DO7tjshFZI8qswlQuk0K6XSC5FTPo8p4gR1cAnUssMNazJiqKnRnrRnO1gUmUpDlPsPjo1V+8jN/IHSkEzLmfeKHH+NZpkCT/t4NL0N/v24Mr1RSoFM/daPDnF74sqalZJb6t5tUN1xPO44IEx4qBOIv1+CdsZhfW14XGZ/YU4TO85RZR2czlulF3uorh1ZJjFrIj7CYCw5J8x9qPxQuCdgHGWeNXm1IhYvAmQmVou2xzUDXvmMYjPqUHIaqQs1i+yWQXjhCqNdpMy7wWCf3ZM//ztOdvw6JPy9ki72C6x3TPfLaNQt40NNpE7+h5ra4drTJOtiLhvCBRX3yjr/fB3hmNhqyfAlSvhUq4NOK5eugp1yCUqMXUxNdhAH6TLn69msdUhDDG3gbJbh3Fj0xvKN/fUNi75ZYYiSO+nMpqQmjf1jqLl/i7XyS6VDfZtOwl+nwyVCxVbSLRDltqNAY/O0DEYbmNMJWteu+F46To/Ptt1FoEHPsauVJbjsv0eAy/Hl2XgKCczGo0tI4Hzy8ePobDIdzSbTbi47OmesqonSaIUe7bU9gashVBjkxfX04wkB49p8hgG+O04yEIm72/53en/s7h+8OXpDRCm+IuoE3h+6Bc5QimYIes510N43N5CTc7igkIonJpcouBemrgtja43dQ/7LgftrMw0LbbzALDNrkhCkf9uX/lBGd0hQRjnpH9bbOgFHaWmVfwyj+xmhJTsq/RKGN7c8s+bkl4Y3gKKMoz5/gr6xC9evwohf99udpl91Ru2632Ga66Pk4duRXW0WhZJZDEvvCzfs97FQvTQzpew5+kIWe8rsUfpT+CKuMvTc7MQ5y4vR1QUw1o0rnziWMS5dh7ahYYvQTO/8PA9CkDQ//ti00Ye1D/HjHE3b2X38FfMi9q32Kh+0nXlwYM7bpoPXj3sTwDRZaXxiJ55yl4OnUnKNMFMK00Cp3VB2A9jcnMHs7+2HOgHOQ7Tztvd28K434JeFcT7HQMlmeYqr3+G58lvEVUvzH2ubbTLv6avvFxkqHfpp7KKR0zc8HjhIYLhZXDuregLD3R2yy2xIgLl9m8DSOM+aqmqOjq5tVtf8+ktJluvrNoEVWoVzzvtNBVI5/i1heI+ZoyOx/GnaNIWfxQlL80Fnm5eoH4FhZCU/QQKf6XG7rPPK/CJQTy3OL0DUjXd9WyewJJRkQ+CixHlE8ibcv62Gve7KXsUTozSlwh+V7ba8q+sZN4VmXc+N5CMW1/xPAK4jWBMCE3pNeFdBhnpRhl4MUSW3ENztQN90nODUwXBUVZSYmc+k63obHc/PHJe6/hcSumgY sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Adds a new participant to the workspace identified by the given `workspaceId`. T id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/create-workspace.ParamsDetails.json b/platform-api-docs/docs/create-workspace.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/create-workspace.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/create-workspace.RequestSchema.json b/platform-api-docs/docs/create-workspace.RequestSchema.json new file mode 100644 index 000000000..b0104e137 --- /dev/null +++ b/platform-api-docs/docs/create-workspace.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Workspace details to create.","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"description":"Workspace details to create, including name, full name, description, and visibility.","required":["fullName","name","visibility"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true,"description":"Workspace numeric identifier."},"name":{"maxLength":40,"pattern":"^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$","type":"string","description":"Unique workspace name within the organization. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters."},"fullName":{"maxLength":100,"type":"string","description":"Full display name for the workspace. Maximum 100 characters."},"description":{"maxLength":1000,"type":"string","description":"Optional description of the workspace. Maximum 1000 characters."},"visibility":{"description":"Workspace visibility setting. Accepts `PRIVATE` (only participants can access) or `SHARED` (all organization members can view).","type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was last updated."}},"title":"Workspace"}},"title":"CreateWorkspaceRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/create-workspace.StatusCodes.json b/platform-api-docs/docs/create-workspace.StatusCodes.json new file mode 100644 index 000000000..5c9e7f154 --- /dev/null +++ b/platform-api-docs/docs/create-workspace.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"description":"Details of the newly created workspace.","required":["fullName","name","visibility"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true,"description":"Workspace numeric identifier."},"name":{"maxLength":40,"pattern":"^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$","type":"string","description":"Unique workspace name within the organization. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters."},"fullName":{"maxLength":100,"type":"string","description":"Full display name for the workspace. Maximum 100 characters."},"description":{"maxLength":1000,"type":"string","description":"Optional description of the workspace. Maximum 1000 characters."},"visibility":{"description":"Workspace visibility setting. Accepts `PRIVATE` (only participants can access) or `SHARED` (all organization members can view).","type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was last updated."}},"title":"Workspace"}},"title":"CreateWorkspaceResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/create-workspace.api.mdx b/platform-api-docs/docs/create-workspace.api.mdx index bfc32d5a7..f4374def6 100644 --- a/platform-api-docs/docs/create-workspace.api.mdx +++ b/platform-api-docs/docs/create-workspace.api.mdx @@ -5,9 +5,9 @@ description: "Creates a new workspace in the organization identified by the give sidebar_label: "Create workspace" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/iuEsA8J4Nc0XRsDw+akKRZ0XYLE6YC62UJLZ5uJRKokFcf19N93R73bTtJ+2NAB+WBDIo/38tzdQ1Irz/KZ8QZjb6H0rYm5D8a7ankBGF+L2AolvYF3pIFbMIwzCQtWSjIhmZ0DU3rGpfjCSZqJAKQVUwEBmyzd9EzcgWTXKHUSXHfYCIc0fE7AWCFnLDGgmUDdiVURqvB5GC4ZDwJUwHFYMrWQKKKmTllpvOO1PBWDdlZPgtLLPwoBnI+55hFY0BThypP4gnLOEZwVFFrM7dxbj/e0HpBMItDCrwLTZJoiEBrQrtUJtDzjzyHi3mDl2WVMVoS0MAONolOlMbBs6Md9L02vsuUIwKEKlrSmab4MgQVguQgNs4r5Ljoy7StULS2t43EcImK0rntjaPFq0xM1uQHfEhyaALMCU4yzJZLf5EALk+6HSUCpIzxbbJqEYf5Y09LCzAXsThgxEaGwyyZmY49W/U75aGVpaXmVLBXg476L4GuQRtVohU9CKLL0UJjbcpzmnqGhiN//BnKGlTLY71FZWawp0vDnmLe/DNsfP30KrnZ+HtTe/h63/8Khn2pDu7urfuvF6/QHrwzPWI1AbtTfpRRYHrVGI0fYQtj5lo7rsPeJsWwCbK+932P+HIvep5pvMWO5ti4RgD9az3gYz3kRbl2WpHzsNqoujmbmy3gO0qAplsgARXylkQImYBeA7VwtdUiV6Wyi1e/1nor1LZVPIEwc8mUWJ2ZxrdXZe34voiRiqG/dckPbuvEnrZ+6Bx7WS3eTaur2Nxyo1e0jjVRJMQOWmK/Dhr4PsTXs+uz85MNwdHzNdpRE8kPaQh4UMZc4STnhKGjMLuXi+uLX4fnxGxRFnmwybwTRBJ1yK+4ELHY7WwoNMPfUf7lJHMkUup4TllrF+1BFRABj12fUWm+6UmHZcyTXtsL1chOFEQ5iKUYxW2BJNbFlCyT5jFoCB2fIjb2Mg3/THJlgSWYDbaZV5NXmUR9d21jOM+5GkXR9H3ADJlbSZDy11+ttFsXpu/+ExN/k1J1XM+7cWFo50s1t9JmXn3n5mZefefl/z8sZ8xIxo9T+Nu495EFx+fgWEq4zJAZh+AyeJsNCcAOtegzHWiu94fmLLbtGcddhUiF3hKFaoD9O+mAL+SdZOMAghIhi/E6jxUkDfqJdm+Id7RC4Bj1MiCjGV3RVwgvcXNH9LlYuae7GNvC62GOmu3KXubRbu72SQn1X3PkSHaLw3NrYDLpdHouOH6ok6Bj4jHh2hNoo0ws3w85Cbqmo2RHJs+HZiUfeFM5eEFpZ5HWXy+DJopdfC+l94oRwJHt4W7TLzcI6hCgL59Wl8Pge+ySEjS2eNthesQHWuq+k+YcItRyu02KNbRpsgueWvf1271V772DUfzl42R/sve70XvU/ems88LAgxSTkVDlI8uznyBKUT4FOKRSYzVzYbX6+K91mQutpxOoVoTtkTNUv1QRtBVgNmZ1+5+Blp0djVE0Rd5Wfo5mFX3HSupOrqoO+2y8iefVZuLdd3LmFpFAdZKu8ccb0/YO6ZFB8B2l++ZlTl6HUajXhBi51mKY0jN5p6lB8vONaZIc37C88IdAz1sKUh2b9KFeHbOc8p5Vd9hXfV7YGkg9yuaRC5mFCb/h4C8vyu056hYJz4Hg0cg5mc0eZG+0RaajWbvBg2ipWZIeAR2Xr5HR2ejGi7s4/6EQqoDWaL+h8jf/OT+VgcaThxlbYTXKWONr0Mp3UN7xJJWvU4aLaigSmzEmM1C1ITFsBjKV3AiZN/wEVW+df +api: eJztWG1v2zYQ/isEsQ8JINuym66tgKFL2xQLti5B4nRAXW85S2eLLUUqJBXH1fTfh6NkW35p037Y0AH5JlFH3j3P3T0UWXIHM8ujEZ9r89HmEKPl44AnaGMjcie04hF/aRAcWgZM4ZytLJlQzKXItJmBEp+ArJlIUDkxFZiwycJ/nolbVOxam9lpct1lwxSZwZsCrRNqxgqLhgnLoHA6AydikHLBIEkwYWAZKKbnCg3TU7/YynmXB1znaLzX02QV5R9LAx7wHAxk6NAQwpIryJBH3AfCAy4IWg4u5dt4z9qAVJGhEfEamCHXhEAYTHjkTIEBt3GKGfCo5G6RkxehHM7Q8IBPtcnA1UM/HvGqGtfT0boXOlnQnE33KwgsQQdCWuY0iz06ch1r5VA5mgd5LkXs4+x9sDS53I1ETz5g7IgOQ4Q5gZa+rpj8pgACJlQsi4RSR3wGbFpI2Ty2VgkYqITdCismQgq32ORsxGnW75SPoE5LwNe2VIBfjl0kX8N0wFUhJUwkLrP0OZj7clw1kUUlz+DuN1Qzl/LoKKSycg4NrfDnCDqfjjvv3r9PxgfPo9bb36POX+OD5z+1hg4Py37w6Gn1A1/Bs84INdupvyslbopWrXt62Vy4dE/Hddmbwjo2QTboHIUsTsFATDUfMOvAOJ8IVImfz0DmKSzhtm3JKgbFqLpAKJYu8hSVZdqwQiVobKwNWjZBN0dUrameqVU6N9nqh+F9WF9T+STC5hIWNc6pNlutzt7AnciKjPXDcNvzxmrbzu/1fuYfQLZLd1dq2v53AmjV7RcaaW3FLDpSvi47jmPMnWXX5xenb4+HJ9fsQCu5YDkYJ2KRg3LW5wTiGK09pFxcX/5yfHHy6podgJSbypthNkFTz7gVOD/s7ik0VEVG/de45AGvF/Q9Jxy1Cn+7RkQEg8NaWttNt1pw1XNk13HC9/ImC0ORoXWQ5Wyeotrkls3BNtKSeDolWHeVJ/+mO3LBitpHl1fVGvl682iPbm0sF7V284psNvcBP2BzrWytU4Mw3C2Ks1//ExF/1Uh3U80K53KxZHpzG33Q5QddftDlB13+3+tyrbwkzFXAj/Zp7wtIloePbxHhtkJmaC3M8H4xXBrusNXGcGKMNjuRP9qzayzPOkxpx0BKPceEe+tne8S/qOEgQ4kZYfxO0VYBtxgXxrfpqOQvEAya44KEYjSmo1KGLtV0vsu1T5o/sUW8p83M9kp/mKt6rdMrLWhul2e+wkge8dS53Ea9HuSiG0tdJF2LN2igK/ROmV76L+xcgqOiZi/Jnh2fn3KKZhnsJbFVI2+HvAJPHnlzLKT3iTfiQfPwetkuH+bOM0RZuFgfCk/uIMsl7mzxtMGGyw2w1X0rmf+coK6G27LYUpsNNeGDcHDUCZ90Bs+G/cfR4340eNoNn/Tf8S0d+LwhYRJqqj0lTfYbZonK+0inFIoYbWPsN7/Yl+5mQttpxAyE9D8ZU/3z+gNtBWhs7aff7YeDbkiDVE4Z+NJv6Kzxr0VpO8py3ULf7ZVIU34O71wvlyAUQfWclU3njOgChNokWl6EbF79pNRm0YiX5QQsXhlZVTR8U6ChFh0H/BaMqP/eRiVPhKXnhEdTkHb7X65N2cFFoyuH7CsuWPYCaQZBLaiSQRb0xgP+EReri51qXAU8RUjQ+ADrby/rMDpDWmE9d0cIq2A5o/4L+KJtW53Ozy6H1N7NjU6mE5pjYE4/2DCv49SeFq8afqzkEtSs8LrJ6zWpcWBTS7a0w6Pay0RZ1hZD/RFVVa2IcfROxFTVP2TN54Q= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a new workspace in the organization identified by the given `orgId`. The id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-action.ParamsDetails.json b/platform-api-docs/docs/delete-action.ParamsDetails.json new file mode 100644 index 000000000..68b0c8809 --- /dev/null +++ b/platform-api-docs/docs/delete-action.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"actionId","in":"path","description":"Action string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-action.RequestSchema.json b/platform-api-docs/docs/delete-action.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-action.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-action.StatusCodes.json b/platform-api-docs/docs/delete-action.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-action.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-action.api.mdx b/platform-api-docs/docs/delete-action.api.mdx index d19e1a06c..79190abf5 100644 --- a/platform-api-docs/docs/delete-action.api.mdx +++ b/platform-api-docs/docs/delete-action.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the pipeline action identified by the given `actionId`." sidebar_label: "Delete action" hide_title: true hide_table_of_contents: true -api: eJytVF1vEzEQ/CuWn0AKSYCCRJ5IaZAqEFRtEQ9VpDp3m5xb5+zaeynR6f47u/ZdPpqoFRJPd/aOPbPr2a0lqkWQoxupMtS2DHLakzmEzGvHazmSZ2AAIQgsQDjtwOgSREILnUOJeq4hF7N1RCz0Ckpxm+Ln+W1f9qR14FVab+4bRwAFnfJqSRueVdSypAWBuvME0CzCKSzkU2XpDhHQ63Kx1eIJ6OGh0h6ID30FPRmyApZKjmqJa8cE6ZBsmt6G89H6++BUBlvahwr8+oD3dwcUZbUEr7N97gMuXSIsYmhu/VJh2vp4QuxTlhocFR4Cn3g3POHPPt/Pb+KN+GFFZumiEmXTkyfD4SHuVOWCE4eAxNWhCaacMzqLTzC4C4ytd1Rua3UjlxCCWgC7oBVvZ3eQ8X3O8zuiTkI74LGKStRoeGvivfWXbX4UaaLy90cy7BwiSotCGWMfSQ/DA2SV17iO5jgF5cGPK/LC6GbKxSPnFJZdlUdXRT9xVA5aPw/qzkoNPw34Vee0yhvCFYgujAYD5XQ/M7bK+wEeSExf24N3v4oRcWEU8kOKL4wX44tzyVI6pVdc2FSkXb2bOjFj5xJezyKIdtLP184id48YK6DLuY3H26K2Kpj2JYGcrs6odxOYHUHV4Mv2k99NmUyhTXTo3H7eBkgIVy7xvO1/+tAf8p6zAZcqGqrtotTe7YB4qrDeuvI/zJW2oAh/cOCMoo4lRTGzurXBdqz15GgzU+ixCtLN4bqeqQC/vGka3k79zu7IdVAzw00xVybAM3m8MA2OiryH9cHAWSlTMTKaaaW8Zv5/1PLqsu3l1+KZ4XhUUrupyvWulk7qpnbNlLAFqJxuYm0pPM4ycLhz8GDi7DXr2eT75HpCcLXfGk9aIRIc1UXPFhHX9h7KptnIRF6zxqb5C5JHWzI= +api: eJytVE1v2zAM/SsCTxvgJWlX7ODT0jUDig1b0XbYoQhQxWYStbKkSnS6wNB/Hyjb+WiCFgN2siU+6T1Sj2yA5CJAfgeyIGVNgGkGJYbCK8dryOECNRIGQUsUTjnUyqBo0UKVaEjNFZZitk6IhVqhEfdt/LK8H0AG1qGX7Xpz3zgBIAMnvayQ0LOKBoysEHLoz0MGikU4SUt4qay9QwTyyiy2Wjxk4PGpVh5LyMnXmEEollhJyBugtWOC9hDEmG04n61/DE4WuKV9qtGvD3h/90Bh6gq9Kva5D7iUIVyk0Nz6SlK79ekMYpyy1OCsCRj4xOnojD/7fD+/iQ/ihxWFNYSGIGZwNhod4s5lKThxDAQZ9Oi8AemcVkV6guFDYGyzo3JbqzuoMAS5QHZBJ97OHrDg+5zndyTVCu2BxyoKpEjz1sR766+7/CDGmJR/PJJh7xBhLAmptX3GMl0VsKi9onUyxzlKj35c0xLyuykXr0JaWnZVmVyV/MRRGHZ+Hja9lSI/DfpV77Taa8hhSeRCPhxKpwaFtnU5CPiEXg6UPXj3mxQRV1oSP6T4wngxvroEltIrveHCtkXa1bupEzP2LuH1LIEg636+9hZ5eKZUAWXmNh3vitqpYNq3BHK6qsDQgdkRskiO2E9+N2WspNLJoXP7eRuIGXDlWp6TwcnodDDiTWcDVTI5qmujtr+7CfFSYrO15X8YLF1FCf/Q0GmpDCtKqTWdD7ZzLYN8M1SmGSxtIA43zUwG/OV1jLzdNjzbo1RBzjR3xVzqgK/k8cY4OCryEdcHE2cldc3I5KaV9Ir5/1HLu+uumd+LV6bjUUndpjTrXS291E3t4jRmsERZok/a2vC4KNDRzsGDkbPXrReT75PbCWQg93vjRS8kgqO6mqZF3NpHNDFuZBKvWWOMfwFoc1tX sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the pipeline action identified by the given `actionId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-all-tokens.RequestSchema.json b/platform-api-docs/docs/delete-all-tokens.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-all-tokens.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-all-tokens.StatusCodes.json b/platform-api-docs/docs/delete-all-tokens.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-all-tokens.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-all-tokens.api.mdx b/platform-api-docs/docs/delete-all-tokens.api.mdx index ca7d8da18..866f2be43 100644 --- a/platform-api-docs/docs/delete-all-tokens.api.mdx +++ b/platform-api-docs/docs/delete-all-tokens.api.mdx @@ -5,9 +5,9 @@ description: "Deletes all API access tokens in the user context." sidebar_label: "Delete all user tokens" hide_title: true hide_table_of_contents: true -api: eJydVMFu2zAM/RVB59TOtu6wnJauGVBs2Iq1Ow09MDYbK1UkVaLTBYb/faTspEk7YMBOkcUn8j3yMZ0mWCU9+6XJP6BL+m6ia0xVNIGMd3qmL9EiYVJgrZpfXymoKkxJDXBlnKIGVZswqso7wt9U6In2ASNIgqv6kGJu7e1QY6IjpuBdQq7c6bfTc/k5Lfv9izpT3/yQ1JHuJ/p8On2Nu4BaRXxsMRHn3aMZBiFYU2US5ToJttOpanADcpInJmItyjesB1Yo0mkXkJP65RoryReiKCEzEN0D+TgCE0XjVrpndmTIytUiRh9/jPo40mfm7/6icN8j5TxJe/0T8xF4wqqNhnZMrtMXCBHjvKWGP+96JrlBarz0tc59FZogUV0OQymH+zNOqSVZ3GJMOVcbLcMaopBmZQnBFJX1bV0kfGQuhfH65fRvckRdW6B7Hzfqk+DFB1qY7IneSF+HHh3TPbRJKgqVDOPvZQbxzXD4zJmBh6bXT5QbYNy9z8/Hno4spOy/CIpcww4dwWIIqLIhTsUfS2ZPGIlJ2Y/PASYinRvqvCk+vC+mchd8og1kPznIcgZ/5w3Ji0B7m59Q7Z7d+X9LNTZTPstgwThhk1V1owMOWzzRRx7gQTXMWcJdt4SEP6Pte7nmtYniMj5uIRpYSrfZZPwAoeYJiWkekCF6zgyDrMQWbCs0Xu3XiTUvF18XtwuGw6kTXkw+FxhD4HZH6ZlpRuS/DGY7GXlkgVyL9+oPe8KeOA== +api: eJydVMFu2zAM/RWBZzVJu558WtpmQLFhK9buFPjAyGytVrZciW4XGPr3gbKTJu2AATvFEZ/J954ePQDjQ4RiDeyfqI1QaqgommA7tr6FAq7IEVNU6Jxa3lwrNIZiVCNc2VZxTaqPFJTxLdNvnoEG31FAaXBd7VssnbsbZ2gIFDvfRopQDHC2OJef47E/vqoT9d2PTVuGpOF8sfiIu8BKBXruKTJo2KGLAbDrnDWZxPwxCnaAaGpqUJ7kFRuoEuUNxYgPJNJ52xEU4DePZKRfF0QJ25HoDlgMO2DkYNsHSEkDW3ZytArBh5+TPkgpZeaf/qJw55FqPYu9/pWq3CqS6YPlLRTrAS4IA4VlzzUU6zKVGhri2ouvVfZVaKJUYT5eynw8P0HnQJqFFwox9+qDgwJq5i4W8zl2dmac76tZpGcKOLMe3t/+ba6oG4d870OjLgUvOQBhsiN6K76OHh3S3dskE4VKhkEBmwwCPT188aFBhgIeXzkbYNt7n1+fPJ1YyNh/ERS51lCcwBIINDkQx+IPJVODVmoy9vNbIWkQ58Y5p7PTxdlsIYedj9xgDlSLWc8Y8LwieRN4l/MjrsNbPP9vqyY35e+8c2hbYZNlDVME9mus4SAEpYbaR5byMGww0q/gUpLj556CxKzU8ILB4kbsXpdJQ01YUcipeaItFLA0hjrZiRd0vdD4sGBH2bxafVvdrUADHkfh3dXnAVMJ2+1B+2EYEfmbkRLoiUcWCKlMKf0BzImeXQ== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ Deletes all API access tokens in the user context. - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-compute-env.ParamsDetails.json b/platform-api-docs/docs/delete-compute-env.ParamsDetails.json new file mode 100644 index 000000000..73360e964 --- /dev/null +++ b/platform-api-docs/docs/delete-compute-env.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"computeEnvId","in":"path","description":"Compute environment alphanumeric identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-compute-env.RequestSchema.json b/platform-api-docs/docs/delete-compute-env.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-compute-env.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-compute-env.StatusCodes.json b/platform-api-docs/docs/delete-compute-env.StatusCodes.json new file mode 100644 index 000000000..3982ffa92 --- /dev/null +++ b/platform-api-docs/docs/delete-compute-env.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Conflicting deletion","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-compute-env.api.mdx b/platform-api-docs/docs/delete-compute-env.api.mdx index 56a88e1f2..a7ad8f7ca 100644 --- a/platform-api-docs/docs/delete-compute-env.api.mdx +++ b/platform-api-docs/docs/delete-compute-env.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the compute environment identified by the given `computeEn sidebar_label: "Delete compute environment" hide_title: true hide_table_of_contents: true -api: eJzNld9v2jAQx/8Vy0+bRIFt3aTytJYyqdq0VW2nPSCkmuQgbhPbtR06FOV/352TQCDRqkp72AuQ8ze+z/2k4F6sHZ/MeaQzk3s4AbVxfDHgMbjISuOlVnzCLyEFD475BFitZKiUVqsMlGcyxk+5khCz5Tao1nIDit3X4pnaXMX3Qz7g2oAVdOtVvLt3uhOhwAgrMjRawiq4wgcUtu9BkSQoI3zCj0mnPXQiNYlQeQZWRntUSzgWnnJpAVm8zWHAXZRAJvik4H5ryLHzVqo1L8vBjuVZ20dnRAR7lKcc7LbD8qsRsn7nHWdSeViDxaOVtpnwlenTKbpfEKszWjlw9Mb78Sl9HTr88ZWdsO8aS4QXKc/LAT8dj7u6CxEzihycR1+NGmXCmFRGoT6jB0faokW5T9acZ+CcWAO1Sg2vlw8Q0X3GUpG9rEAbYV9KuZc+JdPMWm1v6vjwpAzkH3oibNqHKU2FTfUz8gT1WVc91WqF8Xh0x2JqNTL/pwHjoYMot9JvQ+NfgLBgz3Ps8cl8QfXHqUg0TU0IBcKs0CkftYd3VLRnpaQ2A7tpxim3Kb6QeG/cZDQSRg6jVOfx0METJnYodaeJb8MJu06Fp6ZkU9Kz8+srTkwN8i3lrIq/Db5LAXlsOp6el0GElurHl6bdH559yJNUKx1er/NVU5DblwApXBnhsqrEVGwRhWIfBt8OGest0zBtK/15f4AglLnKz7vh2cfhmGxGO5+J0Cv1Sqj2WN9qPMYt9t33D7dqnWUPv/3IpAJ3EmKGcIu6SY42/IBPDlYqljLBqEhXFEvh4KdNy5LM1Wqj3omlE8uUpmElUgd/CeylxdeL+wjbznLdiDQnZei1jbCSAF4J8+amnuK37JV/Dr2YtVGobZuvwT9IarlAfQIixk4n5kpyHkVgfOvlzg46GPbL2bfZ3Qzl4nCijiYoOOhlw3oGxZ1+BFWWO1RPz8RYln8AMsbKkg== +api: eJzNld9r2zAQx/8VcU8buEnalcH8tP7IoGxspe3YQwlUsS+xWltSpXO6YPS/j5Pt/GalsIc9JZa+1n3u9L1zAyTnHtJ7yExla8Ij1AsPkwRy9JlTlpTRkMIllkjoBRUoOqVAvVDO6Ao1CZWjJjVTmIvpMqrmaoFaPHTisV5c5Q8DSMBYdJJPvcpX516sRJCAlU5WSOgYqwEtK4QUNs+BBBRDWUkF7JJeHKCTpS2krit0KlujOsZx+Fwrhzmk5GpMwGcFVhLSBmhpObAnp/QcQkhWLC/GPXkrM1yjPNfolnssv3qhOBx8L5jShHN0kMDMuEpSu/TxFEKYMKu3Rnv0/MbJ6JR/tgP++CqOxHcjMqMJNUFI4HQ02tedy1xw5ugJEujVaQPS2lJl8X6Gj561zQblulj3UKH3co5slQ7eTB8x4/Os40sm1YL2wkMlBVJU8tLYOeNuuvwghBDJPxzIsLeP0IYvtjQvmLd5ftpXXxg9K1VGSs9Fzlbj5f804ZCAx6x2ipbR+OcoHbqzmgpI7yd8/xVSYbhrYioYe4V3YbjZvMNms1cC2wzdom+n2pWQQkFkfTocSqsGWWnqfODxGZ0cKLNn4tu4I65LSWxKccF6cXZ9BczUI99yzdr8N8FXJeCIveP5eRpFkHR/vvR2f3yhWCelZya+3tWro+CwrwFyuipD34n5smUWL3s7+c2UsZKqjN02M5/XGyEBrlwb53hwPDoZjHjRGk+VjGbpZkI7yA7Nxl3eZm2/fzhWuzIT/qahLaXSjBnzbTqX7Iz4BNKtmTpJoDCeWNc0U+nxpytD4OV2trF5cuXltOR2mMnS418Se23yHcR9wuXedF3IsmZlNNtCOsUAb4R5d9O18Xvxxq/DQcxuUerlJl+Pv1XUMAkJFChzdJG5lZxlGVraeHlvCG11++X42/huDAnI7ZbaaaEY4CBb07SKO/OEOoQVKvEzM4bwB2oUyrc= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the compute environment identified by the given `computeEnvId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-credentials.ParamsDetails.json b/platform-api-docs/docs/delete-credentials.ParamsDetails.json new file mode 100644 index 000000000..84d17c3fb --- /dev/null +++ b/platform-api-docs/docs/delete-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"credentialsId","in":"path","description":"Credentials string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"checked","in":"query","description":"If set credentials deletion will be blocked by running jobs that depend on them","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/delete-credentials.RequestSchema.json b/platform-api-docs/docs/delete-credentials.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-credentials.StatusCodes.json b/platform-api-docs/docs/delete-credentials.StatusCodes.json new file mode 100644 index 000000000..8b58a9655 --- /dev/null +++ b/platform-api-docs/docs/delete-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Running jobs block the deletion of this credentials","content":{"application/json":{"schema":{"type":"object","properties":{"credentialsId":{"type":"string"},"conflicts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"title":"DeleteCredentialsConflictResponse.Conflict"}}},"title":"DeleteCredentialsConflictResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-credentials.api.mdx b/platform-api-docs/docs/delete-credentials.api.mdx index b7cf2921a..8fdc449e4 100644 --- a/platform-api-docs/docs/delete-credentials.api.mdx +++ b/platform-api-docs/docs/delete-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the credentials identified by the given `credentialsId`." sidebar_label: "Delete credentials" hide_title: true hide_table_of_contents: true -api: eJytVl1v2jAU/SuWnzaJAdu6SeVp/WAS2rRNbac9VEg1yQUMjp3aThlC+e+71yEkaSJYpT6V+B7fc+6nu+NeLBwf3fPIQgzaS6Ecn/Z4DC6yMvXSaD7i16DAg2N+CawGZDL8mkuI2WwbrAv5BJo91ECT+KHPe9ykYAW5m8QHh1c1zh5PhRUJnlrSs+MaPxDZ8IQoSXpS4Zf8uciaN+a8lXpR6bOItvCYScTwkbcZ9LiLlpAIPtpxv02JqrjE87x3YN8Yu3apiKDifszAblvkf0og01kCVkZN7haX1B4WwTQ3NhG+OPp81mDHS9EaTjBP5syBb5QlpuyilW2kUmwGbKYMOaIi2UxrSs3KzKiewiM6BR0zhGMBky6xM2MUCI3appRGlxrtwBHgw/CM/jQV/fzG3rEfhkUGg9Se5z1+Nhy2cZciZlQUcB5ZSzTCRJoqGYVuGawcYXc1UVUd73kCzokFUMfutZrZCiLyl1pqOS8LoSWwq9rcS6/oaGytsTf7+NCSB+UfOyIsm5lp45lQymxQT0Cft9E39ZSHUoRROVTJzPFbunoJX5KP44E356cdfiCao3vvalZhraBWkx4Sd5qksHb4lt2URX93GDKrjpeotTiu9urLsvXLA56/6F4oN15wEGVW+m3YQZcgLNiLDLfN6H5K3Y8Lamlog4XqQVhbZOWDWqIHu0bWc5opsE/lZgtB8qX3qRsNBiKV/UiZLO47eMS26kvTmvHbYGG/lPC0LtgV4dnFrwknTaXkW2qJoiB14Yd0EmM53mGsAwhPih9fy0W02viQc6nnJlzf53CvgmhPCaRwZYQvRgGmXhZR6OVm8PWQsZ2lCntwbr5UBhRCmSt43vfPP/WHdJYa5xMRRmG/LYsSP5uihsxdNVSv8aTt0+rhrx+kSuCOrjq46Irms9rjo+Y0Yu2WGAbhdruZcPDbqjyn42LVU7PE0omZom03x0twJKITT1Cn2jVsW6/ck1AZITm9RP9P//rv0BHF1ctYqZ3Sh5Uk94WZe3Ozf1LeslP/RHRqKpem3tYFHbQ2ap5P8cISRIzuSGWBuYgiSH3tdmvlN5bP9fj7+G6McNGc8GcTHQg6xWG7BcSdWYPO84NWT9+kMc//AThKg/Y= +api: eJytVk1v2zgQ/SvEnFpAa7vdYIHq1DRNgWCLbpF2sYfAQGlpbDGhSIUcJWsI/O/FUJItRULcAD1Z4oz43sybDzdAcuchvYHMYY6GlNQe1gnk6DOnKlLWQAofUSOhF1SgGDgKFZ+2CnOx2UfrTj2gET8GTlf5jwUkYCt0kq+7yg8XXgwwE6ikkyUSOubTgJElQgqjmyABxXwqSQU8JTm4TXhyyuyO/Bwk4PC+Vg5zSMnVmIDPCiwlpA3QvmKo9iMIITmgP1p35yuZ4RH7vka3n4D/1zsKU5foVDbGnmApQ7iLpq11paT26K+zEXpWYHaHJ5CvtsIjjWTJObvKGvGotBYbFBtt+SIWydXGcGpu7Yb1lCRyrNDkwhoWsJwju7FWozQQwprT6CtrPHp2eLs6458xo3/+Fn+IL1Zk1hAagpDA2Wo19fsgc8GioCdIoPdOG5BVpVUWq2V569m3GZA66ngDJXovd8gV23G1m1vM+L7KccmRaon2jnNqAynSfHTpnHXXXXwQQojM/5yJsC9mYSwJqbV9xLyN893U+3qY8ihFbJWDSnYrqFB+KOFL8vF84OP+mYYfgbZaZeQHVumc5FJThKU/DdJaZ+5W85Btfc8Yaqefl2gyOC469r1si/4Awou+i3KHBDxmtVO0jzPoA0qH7rymAtKbNVd/iVRYnmBRPYxji62wHCR62YyyHrin0D30ky0GCQVR5dPlUlZqkWlb5wuP9+jkQtlJj3+LFvFVS+JxIS7YX5x/vQLm1FP+xiXRCjIkfkgnI/btHds6OkHSPXzqB9HtI8WcK7O18fMuhx0Lhj1FkMNVGfrOmWtZZrGWx8EPQ8ZSKh3n4Na+PxpCApy5FufN4s3q7WLFh5X1VMrYC924bDV+0kYjns2xq37HTuvySvg/LSstlRmUcFsW472aQDpux3UChfXEfk2zkR7/dToEPm5nPVdLrrzcaB53W6k9PhPRiR00y/YO95M19yB1zZ7Aq+jX4X//InqG8XE1Htmu+cUppvvCzL267nbKa3HqX8Qsp35qmv2Q0IHrSPOwDgkUKHN0kWXrc55lWNHg68nMH02fj5efL79fQgJy3OJPWjoCzJJrmtbju71DE8KBK/E7cwzhJwzHhBs= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the credentials identified by the given `credentialsId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-custom-data-link.ParamsDetails.json b/platform-api-docs/docs/delete-custom-data-link.ParamsDetails.json new file mode 100644 index 000000000..7cd8d1cd1 --- /dev/null +++ b/platform-api-docs/docs/delete-custom-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-custom-data-link.RequestSchema.json b/platform-api-docs/docs/delete-custom-data-link.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-custom-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-custom-data-link.StatusCodes.json b/platform-api-docs/docs/delete-custom-data-link.StatusCodes.json new file mode 100644 index 000000000..f02e38d7d --- /dev/null +++ b/platform-api-docs/docs/delete-custom-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success — Data-link deleted"},"204":{"description":"DeleteCustomDataLink 204 response"},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-custom-data-link.api.mdx b/platform-api-docs/docs/delete-custom-data-link.api.mdx index ba64aae6e..23da62de9 100644 --- a/platform-api-docs/docs/delete-custom-data-link.api.mdx +++ b/platform-api-docs/docs/delete-custom-data-link.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the data-link associated with the given `dataLinkId`. The sidebar_label: "Delete data-link" hide_title: true hide_table_of_contents: true -api: eJzNVdtu00AQ/ZXVPoFkkgIBiTzRSypVqihqi3ioInVjj+NtNl53d50QWZb4CL6QL2FmfU0dUXiCp9a7ZzJnZs6ZLbgTS8undzwSTrxSMl1ZPg94BDY0MnNSp3zKz0CBA8tcAqzFMWGtDqVwELGtdIm/XcoNpOyeQJeIuYjuR+wWz/M0AqN2Ml2yUOk8YtZpI5bADFidmxCYtCzVjok4hhB/csQDrjMwgihcRC2J0xwj12f17yMoE0as8cJQFQVP8QPBHQGESKohEy7hg8LaYqwzRE5GkDoZSzBEwMBjLg1gdmdyCLgNE1gLPi2422WUporiZRm0mbfarGwmQuhSP+ZgdoPcXxsgS/M1GBn2k7MrDxOKaAzSytTBEgxexdqshauO3k+QyJxY20ynFixFvDk6oj/7qW/yMARr2c/vP1jXgsg3OOJlgFGTYdShATBEsiYhRU4O5TsR0TW2EqxDyqFG9qkjlMgyJUM/4vGDJWjRK7br/h1fI12UC0mz7oFePKBQSACGdOJkVW8DPDQj7qRTdDQzRpvrlnVZeuJvh8SvGgVW2lRKb6sGTQ416JN25xqV7vva6oBpw0Isg2YrVKXymGABO/58wSJpxUKhh3CU3kJtYECRnd3auP+1h3hpIcyNdDtvxRMQBsxxjr6b3s1JmejTRJOXK6l599ItH3fbZ1x03i1J/GA2jblzoxCcOJfZ6XgsMjnyy2Rk4RHnNJJ6YLIbf8M+K+HIKuzULx/sOyc+Dd0b6ldVe590Wz5lbHxI3wsPwpPqn/PGhA9b53sk01j78LpXNQtK+xxBKleiOWswDVqEftD7xfdLxllL5XdArD92F0iEOlfleT368G50RGeZtm4tvE7qlVUZu5PaU5JFp7d/9RTUg3DwzY0zJXCtYiW+I0Wtob0XLODT3guAk06waMIUxUJY+GJUWdJxtZlJWo0N+TRGk8JvOvDne/sg6RXsBq/ERqickF6UG2EkUflLWi+ua6u/ZM+8agdp1Yci3fX5NHR7zSzniE5A4BA9wwpwjA9K5nqhg7W05/+z2eXsdoZwsW+0J8byCQ4ywzl6xK1eQVqWLVFH38SxLH8BTwISmw== +api: eJzNVU1vGzcQ/SvEnFqAlRRH6GFPdWIHMBAkhu0iB0NAaO5IS2uXXJOzdoUFgf6I/ML8kmK4X1IkNMmpPUnLndl58+a9YQukNgGye8gVqd9KY7cBVhJyDNqbmoyzkMEFlkgYBBUoxjihQnDaKMJcvBgq0tuNeUYrPnPQe2O3V/nnmbgrUDQ2R1/ujN0IXbomF4GcVxsUHoNrvEZhgrCOhFqvURPmM5DgavSKIVzlI4i3TSBXXfTfBwm18qpCQs9dtGBVhZDBBAAkGO6hVlTAUWNjM4E8gzM5WjJrg54BeHxqjMccMvINSgi6wEpB1gLtai7TZUGMcqz84vw21ErjVPqpQb87qv1pCBS2qdAbvV9cfExhqmQYR2WNJdygBwlr5ytF3dHvS4hxxahD7WzAwBlniwX/HJa+bbTGEMTXv7+IiYI8EZxDlHC2WB5nnRqAOFssxVCQM5en6r1R+Q0+NRgIJGhnCS1xlKrr0ug04vlj4NB2r9mJ/XuoMAS1QZZmz4F7eETN36s964RM1+8QeGpGQIZKPrr03vmbEXWMCfjrY+AfBwV22ixL99IRtDxF0AdH71xj88TrqAPhvNAe02xV2al8zWFSnF9fidwE9VBiLtbOJwuNiZIzJ7uNef9XDqOEgLrxhnbJim9QefTnDRWQ3a9YmRVS4djLndSSe/ktzKftM28n70YWP/rnwdyNLyGDgqgO2XyuajNLy2QW8Am9mhl3ZLLb9EZcl4rYKuJtWj7n11fAeAa4t8xX1/s+6LF9rjj4kJ8fUhDI/s+7wYSPL5Q4MnbtUnrPVY+Cy34PILdrNIY+mAetdBr0YfP7LWOlTJl2wNr9Mb2IEpi5rs6r2avF2WzBh7ULVKkklH5ndc6etPYtynYS3H91F/STIPyL5nWpjOVOEiVtL6KDK0xCtncFrCQULhDHtO2DCvinL2Pk4241s7YGH0K2VmXAf2Hgxxf3SdBb3B1dE8+qbDgyqfJZecNQfhLWLze9138V37nWTsLqD5Xd7eMZ4O6RGVdRQoEqR58QdgHnWmNNe6lHe+lgAVxcvr+8uwQJ6tBp3zgrFTiJrG27iDu3RRvjCJT4mTHG+A/MKxLA sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the data-link associated with the given `dataLinkId`. The underlying clo id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-data-link-item.ParamsDetails.json b/platform-api-docs/docs/delete-data-link-item.ParamsDetails.json new file mode 100644 index 000000000..8b3554ea6 --- /dev/null +++ b/platform-api-docs/docs/delete-data-link-item.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier. Required for deleting content from private data-links.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/delete-data-link-item.RequestSchema.json b/platform-api-docs/docs/delete-data-link-item.RequestSchema.json new file mode 100644 index 000000000..f399f4df5 --- /dev/null +++ b/platform-api-docs/docs/delete-data-link-item.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string"},"description":"Array of file paths to be deleted from the data-link."},"dirs":{"type":"array","items":{"type":"string"},"description":"Array of directory paths to be deleted from the data-link."}},"title":"DataLinkDeleteItemRequest"}}},"required":true,"description":"Data-link content deletion request specifying files and directories to delete."}} diff --git a/platform-api-docs/docs/delete-data-link-item.StatusCodes.json b/platform-api-docs/docs/delete-data-link-item.StatusCodes.json new file mode 100644 index 000000000..064816c24 --- /dev/null +++ b/platform-api-docs/docs/delete-data-link-item.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"deletionFailures":{"type":"array","items":{"required":["dataLinkItem","errorMessage"],"type":"object","properties":{"dataLinkItem":{"type":"object","properties":{"type":{"description":"Type of the item. Either `FILE` or `FOLDER`.","type":"string","enum":["FOLDER","FILE"],"title":"DataLinkItemType"},"name":{"type":"string","description":"Name of the file or folder."},"size":{"type":"integer","format":"int64","description":"Size of the file in bytes. For folders, always `0`."},"mimeType":{"type":"string","description":"MIME type of the file, calculated by analyzing the file extension. Null for folders."}},"title":"DataLinkItem","description":"Data-link item that failed to be deleted."},"errorMessage":{"type":"string","description":"Error message describing why the deletion failed."}},"title":"DataLinkItemDeletionFailure"},"description":"Array of items that failed to be deleted, including error messages."}},"title":"DataLinkDeleteItemResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-data-link-item.api.mdx b/platform-api-docs/docs/delete-data-link-item.api.mdx index 7303ac417..fcbd4369e 100644 --- a/platform-api-docs/docs/delete-data-link-item.api.mdx +++ b/platform-api-docs/docs/delete-data-link-item.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the content of the data-link associated with the given `da sidebar_label: "Delete data-link content" hide_title: true hide_table_of_contents: true -api: eJzVV9tu4zYQ/RVCTy2gtdM2LbB+ai4OEDTJLrIp+hAEMC2NbCaUqJBUvFrDQD+iX9gv6QwpWpIvcRbYAu1LYlFDzpkzM0fDZWT5zESj+yjllr+Tongy0UMcpWASLUorVBGNonOQYMEwOweWqMJCYZnK3ON6G+PGqERwCylbCDt3b2fiBQo2IaMrtLlMJwN219slrAGZMWFYqcGAfoE0ZtPKskxI9MiLlKVCQ2KVFvhMJ4sCdzGugWnIFW4YRHGkStCc4F6ma8Dnwa2FHE1KrnmOy5riXUYFPqBpiw1NBEVbcjuPtihYIzZWi2LGRIosiEyAJvcaniuEib6triCOTDKHnEejZWTrktz4XdFqFa89L5R+MiVPoHX9XIGut3z/EQxZUeWgRdJ1zj44My4JxpZbgcmagcZXmdI5t37pl+MekASB03lcmkNQzlrTHUSw24YGht5YSkkgi1AymVY5plm8YJG0JWB2Al/z9eDJBWNPVVqTRXMc/eRlKUXi8j58NIRwuX2Umj5i/VABaKoSi3VEb12Bdcy41pwCFlgtZgeSTSpOyJ7agA5iVDTYIIpNwQdOJFC8vSYZuGOE/iZ+Q1/Ub3eOh1lhJTQFTXXvW4Va5NbTjFar7YLe1w0htz7ZqmBNspgpIRFZTfnf3coI12N1pGDzl6owPiM/Hh3Rv77PD78hSd8o9wHtBRey0q+XQcvEfSsWXlFAa6WvwRg+A1LNA067mw9C9G83SbjD1SC9hHDAxqiIoNnk4vJqPGGKfn24Oh/fTqit+qWEgFFAKA5vggu0yyHfqArCSL4oNV4lNutysyRu0Cogcx2BUDIlU9JHPMSIL/AWXdo89hPu6x2L6j+t8WM0YBdrDyZmXC54bdjkaOLc5SKHu4bB13FfX16Pme3QSl5ilnCZVNJ9zaY11i6X9Req5TUO+IyFaPCMAbuppHSK16DZ3WhNzexrJMomns5RJrEo0W2vnV1QvXI7GNiYrFnuzZl/N6UQFvPaC0NoWe9wP+rzfre8IkmuafZHEWP2ElmlhAK68PZQ1tUmLw8kTmh4vEsgTnkaJOwrhKLb3vlbWznfl4RuFC4BW8B/2qFsYXZhhcLBRkq1QDzO+njb+kbZC1WhmP79519sPUNQu3W+4+6kjMxidvLxEoXX8KlsPsyU/PXGmHa28xg+0Nek3f9f5ZI0BZJKC1u7ce4UcCLUJxXObqP7BxobcNabK5oGffW5CZDeRsN29hgu2/lvNQyB0tE4iTaDYqUlbppbW5rRcMhLMUikqtKBgWfM20CobdFyb9hH1A+SN3ZG9pSHiHAF2J+IN89BF/yaBvIYRiN6njojXPE/LoJwPi6s44rycduOSuPPPC8ldEad+8DsQxhC2pUVjX2Zcu4bzpsoCPahAIkukeBH3RsTjzxxBdMnr0sZ1oyQTvcz9Wv7AoEQ897PD4P3Pw+OaK1Uxubc1VsztXpx6JRum70e2M7A+H+4yDTJt/h9GZaS4yyO0TsWl0399u5qcTTq3WBCrJjiOVJG1svllBv4XcvVipb9YE+FHUQhGmUoGZtDXpe3t99AdsJ/gnrrvvPCZUWWEV1E3o7k37qAvIJ783rUIn+gBy0I+lcS+l0A+j07cLPcCSzMqkXdxRMAdwpiRY09B45jiUPoDc48jnduQmoP2BJ3So3fcZIkUNpXbbuKez6+Gt+NSaqaO1uuUtql+YIuy/jXwVWOGT9l09oykryYVe5rEPlTSdh4Xxc3dNDFtZMQLHxncaeeoMDiD/xYeiZqVqt/ALgc7Fc= +api: eJzVV9tu20YQ/ZXBPrUAIzlp0Ac91Y5lwKhzgeOiD4YBrcihtfFyl9kdWmEEAvmIfmG/pJhdUiQl+RIgBdonidzZnTNnZg5nN4LkrReza5FJki+0Mnde3CQiQ586VZKyRszEKWok9EArhNQaQkNg8/C43QbSe5sqSZjBWtEqrN6qezSwYKMLZe7Os8UErka7FHnUOSgPpUOP7h6zBJYVQa40epAmg0w5TMk6hT6crAwoAukQHBb2HrOJSIQt0UmGe55tAZ92bgkLkYhSOlkgoeN4N8LIAsVM9NhEIhRHW0paiT0Ktog9OWVuQWVoSOUKHbt3+LlSDjMxI1dhIny6wkKK2UZQXbKbuEs0TbL1vLbuzpcyxd715wpdvef7z84QTFWgU+nQObwPZlIzjD23yhDeohOJyK0rJMVXv74eAUkdhvOk9k9BedObHiACLlsaILcOMk4CW3QlkztbQOnUvaRBCfiDwLd83URy0dOJzWq2aI/jv7IstUpD3qefPCPc7B9ll58wJS4Ax1VCCj2vhgIbmEnnJAesCAt/AMkuFcdsz23ABwEXjQeysMQYOJPA8Y6aZBKOUe6H+O36on6+8yYRpEhjW9Bc97FVuEUuI82iYbPdgn6oG7rcxmRbA22ywJeYqrzm/B9uZbIt1kCKQ19a42NGXh0d8c/Y5/vfRfKjct+hPZNKV+7xMuiZuO7FIioKOmfdW/Re3iKr5hNOh5ufhBhXd0m4qkvspJcRTmCuaIUOFmfnF/MFWP73/uJ0frngthqXUiLQVAXHEU1EInhXQL5TFYyRfXFqokrs1uVuSbyTxRZZ6AjrILc6Y31sEuHVV3yOLu0e+1F9HR+rDCxrQj+Bs60Hn4DUa1l7WBwtgrtCFXjVMvg47rfnb+dAA1rZSwKp1Gmlw9dsWYM0UtdfuZa3OPALofHKmgm8q7QOiteiOdxobc081EicTaCVJMil0piN2zkENSq3JwObszUU0Rzi2pJDWK/qKAxdy0aHD6M+HXfLI5IUmubhKBJQJtVVxihwCO8ByobaFOWBxalJxOtDAnEis07CvkMohu1dPLeVi4eSMIwiJGAP+C8HlK2bXcBYAqm1XWMmgvXrfet3ls5sZTL4+9tfsJ0huN0G3/FwUs5mCRx/OIdMebnU7YeZk7/dmPDOfh6zLnxN+v3/VS5ZUzCtnKI6jHMnKB2644pWYnZ9w2NDgbSyPA3G6gsTIK+KaT97TDf9/NdMu0D5aHffDYqV02ImVkSln02nslSTVNsqm3j8jE5OlN0XrbACH7Qkljd4w/acB8G4OtgfmbfIwRD8lgb22I1G/LwMRiJp/5x1wvlpTYErzsdlPyrNv8ii1DgYda47Zm+6IaR/0/DYl9vgvuW8jYJhPxUg06VS9K0x8yjTUDBj8oaUYSGVDrqf29/6hSYRzHz083Ly8ujV5IhfltZTIUPBtWNrVIdB7fbpG6EdTIz/h5tMm33CLzQttVSGow80btoCHl3WEjEbXWG6WG8SsbKe2HqzWUqPfzjdNPw6TvZc2Z0qiFkutd+d8oa8Pf8KchD+HdZ7F557qSu2FHwTeT6Sf+sG8gju3ftRj/yGH5xi6N9J6E8d0J/hiavlQWDdsGrqIZ4O8KAgGu7sFcoMXUAYDd5EHC/CiNQfsKfunJq44zhNsaRHbYeSezq/mF/NWavaS1thM97l5Jpvy3Id4drATByz+d1GaGluq/A5EPFUVjY5FsYdIQxxHSRks4kWV/YOTdNs+SF+Zmqa5h/EDex8 sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the content of the data-link associated with the given `dataLinkId`. The id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-data-studio.ParamsDetails.json b/platform-api-docs/docs/delete-data-studio.ParamsDetails.json new file mode 100644 index 000000000..3a4801515 --- /dev/null +++ b/platform-api-docs/docs/delete-data-studio.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the Studio is deleted in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-data-studio.RequestSchema.json b/platform-api-docs/docs/delete-data-studio.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-data-studio.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-data-studio.StatusCodes.json b/platform-api-docs/docs/delete-data-studio.StatusCodes.json new file mode 100644 index 000000000..b8c744eb7 --- /dev/null +++ b/platform-api-docs/docs/delete-data-studio.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the Studio is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-data-studio.api.mdx b/platform-api-docs/docs/delete-data-studio.api.mdx index 83c4c4673..ea392a88f 100644 --- a/platform-api-docs/docs/delete-data-studio.api.mdx +++ b/platform-api-docs/docs/delete-data-studio.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the Studio associated with the given Studio session ID. Ap sidebar_label: "Delete Studio" hide_title: true hide_table_of_contents: true -api: eJzNVdtu00AQ/ZXVPoFknAIFiUgIAkmlCARVW9SHKlI39iTe1vG6u+OEyPK/M7O+xLkIxAMST7FnZj3nnDk7KSWqpZPDO+mwiLVxchbIGFxkdY7aZHIox5ACghOYgLj2RUI5ZyKtEGKx0Zj41FKvIWsLHDhHp8V0HIpRnkMWi/sPG2MfXa4imMbv7wUaEfsvC9We0hk9d1UiMhnCTwxlIE0OVjGeadwhGitU9UEqyJVVKwpa5lLKjF6osIFBhwKpmUuuMJGHBA8wO7Q6WwodQ4Z6ocEyAAtPhbZA3dEWEEgXJbBSclhK3Oa+lT8lqyrouvf4tv2fCrDbIwC3HeWsWIHVUb+5uE1IV7PSSHIH/Slo1ygYs3KcKBzYvmxHKDWllmAptTB2pbAOvT0n3DMm6XKTkQ584tXZOf/sI/3+RbwQ30zdI0NZBfL87PWJunZeIjMoVJqaDcRhXX7is98MXpgiI3obJrvPkb+w4KwwdpcfXU69ANqpeUoKEB8f70Rn/i1MaqjyPNWRxzR4cNy17MmzG++dXJEP1BL4IjSqmfkDRMgus2xE1LVCbeEpE0jUmHJoYq2xV42wlKk46SAqrMat9+onUBbsqCBnDu9mPAcycmLY6PV4vb05KwfNJR2UnbMrHjPYdev8wqZUmCDmbjgYqFyHUWqKOHTwRCMJ/WU5sL/PiMtUIZtCfOZ61lcylhbqNWtV8+4D7qhzx9Zx/D73RRSpHy5auz1s0Oujs4XxxxudGhTc9k8Ama6OaCPVxTxkFfkh75PvU6Y569S7fWE+7hIEhJWr+7wM370JzziWG4cr5T3S3OV65Yhu3+whLHdG+y+2ZTMSfh3kqaLNQ5y8NmXjpN26D+RwtyVp3glR53xZzpWDHzatKg7Xi4sN1t44OVyo1MFvpPhna+0kv0fYHu3ctUoLrvROXiurGflfsnh21eyG54fjOvlHcRJbE1TZtg+qxbzTv5pRcQIqppvDKOv8KIogx97Jo122tzTGk6+TmwmVq/0benAjfYOTwGj0vuLGPEJWVR1O5HfGWFW/AFzL2HI= +api: eJzNVU1v20YQ/SuLOTXAVnISowcCQevGDiC0SIN8IAdDQMbckbg2uUvvDq0KBP97MMsPUbKQoocC1UXiziznvTdvRi0wbiNktxC5MdZHWGswFPNga7beQQbXVBJTVFyQ+pSSFMboc4tMRu0sFym0tU/kxoRIMVrv1Op6oa7qmpxR337d+fAQa8xpZd58U+yVSW9WON6yTqGaslTuHdPfvAANvqaAgmdlJkTXyNhfBA01BqyIKQiXFhxWBBkMMFYGNFjhUiMXcErwBHPkYN1WWUOO7cZSEACBHhsbyEDGoSENMS+oQsha4H2dSqVb0HV6qj7jO9Z/bCjsnwH4OlF2TUXB5vPi6mtBTvnKMpPR8y7YOChoRDkJNJHCXLZnKK1j2lIADRsfKuT+6JdL6Lq1kIy1d5Gi3Hh1cSlfx0j/+kP9rN77voZj6DRcXrw+kzf2SznPCsvS78gs+vQzr33v+Z1vnNFqJ2SPOcobNhJVPhziVx9WSQAb8a4kozY+pPNJdOE/wsxawLoubZ4wLe+jVG1n8hzaewsVxYhbkkEYVPN395SzuCyIEdn2Co2J50wAbLmUo5sQfPg4CAudfDREyptgeZ+8+jthoHDVcAHZ7Vr6UBEXXozetzfZW6KwHIZ02U7O7qTNFJ5G5zehhAwK5jpmyyXWdpGXvjGLSI8UcJGG5cT+KaI+lMhiCvVW8kVfECwj1E+iVc97DniiLhVHx8nzXUoCPfx4N9rtfsdJH+s2Pl0fdBpQSNl/Aih0bU5xSJYmY56afEx+TpkqtGVy+8b/dgh0GkS5vs7LxcuLV4sLOax95AqTSYZh7neOmhbOEcT24LT/xboceiKPy7pE64RTEqcdrHTY9xqyw5pcayh8ZIm37R1G+hLKrpPjfnOJw8aRg2yDZaQfSPGf7bWz/B5o/2zpPmHZSGay8hMGK8j/JYufPg7L4cVpu87+U5zFNhyi289BjZgP+nfrTkNBaCgklH38Ks+p5tnNZ8vsaGtc3/x58/kGNODxiJ6MZCpwFljb9hmf/QO5rptwsjwLxq77DpMP2Jc= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the Studio associated with the given Studio session ID. Append `?workspa id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-dataset-v-2.ParamsDetails.json b/platform-api-docs/docs/delete-dataset-v-2.ParamsDetails.json new file mode 100644 index 000000000..3bbd1a82a --- /dev/null +++ b/platform-api-docs/docs/delete-dataset-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier.","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/delete-dataset-v-2.RequestSchema.json b/platform-api-docs/docs/delete-dataset-v-2.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-dataset-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-dataset-v-2.StatusCodes.json b/platform-api-docs/docs/delete-dataset-v-2.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-dataset-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-dataset-v-2.api.mdx b/platform-api-docs/docs/delete-dataset-v-2.api.mdx index eba70cc8d..906b5b7f4 100644 --- a/platform-api-docs/docs/delete-dataset-v-2.api.mdx +++ b/platform-api-docs/docs/delete-dataset-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the dataset identified by the given `datasetId`, including sidebar_label: "Delete dataset" hide_title: true hide_table_of_contents: true -api: eJy1lE1vEzEQhv+K5RNISxJKQSInWhqkCgRVW+BQRerEO0ncOmvX9qZEq/3vzHh389FErThwStbz2vPM+B1XMsIsyOGNzCFCwBjkOJM5BuW1i9oWcijP0GDEIOIcRasSOsci6qnGXExWKTLTSyzEbSs4z28zoQtlylwXMwHGCAjBKg2RtizRBzo79GQmrUMPnOk8X+c6aw75dURxBx4WtOaZspIFfZDu0fr74EAh7cqkZsyHEv1KPoX/3QlFUS7Qa7VB95w+qDkuQA4rGVeOT9ZFxBl6Ck2tX0Bslj4cy7rO1unXVXbJHcT5Xu62DBGi5ybsJvb4UGqPVHT0JR4AaXZR2jGLg6N+YeD40eCYf3Zz/fgq3ojvVihL/EWUdSaPB4N93SnkglNjiATRqUkGzhmt0k307wJrqy2mDe2NXGAIMEM2SotqJ3eo+Dzn+TqjbkA74YGaaKuOhpdG3lt/2dZHkTqRvztQYWcUUdjIjrKPxMPygKr0Oq6SQU4RPPqTku5jeDPm5pF75pbNlSdzJU9xVPY7z/er9YXW7An0y85vpTeknMfowrDfB6d7ytgy7wV8IJyetnu3fpUi4sJAZAeJz6wXJxfnkmE61itubdOmbeJ1pzhjZ0/+niQRrTR/vnTevHuMqQe6mNq0vW1rS8FpXwLkcrWiAW/E7AlQyRO7xW+XTLbQJo3G1H7aBAiknW2Kve19fN8b8JqzIS4gWaodoGbOu+fkKWK1MeZ/fn3abkf8E/vOAM0y4aayq9YlWy9jJoebwae7nFNZLKiqCS3+9Kauebl5iNg8uQ4wMTw1UzABn6nypWfqIOc9rvaewiWYkpXJbEvwmgH+EebVZTvtr8WzT9hBqHYRitU2TQe76V89JvEcISdXM14TP1EKXdzaufcs7Uz02ejb6HpEctidnifTkhIcBKOrS4pre49FXa85I38zY13/BUqOdhQ= +api: eJy1lE1v2zAMhv+KwNMGeEnaFTv4tHbNgGDDVrT7OBQBythMotaWXIlOFxj67wNlOx9N0GKHnRJLr8SH1Es2wLjwkN5Cjoye2MM0gZx85nTF2hpI4ZIKYvKKl6Q6ldI5GdZzTbmarePOQq/IqLtOMMnvEqVNVtS5NguFRaHQe5tpZMrVipzX1vgBJGArciiRJvkm1mV7ya9TSKBChyUxOaFswGBJkMKTdQ++wowmOSSgBfOxJreG5/C/e6EydUlOZ1t0J+F9tqQSIW2A15XcrA3TghwkMLeuRG6XPpxBCMkm/CbLPniFvDyI3aWhPDspwn5gR4+1dpRDyq6mIyDtKQhhKmJfWePJy/7p6Ex+9mN9/6LeqW9WZdYwGYaQwNlodKi7wFxJaPIMCfTqtAGsqkJn8SWG9160zQ7TlvYWSvIeFyRG6VDt7J4yua9y8pysW9BeeCSnBFhzIUtj56y77vKDEEIkf38kw94oylgWR9knyuNVnrLaaV5Hg1wQOnLnNS8hvZ1K8UripRVz5dFc0VOyC8Pe88Nm86BBPEFu1futdgWksGSufDocYqUHWWHrfODpkRwOtD149Zu4o64KZHGQ+iR6dX41AYHpWW+ktG2Zdok3lZKIvT3lexZFkHR/PvfevH/iWANt5jYe78raUUjY1wAlXZ2R78TiCcyiJ/aT302ZStRFbI25/bjdCAl0vQ0pnAxORqeDkSxW1nOJ0VNdB7WN3s+T54zN1pn/efx05Wb6w8OqQG0EN+bddDbZGY0JpNvOnyawtJ5F0DQz9PTTFSHIcjuJxD259jgrpG3mWHh6IcvX5tRRzgdaH8zCFRa1KKPbVui0APwjzJvrrt3fqhdn2FGobhHNepemh93WL0xDAkvCnFzEa/fPs4wq3jl5MJf2Wvpy/HX8YwwJ4H77PGuXGOAoWNO0ih/2gUwIG06Wb2EM4S8zsnY5 sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the dataset identified by the given `datasetId`, including all associate id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-dataset.ParamsDetails.json b/platform-api-docs/docs/delete-dataset.ParamsDetails.json new file mode 100644 index 000000000..cba1d0d1d --- /dev/null +++ b/platform-api-docs/docs/delete-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/delete-dataset.RequestSchema.json b/platform-api-docs/docs/delete-dataset.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-dataset.StatusCodes.json b/platform-api-docs/docs/delete-dataset.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-dataset.api.mdx b/platform-api-docs/docs/delete-dataset.api.mdx index 1046f91ec..cc0a0247a 100644 --- a/platform-api-docs/docs/delete-dataset.api.mdx +++ b/platform-api-docs/docs/delete-dataset.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [Delete dataset](https://docs.s sidebar_label: "(Deprecated) Delete dataset" hide_title: true hide_table_of_contents: true -api: eJzdVcFu2zAM/RVBpzZI7KzrBiyntUsGFBu2ou2wQxqgis3Eah3LleR0geF/HynLdpIGLdbjTpHFR/GRfGRKbsXS8NGUx8IKA9bwWZ/HYCItcytVxke817tJpGGQxbmSmWV4jiHXEAkLccCuAdh0DClYYP6R2VFibW5GYRiryAQGHkGLQKowT4VdKL0aiFyGsfMZeJ/BenByzNDIbAIsKrQGjNUEDXq92+w2q8MYB/F+TMYIlAsJMZtvnGUp15CxOw+4iO8C3ucqRw6U0UWMOdUPjWsEWnOhxQpvNNWi5Bl+IOpJ6QeTiwjQp88lFSMXNuH7Ffrd4FhWrEDLqCOlEazhsZAaMK7VBfS5iRJYCT4qud3kFAcThKWDUnGEra8+nvKq6rdk2nRepOJTYsZqmS3/kUfthFFnBDa5ygwYsp8MT+lnN9TPb2zAfigWKaSfWV71+elw+Bx3LmJGocFQpRs0wkSepzJyTQnvDWHLLU4d2ylfgTFiCaRNT1XN7yFyndPUWStrog3wQE7oKm1KVxOtlb7y+aGlcszfH8iw0QzLlGUiTdUT8iF4NwBtMQE1K+3G6ecchAZ9VmCDRtMZlRPFlShSXq16Jzmy8rAVmQnLLcFVYTORYdm2vuIUSK8bnRY6xSeaYcOhCqJUFXE3cc/0ce0s7NIPIvtCeHZ2ecGJZZPENXWhruh2Km1RKSL3AqLvuQPhTX342qj4/sm6cslsoZy774BnQWFfI0jpSiyOB5N8ROTks5v8dsqoIJm6IVqoz50BiVDl6jjvgk8fgiHd5crYlXDq86N2NG7be8x2V9s+37IT9H+yKH2LLfyxRANXDdbI1br0mp12i9Ggw2h3TbZ/JGjpdhaKK8E6k3NZzvHyl06riq5xMWiaGjyuhZZiTgpBbcfS0BlnZiFSAy/U/ejKr4pj9somPpibvxTZhhOFtKAvPD7AZu8/gLbxm2i9tJXfwKkrazVDcAIixqeoaLX9LIogt1uezzbtzkoaT75PbiYIF7tTvjfVLsBBYthRh7hRD5BVVcvT0jdxrKq/T6LqBw== +api: eJzdVcFu4zYQ/RViTkkgW9406EGnZpsUCFq0i02KHrwGlhbHFhOJVMhRUkPgvy+GoiU7CbLoHnuyRb7RvHnzZtQDya2HYglKkvRIHlYZKPSl0y1pa6CAs7O7SnuBRrVWGxLaC4Wtw1ISqrm4RRTLK6yRUKSXrE4qotYXea5s6eceH9HJubZ5W0vaWNfMZKtzFWNmKWb2NDs/FRvrBFUoys45NDQmnZ+dfTFfzJDGR0iKE1qhIb3RqMR6F2+2+gmN+JoAN+rrHDKwLTrJFd0oKGB40dWAgAxa6WSDhI616MHIBqGAZ+sefCtLvFGQgWYxWkkVvFTonz1OmK5Bp8uJlIMMHD522qGCglyHGfiywkZC0QPtWs6jDeE2QlkcScPRzxcQQjaSGct5l0oqSXhy2mz/I48hCEJYMdi31nj0fH++uOCf41R//S5m4k8rSmsIDUHI4GKxeI37KJXg1OhZ6T266EG2ba3L2JT83jO2P+A0sV1Cg97LLbI3E1W7vscyds5xZ0kPRPfAN2rKgDTVfHTtnHWfU30QQojMf3qjwr1nhLEkZF3bZ1TxVdMAjGJi2TlNu+ifjygdusuOKiiWK5azQaosO29wfbQc30I+mszn/YHhQr6fyLwfWx+AE7mnvU87V0MB+2GTrZ6Xte3UNHGv/HEbb8SnNIjiV8aLy083wCz3RdxyFwZFD0sZReWMkAzEz+sIgiz9+W3v4vtninJps7ExPHUgseC03yPI5eoSfQKzfWQZ7XNc/GHJ2EhdxyHa2F+mi5ABKzfk+TD/sDifL/iwtZ4aGe2XZu3kauzvqTjebS8J95Oj/yebMvWY8F9iGtqwRlHsPpl2OW1GDxkUx3ty/JJkUExLa5VBZT1xcN+vpce/XR0CHz926HhsVhk8Saflmi2y7EFpz/8VFBtZe3xH95PPaVeciu+s4jdrS4fS7IAp1B0/QQYPuHvxEeB1/EO03lvLP8BpkjWsQgYVSoUuijbcX5YltnQQ+WrVHu2kq+s/ru+uIQN5POYvxjomeJNY3w+IO/uAJoSRJ/EzcwzhG4qk6iw= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Deletes the dataset identified by the given `datasetId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-label.ParamsDetails.json b/platform-api-docs/docs/delete-label.ParamsDetails.json new file mode 100644 index 000000000..2c8c963fc --- /dev/null +++ b/platform-api-docs/docs/delete-label.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"labelId","in":"path","description":"Label numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-label.RequestSchema.json b/platform-api-docs/docs/delete-label.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-label.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-label.StatusCodes.json b/platform-api-docs/docs/delete-label.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-label.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-label.api.mdx b/platform-api-docs/docs/delete-label.api.mdx index b0e6a4ccb..c7bec4e88 100644 --- a/platform-api-docs/docs/delete-label.api.mdx +++ b/platform-api-docs/docs/delete-label.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the label identified by the given `labelId`." sidebar_label: "Delete label" hide_title: true hide_table_of_contents: true -api: eJydlN1uEzEQhV/F8hVIIQlQkMgVLQ1SRQVVW8RFFamOd5J166xdezYlWu27M+PdzU8TtSpXyXqOPd+Mz7iSqOZRjm6kVVOwUU56MoOog/FoXCFH8hQsIESBOYikESaDAs3MQCamq7Q+N0soxG0Kn2W3fdmTzkNQfMRZtj7knOMU8yqoBX0HTlzJgj5I0+6muOG8XmEun8KkE0RRLiAYvQEJJAzwUJoAlA1DCT0ZdQ4LJUeVxJXn802BME/SmQsLhc3S5yNZ1701xKML99ErDRuQhxLCao/kTyc8TPOa7BOGj94VESLv+DA84p/dfL9+iHfipxPa0UEFyronj4bDfd2JygS3AiJSrk5NMuW9NTpdyeAusrbaotx070YuIEY1B7ZCC++md6D5PB/4XtE0oJ1wU2XEYIo5d1SiQctL4xBcuGzro0idyD8eqLBzjCgcCmWteyQelkfQZTC4Sm45ARUgHJfkjtHNhJtHVsoduyxLLksG46gcNJ4eVK21ar4YCMvOeGWwpMoRfRwNBsqbvrauzPoRHgilb9zerV+liLiwCvkaxTfWi+OLM8kgHecVt7Vp0TbtukucsfMIf0+TiFaaP987g9w9YqrfFDOXtrctbSk47UuAXK7RNL6NmP2gdPLDbvHbJZMljE3+nLmvmwCBcOeaPO/7Xz71h7zmXcSFSnZqZ6gZ9uaxeApYbSz5vy9L20SEvzjwVtGMEkWqpmovfv2Y9eSoe1XoenIi5WBVTVWE38HWNS83881+yExUU8tDMFM2wjPoL0z/QcR7WO09MEtlS1Ym+yxVMJz/lSxvLtvZfSueeR4PIrWLqlhts3SoXevqCUlzUBkdxGhN9Fhr8Li1b++B2ZnN0/H5+HpMcrU7C0+8nxIcxKJbS4prdw9FXa8pkb+Zsa7/AUBMUx8= +api: eJydlN9PGzEMx/+VyE+bdGsLQ3u4p8HoJDS0IWDaA6pEeue2gVwSEl9Zdcr/Pjl31x+0ArGn9mLH/tj52g2QnAfI70DLKeoAkwxKDIVXjpQ1kMM5aiQMghYoko9QJRpSM4WlmK7S+Vwt0Yj7ZL4o7weQgXXoJYe4KNdBLtkOGTjpZYWEnhM3YGSFkEN3GzJQnNdJWsBLmBRBmLpCr4oNiIcMPD7VymMJOfkaMwjFAisJeQO0chxfGcJ5cp1ZX0lqj76cQIzZGuLZ+sfgZIEbkKca/WqP5E/veJjmPdknDB+cNQED3zgenfDPbr5fP8Qn8dOKwhpCQxAzOBmN9v3OZCm4FRgIMui98wakc1oV6UmGD4F9my3KTffuoMIQ5BxZCh28nT5gwfGc53cl1YL2jpsqA3ll5txRIEWaj8beW3/d1QcxxkT++UCFvWKEsSSk1vYZyxQqYFF7RaukljOUHv1pTQvI7ybcvAppYVllZVJZEhhbYdhqeth00or8MOiXvfBqryGHBZEL+XAonRoU2tblIOATejlQdu/Vb5JFXGlJ/IziG/uL06sLYJCe84bb2rZom3bdJc7Ya4S/p8kJsu7P914gD8+U6ldmZtP1rqUdBad9C5DLVQWGzpn1IIukh93it0vGSiqd9DmzXzeGmAF3rs1zNDgaHQ9GfOhsoEomPXVD1E57uy1eEjYbTf7vaum6SPiXhk5LZZgildN0L7/eZhnk/VqZZLCwgdjYNFMZ8LfXMfJxO+AsiFIFOdU8BTOpA76C/sb4H0R8xNXehllKXbNn0s9SesX538ny4bob3o/ilf14EKk7lGa1zdKj9q2Lk5jBAmWJPqG11tOiQEdb9/Y2zM5wno8vx7djyEDuDsML8acEB7GapvW4tY9oYlxTEn8zY4z/ABLGU0Q= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the label identified by the given `labelId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-managed-credentials.ParamsDetails.json b/platform-api-docs/docs/delete-managed-credentials.ParamsDetails.json new file mode 100644 index 000000000..aded86093 --- /dev/null +++ b/platform-api-docs/docs/delete-managed-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"managedCredentialsId","in":"path","description":"Managed credentials numeric identifier.","required":true,"schema":{"type":"integer","format":"int64","nullable":true}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"checked","in":"query","description":"If `true`, deletion is blocked if running jobs depend on the given managed credentials. Default: `false`.","schema":{"type":"boolean","nullable":true}}]} diff --git a/platform-api-docs/docs/delete-managed-credentials.RequestSchema.json b/platform-api-docs/docs/delete-managed-credentials.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-managed-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-managed-credentials.StatusCodes.json b/platform-api-docs/docs/delete-managed-credentials.StatusCodes.json new file mode 100644 index 000000000..57d95243c --- /dev/null +++ b/platform-api-docs/docs/delete-managed-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Running jobs block the deletion of this Managed Credentials","content":{"application/json":{"schema":{"type":"object","properties":{"managedCredentialsId":{"type":"string","description":"Identifier of credentials that could not be deleted."},"conflicts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"title":"DeleteManagedCredentialsConflictResponse.Conflict"},"description":"Array of conflicts preventing deletion."}},"title":"DeleteManagedCredentialsConflictResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-managed-credentials.api.mdx b/platform-api-docs/docs/delete-managed-credentials.api.mdx index 7764033cc..30ba3f22c 100644 --- a/platform-api-docs/docs/delete-managed-credentials.api.mdx +++ b/platform-api-docs/docs/delete-managed-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the managed credentials identified by the given `managedCr sidebar_label: "Delete managed credentials" hide_title: true hide_table_of_contents: true -api: eJztVttu4zYQ/RWCT13AldM2LbAGim02SYGgt0U2fQoMmJZGNhOaVEgqqWvo3ztDSpZkKYk3KPrUJ1vkDOfMmeuOe7FyfHbLZQbaSy/B8fmEZ+BSKwsvjeYzfgEKPDjm18A2QosVZCy1EDSEcizq5hKPl9sgtZKPoNmiFj5vZa+yBcut2QQp4ZxJpfCo14heRRhblEvYjWEmYBBKbVm6hvSePa0BVW3QzwgXXrMnqRRbAlsqk95HFLbUWuoVuzNLAi48ShegM4biz/gxYaIIIosPwRZkP3pbwiLhE24KsIJsXWV7Qn4beIeChbBig5eWWN1xjR+oMPAOJSVRWwi/5od81w/XvPot0+UGrExboi1hsvBQSjTOZwRzwh2i3gg+23G/Lciq1B5WYFE0N3YjfDz64ZRX1eQQWi9GR6HrZsC/DXDCdamUWCqIul3Axq5ahA8l2O0A4h92JbT8OwTsGWxvI6vOi5etX+VsERJn0maodPvklHk/Oft5GStnJDsTdgG5KJWfsUWO3zEvB24sjVEg9AiDcwqIK4x2WOOo8O3JKf0cMPcL+5r9blhqkA7teTXhpycnQ7mPImMUXnAeTTXSKIYlpGQamJ/eOZLddUC2GXHLN+AcOkntpsZulneQ0nuFpXoLzQiVGsHWSect0keR4Vgf5CK/tNbY69o/vKkC8u9GPGwqmWnjGXYW84R4gvT7ofR1N1Ihgv3OY3L8xuA2RdFvBkfz8goBYyU6YGOQhvt8J5Tdag3tMDWlygIHy9ofyBLiAUHnCNW7jglhraBElx427nXA8XYQLtQfwY3HsbpGLkqrXg77c534vHaiyYikOaBX+zydkW+BosZxVlh4pIcw8E2kkzeZDYmIeg7S0mInDzPhIwgL9qzE3jq7nVNd4sBYGxosMQ5hjNAtn7ZjebobDJFq2onq/r6XJhX1CLCPzTwKhPK194WbTaeikEmqTJklDh6wLBJpBmn0OdywT0p4aozsnOTZ2acrTsgbxz5TKsfgd93bh44sNu0qtKkghCfxz89Ny7178oFoqXMT1GvCaxRk9jWA5K5McV2JwlSDIg012He+6zKWoVSh4+fmp/YCgRBz0c43yfvvkxM6K4zzSDY9Wc+FmA9jbfsQ7q5tCv/vVfvO7+EvPy2UwKnaVn2sgd5qOuGzsVWqz/dstF9isq4xbvTgbrcUDv60qqroOE5xqo5MOpqYWIlhwr4QuiM2jFHX7mHbWWEehSpJhtOKcbzx/3LBeMGLdhlq/ZjTh5Vx7/giRr+6rneDd+zI/XcUWjOw9LaLq4E8TJ4vY34E5Otr8Ntx9jO4mqPeGkSGjZO4jaJnaQqF7zwy2DR6E+bi8tfLm0sUF/0GfdCQg4FRjFg8QeLG3IOuqj1kT9+Esar+AX8DB/w= +api: eJztVttu4zYQ/RVinlqAlbPboEAFFG02SQGjt0U2fQoMmJZGFhOK1JJUUlfQvxdDSZYUKZcNij71KbE45Jxz5lqDF3sH8Q3IFLWXXqKDDYcUXWJl6aXREMMFKvTomM+RFUKLPaYssRhuCOVYezeTmLLdIVjt5T1qtu2MzwfbdbplmTVFsBLOmUQKj+nRdN3COKzTbcSuDTMBg1DqwJIckzv2kKPP0Yb7KeGSRrMHqRTbIdspk9y1KGyltdR7dmt2BFx4lmKJOmVGP8WDM1EGk+2PwRemP3hb4TYCDqZEK8jXOj0K8tuMHXAohRUFerSkag1aFAgxzNgBB0nSlsLn8Fjv7uFOV39guirQymQQ2hImi58raTGFmGBycEmOhYC4Bn8oyavUHvdogUNmbCF8++m7U2ga/hjaJEavQjfOgH8bIAddKSV2Ctu7Y8DG7geEnyu0hxnEP+xeaPl3CNgT2N4mVpcXz3tfZ2wbEocPGSrdMTllNk3OaV62lbOQnRG7wExUysdsmwnl2ryc0dgZo1DoBQU3FBBXGu3Q0YX3J6f055Fyv7Bv2O+GJUZ71B4aDqcnJ3O7DyJlFF50Hjj01nENoiyVTILyq1tHtvUI5JARN1Cgc2KP1G467GZ3iwm9V1qqt9CM4vpoOJB03kq9p8iAl54owqW1xl51/KBpmoD82wWGfSUzbTwTSpkHTFue38+tr8aRChGcdh6TMZ9Lx/qimDaDV+vyggBLJTpTY5aGx3wnlONqDe0wMZVKgwa7jg+mEemQGJ0pmXg3ciGsFZTo0mPhXgbcns7CxUEu4G54V10LB5VVz4f9qU583pHoMyLqP9CrU53OiFuQqCfOSov39JDeHyMdvcltSMSGg8OkstIfwkz4gMKiPat8DvHNhuqyQJ8bGixtHMIYoVNYDWN5Vc+GSLMaRfV4PkmThnoE2vt+HgVBIfe+dPFqJUoZJcpUaeTwM1oRSTNLo0/hhH1UwlNjZOdkz84+roGQ98Q+USq3wR/TO4aOPPbtKrSpYAS8++fnvuXePvggtNSZCdc7wTsU5PYlgERXJug6Y6pBkYQanJIfU8ZCSBU6fmZ+Gg4aDqRc6+dd9O7kfXRCH0vjfCFCDXeDoU2Ipb79GG89dIX/F6tj6/f4l1+VSkg9Kvu2CCa7KYd4aZea6h0vNswNh9w4Tw/W9U44/NOqpqHP7Rin8kilo5GZQhxG7DOhe8WKsUjtDg+jHeZeqIpsgHaM1zv/LzeMZ1gM29DAY0M/rGwXjy9S9Kurbjn4mr1yAV6E1k8sfRjj6iHPk+fLlF8A+fIe/Hac0wxuNg2HHEWKNmjbmp4lCZZ+9Mhs1ZiMmIvLXy+vL4GDmHboRx05OFjEWNetxbW5Q900R8iefhPGpvkHeJYIIQ== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the managed credentials identified by the given `managedCredentialsId` f id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-managed-identity.ParamsDetails.json b/platform-api-docs/docs/delete-managed-identity.ParamsDetails.json new file mode 100644 index 000000000..0e7cb76a7 --- /dev/null +++ b/platform-api-docs/docs/delete-managed-identity.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"checked","in":"query","description":"If `true`, deletion is blocked if running jobs depend on associated managed credentials. Default: `false`.","schema":{"type":"boolean","nullable":true}}]} diff --git a/platform-api-docs/docs/delete-managed-identity.RequestSchema.json b/platform-api-docs/docs/delete-managed-identity.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-managed-identity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-managed-identity.StatusCodes.json b/platform-api-docs/docs/delete-managed-identity.StatusCodes.json new file mode 100644 index 000000000..c026cce80 --- /dev/null +++ b/platform-api-docs/docs/delete-managed-identity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Running jobs block the deletion of this Managed Identity","content":{"application/json":{"schema":{"type":"object","properties":{"managedCredentialsId":{"type":"string","description":"Identifier of credentials that could not be deleted."},"conflicts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}},"title":"DeleteManagedCredentialsConflictResponse.Conflict"},"description":"Array of conflicts preventing deletion."}},"title":"DeleteManagedCredentialsConflictResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-managed-identity.api.mdx b/platform-api-docs/docs/delete-managed-identity.api.mdx index 368f07692..5332adfb7 100644 --- a/platform-api-docs/docs/delete-managed-identity.api.mdx +++ b/platform-api-docs/docs/delete-managed-identity.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the managed identity associated with the given `managedIde sidebar_label: "Delete managed identity" hide_title: true hide_table_of_contents: true -api: eJzdVl1v2zYU/SsEn1bAlbM2G1ADRZcmKWBsXYs0fQoMmJKuLCY0qZBUUs/Qf9+9lGRJlpd4fehDn2yRh7znnvvFLfdi5fjshssUtJdeguOLCU/BJVYWXhrNZ/wCFHhwzOfA1kKLFaSswW+YcM4kUnhce5Q+D6CVfADNlg123kDn6TJi14aZcK9QasOSHJI79pgDnrLhaEq2cBsvU4rFwGJlkju8PN4wW2ot9YrdmpjICI/oAnTKEN6j0VJMLATLQrkJE0VALt8Fk5C+9baEZcQn3BRgBZmcpztfPw6ZI6oQVqxxx5JaW67xA9EjDxEpSbJC+Jzv6/hxXztdrsHKpFnIJFgiZOG+lMidz4jjhDukvBZ8tuV+U5BVqT2swCI0M3YtfL30+ymvqsmOmrGrjs59CXYz4vPJroSW/wTn/4PL99luNH7a+jxjyxCESRd06Xbxltkw3seGOmIXkIlS+RlbZvhdB3nkR2yMAqFxS5dKiVhBLXdVLSgCrjDaYS3ggVcnp/SzJ92f7CX727DEoB7a82rCT09Oxrj3ImUUT3AeTbVohGE+KpkE6ae3jrDbHskuBW74GpxDJ6ksG+4mvoWE7issJW8oWjzUAjsnnbeoH4WGY76Ri/zSWmOvGv9wpwrMXx/wsC0Lpo1nWK3mEfkE9Jsx+qofqhDCYTWbDL8xum0J9CrraFGe8b6++bzLBKrnfSlGSbjLdqLYS6O6vySmVGkQIG6cgTQiEZB0hlS965kQ1gpySHpYu+cJ17ujWOH5A7xxua6tAxulVU/HfNDTegKdN0606RC1C3TrUKcz8i1I1DrOCgsPdBFGvQ1z9F1mQxbiOQdJaSknqMG+B2HBnpXYRmc3CypK7L65oRZdxyH0ZNrl0252TbejjlxR9YN9aDt3UIvn3hduNp2KQkaJMmUaObjHhI+kGeXIl7DDPivhqeexc8Kzs89zTrRa1l8oT+vI9rnv4kIW20YUGlAA4Ur950PbTW8ffVBR6syE442aDQsy+xxBclcmOLBrMBWYSEKBDZ3vu4w1JlVo5pn5o9tAIqRcbefX6M1v0QmtFcZ5VJqubFp+HezR82Cf67Yr95/8WdGE3cM3Py2UwEHYlWqduINH14TPxo8JTK8clSbodhsLB1+tqiparkcq5XMqHU0vLIww7Z7Q+4hxf5D0HWx674kHoUrCcJr3xxv/odP+CTe6p0nnyII+rKwfAf9L0l+umkH9gh35uDtIrR0getPn1VIe50W1wEM5iBQbCBGucWdJAoXv3TAap4M2enH51+X1JcLFsFHtNaZg4CBBTMmAuDZ3oKtqx9fTN3Gsqn8BU5tWaw== +api: eJzdVs1u4zYQfhViTi3Ayt5tUKACijabpIDRbrvIpqfAgGlpJDGhSIWkkrqC3r0YSrJky03cPfTQU2JyxPl+ZoZswIvcQXwPMkXtpZfoYM0hRZdYWXlpNMRwjQo9OuYLZKXQIseU9fE7JpwziRQeU/YifRGCcvmMmm362FUfuko3EbszzIRzhVI7lhSYPLKXAn2BNnyaUi5pNHuRSrEtsq0yySOmbLtjttZa6pw9mC2BEZ6lWKFOmdFTGAPExGLILJTjTFQhcvNjSInpD97WuImAg6nQCkq5SvdcPx4iBw6VsKJEj5bUakCLEiGGGUPgIEmySvgCjnX8eKydrku0MukXMomWAFl8qqXFFGLCyMElBZYC4gb8rqKsUnvM0QKHzNhS+G7puwtoW76HZmw+wnmq0e5meH63udDyr0D+H7B8We5e49ezrzK2CSbw0XTp9n7L7NDvc62O2DVmolY+ZptMKNeZPOOxNUah0MBB10qJrcJO7rZdkwOuMtqhow/eLy/oz5F0v7Bv2G+GJUZ71B5aDhfL5Tzug0gZ+YnOA4chOm5AVJWSSZB+8eAotpmAHEvgHkp0TuRIbdljN9sHTOi8ylLxhqaNm33gSNJ5K3VO1oCXnijCjbXG3vb8oG3bgPzbEwyHtmDaeCaUMi+Ydjy/n0ffTq0KFh52s8mYL6RjQwtMOutsUd5g3518NVYC9fOxFLMi3Fc7QZyUUTdfElOrNAiw7clgGpEIidGZkol3kxTCWkGEpMfSvQ242515xUGewN3yvrdObNRWve75wUybCHTVkxjKIRoW6NRDnS6JW5BoIM4qi890kM73NkdflDZUYcvBYVJbqgkasB9QWLSXtS8gvl9TU5boC0MjuvMhzGTahcV4dy2a2URuqfvRPg+TO6gFhfeVixcLUckoUaZOI4dPaEUkzaxGPocd9kkJTzOPXVE8u/y0AoI1oP5Mddo5O8W+94UyDoMoDKAQBLz/5+dhmj68+KCi1JkJn/dq9igo7VsAia5M0PXB1GAiCQ12SH5KGUshVRjmmflp3Gg5kHJdnnfRu+X7aEmLlXG+FKFB+5nfuT17HxyDbcZ+/5+/K3rfPf7pF5USUk96tavcg1cXh3j+mlhzKIzzFNo0W+HwD6valpa7O5UKOpWOrq8U4nDdvaL3Gff9SdCPuJs8KJ6FqikG6MI/P/l/et2/QmN8m4xE1vTDyu4V8K8k/eq2v6m/Zme+7k5CG24QvZviGiDP66JdtxwKFCnaALiLu0wSrPzkhNl9ejBHr29+vbm7AQ7icFIdTaaQ4CTApuki7swj6rbd4/X0mzC27d/OvFaQ sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the managed identity associated with the given `managedIdentityId`. To o id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-organization-member.ParamsDetails.json b/platform-api-docs/docs/delete-organization-member.ParamsDetails.json new file mode 100644 index 000000000..651c34df4 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-member.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"memberId","in":"path","description":"Member numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-organization-member.RequestSchema.json b/platform-api-docs/docs/delete-organization-member.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-member.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-organization-member.StatusCodes.json b/platform-api-docs/docs/delete-organization-member.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-member.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-organization-member.api.mdx b/platform-api-docs/docs/delete-organization-member.api.mdx index 0b4cfe88b..0a378728d 100644 --- a/platform-api-docs/docs/delete-organization-member.api.mdx +++ b/platform-api-docs/docs/delete-organization-member.api.mdx @@ -5,9 +5,9 @@ description: "Removes the member identified by the given `memberId` from the org sidebar_label: "Delete organization member" hide_title: true hide_table_of_contents: true -api: eJzdVU1vEzEQ/SuWTyCFJEBBIidaGqSKr6otpypSnd1J1u2u7Y69KWG1/50Z70eSphRUiQunrD3P4zfPbyaVDGrp5eRSWqTf2UCm4BPULmhr5ESeQWFX4EXIQBRQzAGFTsEEvdCQivk6BpZ6BUZcNfGT9Eos0BYxQkmV0T8VZ/v9QULRqaG4yLQX1gE2eJV7K3CfQMyu8lzcWbzxTiUUvtMh02bvzqEcyD7hSUoFHUMOAb5tYb7ErAR0ClVBQWQ9KmloQQciOYpqlsOpkMn7Gm0nE6YsAHWyKRaZA8JtqRGIQMASBtInGRRKTioZ1o5v0SbAMrJYWCxUaLbeHsi6HvRUOoEfZdOU8w94zPi4d9Z48Hzi1fiAf+5p8Um8EF+tSCwlMkHWA3kwHu/jjlQqmAz4QHd1aIIp53KdRC1H156x1RbLDf9LUsN7tQT2bEvezq8h4XwO+dGDboh2wE2VPqA2S9ZWBh1y3poiWjxr66NIHZm/fqDC3p/GBrahvSM+DPeQlKjDOrrnCBQCHpb0QpPLGYtH1sosWzCNFoyG46gcceuNqmi0etQ8Mq27164lp8ZV58sSczqUheD8ZDRSTg+T3Jbp0MMtMRtqu2eJ8xgRp7kK/KriA+PF4emJZF4d7XNWuVFsm3wvGt8oW8vweh5BtNN8fOz8cn0XohzaLGw83ircsuBr/0SQy9Xc1g2Y7aGSaI/d4rdLJofoPNp1Yd9vAkSElWvueTl892Y45j1nfShUdFfbXM1g2J1YRTcaduhWG7/+D/Oxfd4AP8LI5YomC+kTda5ah7Z/DgM56YZha1Le6ocSWSkjVRleVXPl4Tvmdc3b1ObIXUGfK4VazdkP5ORUe/6mnlhQLfCIzM/O2sZ/Lv5i2j5YUbupzFoyjbzkFX3ewLqf8jxrn0Tq0aH7BDq9qPWMsBmolGzIkjXhwyQBF7YO7k3NnYFzPP08vZgSXO129L0Ojhc8yIveMyIu7A2Yuu5pBl4zx7r+BeqY37c= +api: eJzdVU1v2zAM/SsCTxvgxWlX7ODT2jUDgn0VbXcKAlSxmVitLbkSnS4z9N8Hyh9Jmq4bCuyyUyySIh+fHpkGSK4cJDMwduVgHkGGLrWqImU0JHCJpVmjE5SjKLFcoBUqQ01qqTATi01wrNQatbhp/dPsRiytKYPH2JXU6qfkbL+/aOxqmt2MxHWunDAV2jZeFs4IewggZJdFIR6MvXOVTNGJB0W50gc1RxDBkHCaQQLnWCDht52YLyErRFBJK0sktMxHA1qWCAkEcBCBYjoqSTk85mg3mdB1iVal22YtY7B4XyuLGSRka4zApTmWEpIGaFNxFaUJVwHF0thSUmt6dwLeRwOUnuBn0bTt/AMcc77uKqMdOr5xPD7hn0dcfBJvxFcjUqMJNYGP4GQ8Pow7k5lgMOgIIuijkwZkVRUqDVzGt45jmx2UW/wzKNE5uULWbAfeLG4x5XyV5Ucn1QLtA7ddOrJKr5hbIEUFmybWGnvZ9Qfe+4D87RMdDvrUhliG5gGzkMphWltFm6CeM5QW7WlNOSSzOZNXIuWGJZgFCQbBsRdiHr24CULzcfvILm761/bAqe2612VtC0ggJ6pcEseyUqO0MHU2cniPVo6UOZDEVfCIi0ISv6r4wPHi9GIKjKuHfcUst4ztgh9I44rQSYbPixAEUffxsdfL7QMFOpRemnC9Y7hDwWX/BJDbVTzWbTDLQ6ZBHvvN77aMpVRFkOvSvN86fATMXFvnaHQ0Ph6N2VgZR6UM8uqmq90M+yur7HfDHt5mK9j/YUF270v4g+KqkEozP4HoppNo9+8QQdJvw06lbBq20jyC3Dji8KZZSIffbeE9m+9rtDwW8wjW0iq5YEHMGsiU4+8MkqUsHD5D86vLbvJfi79Yt0921Bml3gDDKGo+QQR3uBnWPC/bF4F6duu+AM5Aqp/7CHKUGdpAWes+TVOsaOfiwdrc2zjnk8+T6wlEIPdH+tEIhwJP4mqaNuLa3KH2foBJfGaM3v8CHmPf3A== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the member identified by the given `memberId` from the organization iden id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-organization-team-member.ParamsDetails.json b/platform-api-docs/docs/delete-organization-team-member.ParamsDetails.json new file mode 100644 index 000000000..6dd1cb8d2 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-team-member.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"memberId","in":"path","description":"Member numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-organization-team-member.RequestSchema.json b/platform-api-docs/docs/delete-organization-team-member.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-team-member.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-organization-team-member.StatusCodes.json b/platform-api-docs/docs/delete-organization-team-member.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-team-member.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-organization-team-member.api.mdx b/platform-api-docs/docs/delete-organization-team-member.api.mdx index 18e0a8ea6..bff15b3d1 100644 --- a/platform-api-docs/docs/delete-organization-team-member.api.mdx +++ b/platform-api-docs/docs/delete-organization-team-member.api.mdx @@ -5,9 +5,9 @@ description: "Removes the member identified by the given `memberId` from the tea sidebar_label: "Delete organization team member" hide_title: true hide_table_of_contents: true -api: eJy9Ve9v0zAQ/VcsfwKpNAUGEv3Exoo08VPb+FRVmptcE29J7NlOR4nyv3NnJ2m6jYIqjU917p7td3fPrzV3IrV8OucORGH5YsQTsLGR2klV8ik/h0KtwTKXASugWIJhMoHSyZWEhC03PpHKNZTsKuTPkiu2MqrwGTr1zxsoi/AxH3GlwQi68yzBW08hBwffTCpK+cuHLxH6xZ+PYC2MKBBgiHnNS/zATcqkuHnEJfHWwmX8fjHDA1lZFWBkvGVniIeB20oaQBLOVDDiNs6gEHxac7fRdIssHaSexUqZQrgQenvEm2bUUwmF7eVCBT0ph24ae1mElj4BjwVtt1qVFizteDU5op978/jEXrCvisUKDyodb0b8aDJ5iDsRCSMyYB3e1aERJrTOZeznGV1bwtYDllv+c+yGtSIFEnhLXi2vIabztCHxORmIdsBtldYZWabUW+6kyyk0M0aZ87Y+zDSe+etHKuxkzUrlmMhzdYd8CG4hrox0G6/gExAGzHGFE5rOF9Q8lHem6Ckk/il40VOWRyhzG9Ve7E3kX21UB701UZg5BrrhN1G/34JZdy+mMjkelTmn7TSKhJbjOFdVMrZwi3zHUj0QyoXPsO+5cDRr9oHw7Pj7GSe2XTEX1PvQx2FJfSvpRt4Kib6XHoSRsPjYqej6zvkmyXKl/Pa27y0LuvZvBKlcGaNzBTCJRsReNLvFD0tG3cjci3il3m8TSIQ6F+55OX73ZjyhmFbWFcJrrn1ywbaYGtqMd8Cic64dzvVWyv/NZ9tBOPjpIp0LdAasxHekbhU2JyO1CJ12hhr+GjDQ21qrM4oNbKaVGuohw9bQSXW9FBZ+mLxpKIwv2JDgcbkWRoolDRXlmEhLa5T7SuQW9rTp2Xn7pp+zfzDzR4ttg6LccKKRV/SFyxvY9H8iZKMHkdrj6geQaft9MJu97n4An37WzQKxGYgERU0DDOnjOAbtBhsf2POOs53OPs8uZwgXuyZxzxT8BY/yQnV5xKW6gRIV1reNvolj0/wGrRMLRw== +api: eJy9Vctu2zAQ/BViTy3AWk4a9KBTk8YFjL6CND0ZBkJLa4mJSCokldQV+O/FUpIfSeoWBtKTpN0lObM7HLXgReEgnYFHoRzMOeToMitrL42GFC5RmXt0zJfIFKoFWiZz1F4uJeZssYqJQt6jZtddfppfs6U1KmZo1z8voOw0vx4BB1OjFXTmNIcUzrFCj99sIbT8FcNXKNSXuD9wqIUVCj1aQt6CFgohBWOLaQ4cJOGuhS/hMZntDZluFFqZbdBZwmHxrpEWc0i9bZCDy0pUAtIW/KqmU6T2WEQUS2OV8F3o3QmEwNdQOmJ7sRChF8UwTGMviq6lL4BjTstdbbRDRyuOxyf0eDSPT+wN+2pYZrRH7SFwOBmPn9adiZwRGHQeOAzVaQuiriuZxXkmN45q2y2UG/wzUOicKJAE3oM3ixvMaL/akvi87IAOhRuWzlupC+oteOkrCk2sNfay5wchhIj87TMMB1kzbTwTVWUeMI9bOcwaK/0qKvgMhUV72vgS0tmcmqfQl4auQh6vQhQ9ZSExtnBJG8Ueknhrk7bTW0i6mbukHYYfkvV6h/Z+uDGNrSCF0vvapUkiajnKKtPkI4d3aMVImidC+R4z7KISnmbNPlA9O72YAqEdyHyn3nd93Ka0biWdCL2Q6HsRi4D3Lx8HFd08+NgkqZcmLu/73qOgY/8GkOjKDF1fTKIRWRTNLvltyqiErKKIl+b9JhE4UOe6c45GR+Pj0ZiCtXFeiSi6/s51vsXMts9EC1SDde2Abjda/m9G20/C40+f1JWQmpjElrS9xGbkpA44pIOjdv8GDuna13qhUWzLZ3qtzTmUxnnaqW0XwuEPW4VA4bsGLSl+zuFeWCkWNNVZC7l09J5DuhSVwz1tenXZX+rX7B/c/FmyfVDoFRCMqqEv4HCLq/VfhHz0IFB7bP0AMH2/D0az194PwLOedZgHDiWKHG0cYJc+zTKs/dbCJ/68Y23nk8+TqwlwELsu8cgV4gHP4mrbruLK3KIOYdM2+iaMIfwGAOgLbA== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the member identified by the given `memberId` from the team identified b id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-organization-team.ParamsDetails.json b/platform-api-docs/docs/delete-organization-team.ParamsDetails.json new file mode 100644 index 000000000..77a4c6e23 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-team.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-organization-team.RequestSchema.json b/platform-api-docs/docs/delete-organization-team.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-team.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-organization-team.StatusCodes.json b/platform-api-docs/docs/delete-organization-team.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-organization-team.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-organization-team.api.mdx b/platform-api-docs/docs/delete-organization-team.api.mdx index d7cb32615..461dacc5e 100644 --- a/platform-api-docs/docs/delete-organization-team.api.mdx +++ b/platform-api-docs/docs/delete-organization-team.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the team identified by the given `teamId`. This operation sidebar_label: "Delete organization team" hide_title: true hide_table_of_contents: true -api: eJzNVN9v0zAQ/lcsP4FUmgIDiT6xsSJNIJi28lRVmptcG2+J7dmXlhLlf+fOSX9uGmgSEk9x7r47f3f+7mqJahHkcCIRVBnktCczCKnXDrU1cijPoQCEIDAHwRChMzCo5xoyMVtH80IvwYgb9l5kN30xznUQ1oFXnEN4KO1yP8Pc21KoohAr6++CUyk5Vzl4EBoFhSrhlEedaqcM9mVPbnNdZFtG3/1CGf0rmseUlWAUpUpyea6nloZ+CG79gsJ6UnM1TmEuj0vcTyVMVYLX6a5Mzww83FfaA12PvoKeDGkOpZLDWuLa8S3aICzAE3RufamwNb0/kU3T21JpO/QkFy7lH3CYcnhw1gQIHPFmcMKfoz58Ea/ENytSS4kMyqYnTwaDh7gzlQkmAwHprg2aYMq5Qqexj8ltYGy9x3LHfyJLCEEtgOXWkbezW0g5n/P83KhbohvgrsqAXpsF91WixoJNI++tv+rqI08Tmb99pMKtKI1FlqBdER+GB0grr3EdlXMGyoM/reh9hpMpN49klVsWXxbFF8XGXpmQvEJSR5E1SZyhpG7fuZGc1i83eqx8QQE5ogvDJFFO99PCVlk/wD2x6mv7QAzX0SMuC4X8ouIT48Xp5YVkThvK19zhtlv7xLcN4xtlJxf+n0UQWdrD541WblcYW6HN3MbwrrsdC772TwS5XM3j3IJZGiqN0jgsfr9kUocuolTn9uPOQUS4c+09r/sf3vUHbHM2YKmisrqhateBsPtDjO1COCBb75T6Xyy17nUQfmLiCkUrgcqLbao7cU14dwWCDjc7rN3RZOg2Cakgp4YwtK5nKsAPXzQNm2k6PYuZjkvltZrxU5IIMx34TFKeqyLAEz16cdXN60vxFwvy0Wo6ozJryTSKiv/oeAfr7WLm9fgsUk9symeQ6RraTAmZg8poQLhdrfM0TcHhXtiDRXewI85HX0fjEcHV4SAeDV684FFW9JYRMbZ3YJpmR5L/mWPT/AYjsKd2 +api: eJzNVE1v3DYQ/SvEnFqA3d2kRg86xUlcwEjQBol7WiyQWWl2RVsS6eHI7lbgfy+G0n74A04QoEBPEofD4XuPb2YAwW2EYglC2EZYWagoluyCON9BAe+pIaFopCajKcZV1InbOKrMepfDW3dHnfmqu5fV15m5ql00PhCj1jBMrb87rbBh3xpsGnPv+SYGLCma+5qYjBPjokETkMWVLmAnM7BwqHVZHRD9yVvs3D85fEXYgoWAjC0JsfIZoMOWoADP28sKLDhlE1BqeEzxtJTp+pbYlUearAiYbnvHVEEh3JOFWNbUIhQDyC7oLa4T2hKDhY3nFmUM/XYGKdkDlFGhF7Eolf8Aw0qPx+C7SFFPvF6c6eeRDh/ML+YPb0rfCXUCycLZYvE07y1WRsFQFLCwzy4GwBAaV2Yd59dRc4cTlEf8S2gpRtyS2m0C79fXVGq9wPrc4kag+8Qjyyjsuq3qCuKk0dAFs+fPEz9IKWXkvz7D8GDKzota0N9TlUtFKnt2ssvOeUvIxOe91FAsVypeS1J7NV+VzZfNprsw97yN8yGbLM1zD82H8Z0TaFm+2/ux5wYKqEVCLOZzDG5WNr6vZpFuiXHm/BMzfMk75lODoi9q3mm+Of90CYppD/mLKjyqdQr8IJjeCJNddL3OSWCnn9/3Xrm+lyyF6zY+H5/UnVDotd8CqHSdtvOYrNbAMlvjIflTytSia7JVN/7NcSNZUOXGe17NXi1ezxYaDD5Ki9laU1eN88D40y6WcSI8QDscrfq/mGrT8wj9LfPQoOuUXtZpmNy11OEVwUKxH2LjkLZQTKNkZaH2UTR1GNYY6S9uUtLwbU+sbl5ZuEN2uNa3XA5Quaj/FRQbbCK9oNFPn6eG/dl8x4R8ls0UxG4HCqPpdQUWbmh3mMw6H38I1Auj8gfATIKmVbJQE1bEWa5x87wsKcjJsSeT7sGQeH/x8eLqAizgw0581Hn5gmdRDcOYceVvqEvpCFLXijGlfwEw7qeb sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the team identified by the given `teamId`. This operation removes the te id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-organization.ParamsDetails.json b/platform-api-docs/docs/delete-organization.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/delete-organization.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-organization.RequestSchema.json b/platform-api-docs/docs/delete-organization.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-organization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-organization.StatusCodes.json b/platform-api-docs/docs/delete-organization.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-organization.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-organization.api.mdx b/platform-api-docs/docs/delete-organization.api.mdx index 7be80cbec..21533e17c 100644 --- a/platform-api-docs/docs/delete-organization.api.mdx +++ b/platform-api-docs/docs/delete-organization.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the organization identified by the given `orgId`. This ope sidebar_label: "Delete organization" hide_title: true hide_table_of_contents: true -api: eJzNVN9v0zAQ/lcsP4FU0gIDiT6xsSJNIJi28TRV2jW5Nt4c27OdjhLlf+fOSX+uAh55iuP7fPfd3XfXyAiLIMe30nr6TgeywJB75aKyRo7lOWqMGEQsURACjPoFbBKqQBPVXGEhZqtkXqglGnFHqIviLhM3pQrCOvQdng4VGHqjV8JjZZfHnIIpBIRgcwWRHFdYzdCHUrmQyYHcOLsoNsy+7zwniAMPFV17TqmRhn4ImiiRVXFGDmIpD9PcdSNMXaFX+TZFz9E9PtbKI4WOvsaBDHmJFchxI+PKcRRlIi7QE3RuKdfYXb0/kW075efBWRMw8Is3oxP+HHD4Il6Jb1bklhyZKNuBPBmNnuPOoBBMBkOkWGs0wcA5rfKUw/A+MLbZYbnlfysrDAEWyO3uydvZPebsz3kuc1Qd0TVwm2WIXpkF5URPVdR8NfHe+qs+P7K0ifnbIxlu1GBsFKC1fSI+DA+Y117FVeraGYJHf1pTn8a3Uy4etbS03PQiNT01mq1yyKodNqnBrWQ/frlufu01IcoYXRgPh+BUlmtbF1nAR6KRKftMBdfJIi41RG6h+MR4cXp5IZnEmuM1l7Qrzy7TTYU4ouz1wf+zBKKb7vB5LY77p5hyV2Zu0/O+nD0LDvs3gpyuymmSOjBrAfKkhf3kd1MmOSidtDm3H7cGIsKV6+K8zj68y0Z852yINLfssh+mbu725vaQZ7NV5X+1QPoGRfwZh04DrQPKMFWq6QXVr8GBHHc7g9peUgXY0DQzCPjD67bla5o/z3Kl4xK8ghn3jlRXqMBnEuscdMA/VObFVT+RL8U/rJ+j3PtLMCvJNHTNf3R8wNVm7bVTApYIBWmQCXa20zxHF3dePVsee3N3Pvk6uZkQHPa1fqDtFOAoKapeQtzYBzRtu+EY+Z85tu1vsihFYg== +api: eJzNVE1v2zAM/SsCTxugJWlX7ODT2jUDig1b0XanIEAVm7HV2pIq0ekyQ/99oOx8tth23MkWSZHvkU/sgFQZIJuB9WWAuYQCQ+61I20NZHCJNRIGQRUK60tl9C/FLqELNKSXGguxWCd3qVdoxL315VVxPxJ3lQ7COvR9vEPfKIOG6rXw2NjVa0mVKYQKweZaERaiwWaBPlTahRFI2Ca7KrbIvu9dBwlOedUgoWdKHRjVIGSQIIEEzYycogqOae6nEaZt0Ot8R9FzdY9PrfZYQEa+RQkhr7BRkHVAa8dVtCEs0YOEpfWNot704QxinPP14KwJGPjG6eSMP0cYvoh34psVuTWEhiBKOJtMXsZdqEIwGAwEEjbRWQfKuVrnicP4IXBst4dyh38GDYagSuRxD+Dt4gFzzuc8t5l0D3QTuGMZyGtTQowSSFPNpqn31t8M/CDGmJC/f4XhVg3GklB1bZ+xSKkC5q3XtE5Tu0Dl0Z+3VEE2m3PzGqTK8tCLNPQ0aPbCmFU77tKAI3Aev9oMv/U1ZFARuZCNx8rpUV7bthgFfEKvRtq+UMFt8ojrWhGPUHzieHF+fQUMYoPxllvat2cf6bZDXBEGffB5kYJADj+fN+J4eKbEXZulTdeHdg4ouOzfADJdnWMYglkLKk9aOCS/TxkbpeukzaX9uHNECdy5vs7J6GRyOpqw0dlAjUpaGl5T//AOHu4x0G4ny/9qgwwTIvxJY1crbZhhalU3KGrYgxKyfmnMJVQ2EDu6bqEC/vB1jGx+atGzXucSVsprteDhzToodOD/ArKlqgP+oTNvboYn+Vb8w/55FftgVGYNDKNu+QQSHnG93XtxHiVUqAr0CWDvO89zdLR368X2OHh4l9Ov07spSFCHYj8SdyrwKqiu6yPu7COaGLcYic+MMcbfeUBFhw== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the organization identified by the given `orgId`. This operation permane id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-pipeline-secret.ParamsDetails.json b/platform-api-docs/docs/delete-pipeline-secret.ParamsDetails.json new file mode 100644 index 000000000..4ae64f5f9 --- /dev/null +++ b/platform-api-docs/docs/delete-pipeline-secret.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"secretId","in":"path","description":"Secret numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-pipeline-secret.RequestSchema.json b/platform-api-docs/docs/delete-pipeline-secret.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-pipeline-secret.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-pipeline-secret.StatusCodes.json b/platform-api-docs/docs/delete-pipeline-secret.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-pipeline-secret.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-pipeline-secret.api.mdx b/platform-api-docs/docs/delete-pipeline-secret.api.mdx index 4d7343026..e90ec2609 100644 --- a/platform-api-docs/docs/delete-pipeline-secret.api.mdx +++ b/platform-api-docs/docs/delete-pipeline-secret.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the pipeline secret identified by the given `secretId`." sidebar_label: "Delete secret" hide_title: true hide_table_of_contents: true -api: eJytlN1qGzEQhV9F6KoFx3bbtFBfNWlcCC1tSFJ6YQyRtWOvEllSJK1Ts+y7d0a7698lIdAre6UjzTejM1PyKBaBjybcKQdaGTgJID3EwKc9nkGQXrmorOEjfgEaIgQWc2CtmtVqpjIwUc0VZGy2ToqFWoFhd/X+ZXbX5z1uHXhBt11mm/uumptukhBFTnixxA1PWCU3+IHi9h4UKIJxIub8kLC+g5liCV7JLZRHpYfHQnnAwNEX0ONB5rAUfFTyuHYUQZkIiySdW78UsV76dMqrqrfBeLL+ITghYUvyWIBfH6H8aYXdNK+JPiX44KwJEOjE++Ep/ezH+/WdnbCflkmLF5nIqx4/HQ6PdeciY1QKCFTrVo0y4ZxWMr3O4D6Qttyh3FZvwpcQglgAGaSBt7N7kOntPD1xVDVoK9xmGaJXZkEV5VFFTUtj762/bvLDnSqRf+jIsDUPMzYyobV9Qh6SozcKr+I6+eUchAd/VqA9RpMpFQ/NlFsyXJYMlyxGu3xw6PlB2dqsojcCv2pdWHiNB/IYXRgNBsKpvtS2yPoBHpGqr2yHF2mHXWkR6UXZV9Kzs6tLTkwt8g1VuK7WLvimYBSxtQt9z5IIV+o/31qv3D/FVApl5jYdb6rbUFDYlwApXSWxv2sxWUPIZI395HdTRnconaw6t1+2GwhClavjvOt//tgf0pqzIS5FclbTTvUIaIbIIWG5ted/mD1NQSP8jQOnBbYuEqXMysYPHTOwx0ebwYOvlmMCpCvLmQjw2+uqouV6ApBNMhXETFObzIUO8ExCL8yHTtoHWB+NoJXQBSmTq1bCK4r/SpY31013v2XPTdBOpmZRmPUuTMu6KV41RW0OIsObCK7ePpMSXNw5eDSE9vr3YvxjfDtGudhvkoOmSAE6ufDdkuLWPoCpqg1mpG9irKp/7SVvpA== +api: eJytlE1v2zAMhv+KwNMGuEnaFTv4tHbNgGLDVrQddggCVLGZWK0tqRKdLjD03wfKdr7RosBOiaVX5EPqFRsgufCQTsAqi6XSeOIxc0gepgnk6DOnLCmjIYUrLJHQCypQ9GrRqoXKUZOaK8zFbBUVC7VELR7a/ev8YQAJGItOcrTrfB3vpot0F4WQgJVOVkjoGKsBLSuEFPo4kIBiGCupgH3CNobQdYVOZRsoBwk4fK6VwxxScjUm4LMCKwlpA7SynEFpwkWUzo2rJLVLn88hhGSN8WLck7cyww3Jc41udYDypxcep3lP9inDe2u0R88nzkbn/LOb79d3cSJ+GpEZTagJQgLno9Gh7lLmgluBnnvdq9MGpLWlyuLtDB89a5styk33JlCh93KBbJAO3sweMYt35/iKSbWgvXBTpSen9II7CqSo5KWxc8bddvVBCCGSfzpSYW8eoQ0JWZbmBfMYymNWO0Wr6JdLlA7dRU0FpJMpN69CKgwbLo+GixbjXRjue37Y9DYLfEfolr0La1dCCgWR9elwKK0aZKWp84HHZ3RyoMwRL/KOuCkl8Y2Kr6wXFzfXwEw98h13uO3WNvi6YZyxtwt/z6IIku7Pt94rjy8UW6H03MTjXXc7Ck77FiCXqzL0nZitIbNojd3it0vGSqoyWnVuvmw2QgLcuTbP6eB0dDYY8aI1nioZrdW9p3YGdFNkH7HZ+PM/DJ+uo4R/aWhLqTQTxdKazhBHhmAC6XryTBMojCfWNc1MevztyhB4uR0B7JNceTkr+Z3MZenxlYLeGBBHaZ9wdTCDlrKsWRlttZROcf53sny47Z73R/HaCD3K1C1KvdqG6VnXzQvTkECBMkcX4drtiyxDS1sHD6bQzgO+Gv8Y348hAbn7SvZeRUxwlKtpWsW9eUIdwhqT+JsZQ/gH1R5vyQ== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the pipeline secret identified by the given `secretId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-pipeline.ParamsDetails.json b/platform-api-docs/docs/delete-pipeline.ParamsDetails.json new file mode 100644 index 000000000..0830c53c3 --- /dev/null +++ b/platform-api-docs/docs/delete-pipeline.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"pipelineId","in":"path","description":"Pipeline numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-pipeline.RequestSchema.json b/platform-api-docs/docs/delete-pipeline.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-pipeline.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-pipeline.StatusCodes.json b/platform-api-docs/docs/delete-pipeline.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-pipeline.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-pipeline.api.mdx b/platform-api-docs/docs/delete-pipeline.api.mdx index ea8e71c3e..77d910d4c 100644 --- a/platform-api-docs/docs/delete-pipeline.api.mdx +++ b/platform-api-docs/docs/delete-pipeline.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the pipeline identified by the given `pipelineId`." sidebar_label: "Delete pipeline" hide_title: true hide_table_of_contents: true -api: eJyllFFv0zAQx7+K5SeQSltgINEnNlakCQTTNsTDVGmuc228ubZnOx1VlO++Oydp0rUwTTy1sf/2/e78vyt5FMvAJ9fcKQdaGQh8NuAZBOmVi8oaPuGnoCFCYDEH1sqYysBEtVCQsfkmbS3VGgy7aRVn2c2QD7h14AVddJZtrzpvJLjthBcrXPIEUXKDHyjr7kCJIgYnYs6fgrX3MFOswCvZQXkK7eG+UB4wbvQFDHiQOawEn5Q8bhyFUSbCEjxKF9avRKyXPh7xqhpsWR6svwtOyB7MfQF+s0fzuxX+Becl4WdEH5w1AR8ET7wbH9HPbsCf39gb9sMyafEiE3k14Efj8b7uRGSMagEhYqxWjTLhnFYyvc7oNpC27FF25bvmKwhBLIG80cDb+S1Ius95euKoatBW2GUZoldmSSXlUUVNS1Pvrb9o8sOdKpG/P5Bhax5mbGRCa/uAPCQPIAuv4ia55gSEB39coEUm1zMqHloqt2S4LBkuGY12+Wjr81HZuayi5wG/bm1YeI3aPEYXJqORcGootS2yYYB7BBoqu/f4l2mHnWsR6THZF9Kz4/MzTjgt7SUVty5Un3lbK4rYOoW+50mEK/Wfr61Nbh9iqoIyC5uON4VtKCjsc4CUrpLY1bWYXCFkcsVu8v2U0RhKJ5cu7OduA0GocnWct8NPH4ZjWnM2xJVIpmpaqe7+7Qx5ylh23vy/mdNUM8KfOHJaYM8iTkqrbHzQn3cDPunNG3ytHMFJUpZzEeCX11VFy3XXkz0yFcRcU2cshA7wjzSemwkHSe9gszd31kIXpEx2WguvCOCFMK8umo5+zZ6ZnAexmkVhNn2eFrdXwmqG6hxEhtYlwlpwLCW42Du6N312Gvd0+n16NUW52G2RJy2RAhwkw9dLiit7B6aqtqCRvomxqh4BZqdn4Q== +api: eJyllFFP2zAQx7+KdU+blLWFoT3kaTA6CW3aEDDtAVXCTa6NIbGNfSmrIn93dE7SprQbQntqY//t+935f9cAyaWH9BasslgqjR5mCeToM6csKaMhhXMskdALKlD0MqFy1KQWCnMxX8etpVqhFne94iK/G0ECxqKTfNFFvrnqspNAAlY6WSGhY4gGtKwQUtjeAQkoZrCSCngJ1t8jdF2hU9kWynFoh4+1cphDSq7GBHxWYCUhbYDWlsMoTbhEBwksjKsktUufTiCEZMPyZNyDtzIbwDzW6NZ7NL974V9w3hJ+xvTeGu3R84njyQn/7Ab8+U18ED+MyIwm1AQhgZPJZF93JnPBtUBPkECvThuQ1pYqi68zvvesbQaU2/LdQoXeyyWyNzp4M7/HjO+zjp+YVAvaC7dZenJKL7mkQIpKXpo6Z9xVlx+EECL5xwMZ9uYR2pCQZWmeMI9Xecxqp2gdXXOG0qE7ramA9HbGxauQCsOGy6PhotF4F8Ybn4+brcsCPw+6VW/D2pWQQkFkfToeS6tGWWnqfOTxEZ0cKbP3+NdxR1yWkvgxxRfWi9PLC2Ccnvaai9sWasi8qRVH7J3C3/MogqT787W3yf0TxSoovTDxeFfYjoLDvgbI6aoMfSdmV8gsumI3+WHKWElVRpcuzOftRkiAK9fGORodTY5HE160xlMlo6u6XmrbfzNEXkI2W3P+39Dpykn4h8a2lEozTsyr6YwwHHgJpIOBM0ugMJ5Y0jRz6fGXK0Pg5bbt2R+58nJecmssZOnxH2m8NhQOkj7gem/wrGRZszL6aSWdYoA3wry76lr6vXhldB7E6halXg95etxBCcMsJFCgzNFFwlZwmmVoaXB0b/zsdO759Pv0ZgoJyN0eedETMcBBsqZpFTfmAXUIG1Dib2YM4RlHgGgG sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the pipeline identified by the given `pipelineId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-token.ParamsDetails.json b/platform-api-docs/docs/delete-token.ParamsDetails.json new file mode 100644 index 000000000..c082fa2b7 --- /dev/null +++ b/platform-api-docs/docs/delete-token.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"tokenId","in":"path","description":"Token numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-token.RequestSchema.json b/platform-api-docs/docs/delete-token.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-token.StatusCodes.json b/platform-api-docs/docs/delete-token.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-token.api.mdx b/platform-api-docs/docs/delete-token.api.mdx index 56ca7acfe..c34872154 100644 --- a/platform-api-docs/docs/delete-token.api.mdx +++ b/platform-api-docs/docs/delete-token.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the given API access token ID." sidebar_label: "Delete token" hide_title: true hide_table_of_contents: true -api: eJyNVE1v2zAM/SuCThuQJdnWDVhOa9cMCDZsRdudghwUm4nVKpIq0e0Cw/+9pKx8F91OlshH8ZF8dCNRLaMcTSW6e7BRznqyhFgE7VE7K0fyEgwgRIEViKV+BCvOryZCFQVEMnKQmFz2ZU86D0Fx0KTcht2yn3xeBbWie+BUjbR0IUyKJnRPas7kFVbyOH16Qdh6BUEXQpdgUS80BAIGeKh1AMqGoYaejEUFKyVHjcS15/e1RVgm6MKFlcLO9PlMtu2Mw6N3NkLkiA/DM/4c5v79Q7wTv5woHD1kUbY9eTYcnuIuVCmYDESkXBs0wZT3RhepKYO7yNhmj+WO/1SuqJtqCdz+TN7N76Dg93zgzqLuiG6AuyojBm2XVBOFajRsGofgwnWujzxtYv7xhQo3MxPWoVDGuCfiw/AIRR00rtO8LkAFCOc1zWc0nXHzaJiV4zmXac5pxOyVg05HgyYPt5X8VnjcjL4OhlAVoo+jwUB53S+Mq8t+hAei0tfuRAE3ySOujEIeo/jGeBahZCIbnjfc1q5F+2y3XeKMMmuE7/MEIkt3+L4RyN0Tpvq1XbgUnluaWXDafxHkcjWtRwazHlSR9HBY/H7JJAltkj4X7uvOQUS4c12e9/0vn/pDtnkXcaWSnPIqdevW7eMxwWYnyf/f5tw2hL848EbRglLexL/Jo97+Mnq0gHmTaSAVcWNn08xVhD/BtC2baTsCi4mOjypoNeeukh5KHflMUlooE+EV6m+u8768Fa/8FF7knY3KriWnNzXf6HgP673fUDsjaAWqpIeYWuc9p9543Is7WeqDfbgc/xzfjgmuDvV3pLeU4EVa1LeESDW27SFL5ti2z0ed8XY= +api: eJyNVMFu2zAM/RWBpw3QkrQrdvBp7ZoBwYataLdTkIMiM7FaW1Ilul1g6N8HynaTtEW3k22R1Ht8fHQHpLYRiiWQu0MbYSWhxKiD8WSchQIusUbCKKhCsTUPaMX51UIorTFGkYvE4nICEpzHoLhoUT6V/eI4SPAqqAYJA0N1YFWDUPSQixIkGEbyiip4Dp9vELZtMBgtTImWzMZgAAkB71sTsISCQosSoq6wUVB0QDvP9xtLuM2pGxcaRf3RpzNIacXl0TsbMXLF6eyMH8fYP7+JD+KHE9pZQkuQJJzNZi/zLlQpmAxGAgljdtGB8r42OosyvY2c2x2w3PNfQoMxqi2y/AN5t75Fzff5wMqS6YmOifsuIwVjt5CSBDJU89E8BBeuh/4gpZSZf3ylw3FmwjoSqq7dI5b5qoi6DYZ2eV4XqAKG85YqKJYrFq9BqhzPucxzziPmKEx7H027YbgJ+K7wMI6+DTUUUBH5WEynypuJrl1bTiLeY1AT41444CZHxFWtiMcovnA+mxCYyMjzhmXtJTpk+6QSI8LgEf5e5ySQw8vX0SC3j5T7N3bjcvkg6cCCYf9FkNs1GuOQzH5QOvvhuPnDlrFRps7+3LjP+0CSwMr1OCeTk9npZMaH3kVqVPbTsEv9vvUL+Zxht/fk/6/zoBvhH5r6WhnLuLmBbpj10z9DQjGu8kpC5SJxsOvWKuLvUKfEx/ctBnbTSsKDCkatWdZlB6WJ/F5CsVF1xDeov7seFua9eOOv8Crv4VDZHTB83fIXSLjD3cF/KK2ShApViSFT66PnWqOng7oXW320EJfz7/Nfc5Cgjg34zHAZ4FVaXddn5B5TOmbJHFP6C9WI8Zs= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the given API access token ID. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-user.ParamsDetails.json b/platform-api-docs/docs/delete-user.ParamsDetails.json new file mode 100644 index 000000000..576981676 --- /dev/null +++ b/platform-api-docs/docs/delete-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userId","in":"path","description":"User numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-user.RequestSchema.json b/platform-api-docs/docs/delete-user.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-user.StatusCodes.json b/platform-api-docs/docs/delete-user.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-user.api.mdx b/platform-api-docs/docs/delete-user.api.mdx index 55b098711..bf99e104d 100644 --- a/platform-api-docs/docs/delete-user.api.mdx +++ b/platform-api-docs/docs/delete-user.api.mdx @@ -5,9 +5,9 @@ description: "Delete a user entity" sidebar_label: "Delete a user entity" hide_title: true hide_table_of_contents: true -api: eJyFVE1v2zAM/SuCThvgJdmWDVhOa9cMKDZsRT9OQQ6MzSRKHUmV6HaF4f8+UrbzsbTYyRL1SD6Sj641wSrqyUxXEUPU80w7jwHIOHtZ6Im+wBIJ7/hRZ9pDgC1fg3jU2vKFIeLJ2EwbyzcPtOZzgTEPxkscNoq/stUWg8mVKdCSWZoUMuBDZQJyKgoVZjrma9yCntSanr1EN5ZwlaBLF7ZArenzWDfNXNyjdzZiFI8Po7F8jlP//qHeqV9O5Y4DWdJNpsej0SnuHAolZDAS5+rRDAPvS5Onjgw3UbD1Acs9/5neYoywQmliR94tNphLPB+krWRaoj1wX2WkYOyKa2JXQ6WYpiG4cN3Vxy9NYv7xhQr7gSnrSEFZuifmI/CIeRUMPadpnSMEDGcVj2cym0vzjsO0k1agZJ5KRsSOGXOltRMlFOk9qUBC6GFSzLBux99oSRcee21UoWTMmsjHyXAI3gzy0lXFIOIDsx0Yd6KRm/SirkogmbT6Jnh1dnWphWtfyo10vu3iYUG7RkpG3clI7osEYkt7+N5raPNEqUXGLl1y77resZC0/yMo5ZocYwcWyUCeJHNc/GHJrBpTJgkv3df9AxORzrV53g++fBqMxOZdpC0kxXW79sqQjojuekH4h4a+BN5LDpZI1d30+n3P9KRbX+7xmtPJU10vIOJdKJtGzLwTQSTEx0cIBhbSKB5xYaKcWRtLKCOesNjtkH5z3W3JW/X6n+BF0p0RrFT5CGUlNz7e4/P+z9PMGblGKDiOEGsfz/IcPR24nSyy6Gon74vpz+ntlOFwLKh/BJQSvMiKu5YQt+4ebdPsSJLchWPT/AUZotn1 +api: eJyFVEtv2zAM/isCTxugJWlX7ODT0jUDig1b0ccpyIGxmUStLbkS3S4w9N8HynYeS4udbFF8fPz4US0wrgNkc2gC+QALDa4mj2ycvS4ggysqiekhkAcNNXqsiMUxm7dgsSLIUuR1ARqMhQxq5A1oKCjk3tSSBzKQeGWbirzJlSnIslmZlNLTc2M8FZCxb0hDyDdUIWQt8LaW7MYyrZPryvkKuTN9uYAYFxIeamcDBYk4n1zI57j07x/qk/rlVO4sk2WIGi4mk1O/SyyUgKHAoGHwzlrAui5NnhgZPwbxbQ9Q7vHPoaIQcE1CYg/eLR8pl3y1F1rZdEAHx32Xgb2xa4hRAxsuxTTz3vnbvj+IMSbkn9/ocBiYso4VlqV7pSKlCpQ33vA2TeuS0JOfNryBbL4Q8o7TdJNWqGSeSkbEW9BQEW+cKKFI90kFkgLGSTHjtht/BCnnXwZtNL6EDDbMdcjGY6zNKC9dU4wCPZPHkXEnGrlLN+qmRJZJq2/ir6Y31yBYh1buhPmOxcOGdkRKRehlJOdlcgLd/3wfNPT4yokiY1cuhfes9yik7P8ASrsmp9A7i2QwT5I5bv6wZarQlEnCK/d1fxE1CHNdnbPR2eR8NBFj7QJXmCTXL9s7UzpCuiOD6Q+P6xKNlWQJVduPb1h4DVm/vwsNGxdYrtp2iYEefBmjmJ8b8qKhhYYX9AaXwtS8hcIE+S8gW2EZ6ATFbongw22/Jh/V+0/Bm6B7I1rp8gXLRk6g4Ym2+6cnLqKGDWFBPgHrLqd5TjUfhJ1ssghrp++r2c/Z/Qw04LGi/lFQKvAmqrbtPO7dE9kYdyBZzoIxxr+Y3toa sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Delete a user entity id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-workflow-many.ParamsDetails.json b/platform-api-docs/docs/delete-workflow-many.ParamsDetails.json new file mode 100644 index 000000000..a5c39d999 --- /dev/null +++ b/platform-api-docs/docs/delete-workflow-many.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","description":"Force the deletion even if any workflows are active","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/delete-workflow-many.RequestSchema.json b/platform-api-docs/docs/delete-workflow-many.RequestSchema.json new file mode 100644 index 000000000..53ca6d2ad --- /dev/null +++ b/platform-api-docs/docs/delete-workflow-many.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Delete workflows request","content":{"application/json":{"schema":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string"}}},"title":"DeleteWorkflowsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/delete-workflow-many.StatusCodes.json b/platform-api-docs/docs/delete-workflow-many.StatusCodes.json new file mode 100644 index 000000000..412a1e7ed --- /dev/null +++ b/platform-api-docs/docs/delete-workflow-many.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK - Return the IDs of workflows that could not be deleted, if any","content":{"application/json":{"schema":{"type":"object","properties":{"failedWorkflowIds":{"type":"array","items":{"type":"string"}}},"title":"DeleteWorkflowsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-workflow-many.api.mdx b/platform-api-docs/docs/delete-workflow-many.api.mdx index 4c8a67583..dc2d0bca4 100644 --- a/platform-api-docs/docs/delete-workflow-many.api.mdx +++ b/platform-api-docs/docs/delete-workflow-many.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the workflow records identified by the given list of `work sidebar_label: "Delete workflows" hide_title: true hide_table_of_contents: true -api: eJytVm1P2zAQ/iuWP5eWbWzS+mm8StU0gYCJD6gSV+fSGpw42A5QRf3vu3OSppCqTIgviNjP3T333ItbyQBzL8e38tm6h9TYZy+nA5mgV04XQdtcjuUJGgzoRVigaGHCobIu8UInmAedakzEbBkhc/2EuTDaB2FTcddaTBJ/N5QDaQt0wJ4nydr3TYP5A/mSIAU4yOjYMbNK5vRBUHbkC1BIhgOpmdljiY4NXvO9aYEiLzN0WnUkHYG9WmAGclzJsCzYsc4DzuNVal0GoT76cSBXq8E6Ol0p3B33jCFRgoSzokOBLIVOBeW1ls4LcChABdJpG52ZtQYhp+hUCYcUy4cjmywZsq0wG44bNHlVlpLKA9tAURitouSje8+GVT+ond2jYsPCcYGCRs+3G8XbAINzwOnrgNnmuQ9O53MivhrIoIPBXoH9ZcMwYpiudkh9EFyJ8cAXNvd17K/7+/2Uz3+LPXGJoXR5VHpy4rnLOgnCAoJQtjSJyG0Qs6YYmAyaOnyeOClog8nN50tUi8AgQh1sk+EIko8UuxP8VmboPcyRx313mi1wSxJdDqfOWddj/m1LAdvxj+UBQxkTH4Z7VKXTYRln/ghpSNxhGRb0OeVJoIWwsLwyChuTLoDv5Kgt/aiuM08Uuqd2d5TOEGgRQuHHoxEUeqiMLZOhx0fiMdS2N8VX8UZcGAi8DsQx48XhxUQyi5bkFWta67NJdS0RR2yHOw51BNFJ/c9Zu2jun0NMnmt12c366QtkhcHeCN622k9XvIpSG0M2NWiYM9X3kmKJtKKdXoO5gWghsbPXgm3KRD2kTdyNqf3VXRARVruO82X48/twn8+4ShnE/ms26Ntt9ZZk1fXxJz85TU0CvoRRYYBWOBGMiVZNG3XvX2QVG4mqveBWo8uqmoHHv86sVnxcr39ur0R7mBkeqBSMxx0ZvfMobaX4gMveu/cEpmSk5Lfp/8N/7G3awap9Dzs+U/5wmgnFmSX5EBLKjoWqjY5rPnvX7Lez7S0tzq22OFQKi7ATu7kbLs6vrnnImucyswnbOOCy8l/iyb9A2DrObjyrpIF8XsYdJ2ufPJLweqLfTHDMql328VVpGVKzRMS1fcCcGqZVLPA30SXn/wCJ70yT +api: eJytVk1vGzkM/SsCz1M77RZ7mNMm/QCMomiQZJGDYaC0xLGVaKSJpElqDPTfF9TMZJzYcBdFLoYtkeLjIx/pDiJuApRLeHL+vjLuKcCqAEVBet1E7SyU8JkMRQoibkmMZsKTdF4FoRXZqCtNSqx32WSjH8kKo0MUrhI/R4+FCj9nUIBryCO/vFDPb98ONt/R7qCABj3WFMkzsg4s1gRlRhgalLRQUIBmZA8teXZ4ifd2NBS2rclrOYH0UECQW6oRyg7iruGHtY20yVeV8zXG/ujvj5BS8Ry9cl7S6bhf2SRToDgr7awgpkJXAu3umbog0JNAGfUjHYOzds4QWkhpVYCnh5ZCvHBqxybHCrP38GANBUhnI9nIPtg0RstM+fwusGN3GNSt70iyY+O5QFFT4Nu94u0Zo/fI6etI9f55iF7bDaSUCog6GjoocLgaEGYbhqs9KSijbykfhMbZ0Mf+cHZ2mPKPb+KduKLYepuZXnwO3GUTBXGLUUjXGiWsi2I9FINUMdTh7cipUBtSt29PUU8CG6UCPh6j4QLVnxR7InwJNYWAG2K5n05zNDySxJTDF++dP0D+15ECjvLP5UFj3BOp/FQg2Xodd1nzF4Se/Hkbt1AuV6yEmuLW8choXE66Qb6D+Vj6eV9nVhT5x3F2tN5ACdsYm1DO59jomTSuVbNAD+Rxpt2Biq/zjbg0GHkciE9sL84vF8AoRpDXzGnPzz7UZ4o44ijuLOpsBMXw5es4aO6eYk6ea3U1af3LL6wbQwcSXI7crxKPosrlkEMNBuQM9XdJMUVaUhiMuYFQ5gZ6Sdg+TVSjNnk2Vu6f6SIVwGz3cd7P3p99mJ3xIZepxtyAwwh9Pa5eo+ymRn7jnTMUJdKvOG8MassAc6bd0EfTAsyocietCthyr5VL6Lo1BvrXm5T4uJ//3F9KB1wbVlSFJtCJjH6zlY5CvKfdweJ7RNOyJfBy+v/h/2w5nUA1LsQJz4p/eM2AsmgL2BIq8pmo3ulTj+fdDb87+R5MLc6t9ziXkpp40nZ/OFz+uL5hlQ37snaKfTxyWfmzhPwXhL2zePNZBwbtps1DDvo3WZP4UtKvJJyzGqd9Xisjwq7rLW7cPdmUYGQs8m9Iq5TSfzY1TLg= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the workflow records identified by the given list of `workflowIds`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-workflow-star.ParamsDetails.json b/platform-api-docs/docs/delete-workflow-star.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/delete-workflow-star.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-workflow-star.RequestSchema.json b/platform-api-docs/docs/delete-workflow-star.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-workflow-star.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-workflow-star.StatusCodes.json b/platform-api-docs/docs/delete-workflow-star.StatusCodes.json new file mode 100644 index 000000000..de1c78faf --- /dev/null +++ b/platform-api-docs/docs/delete-workflow-star.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"}},"title":"CreateWorkflowStarResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/delete-workflow-star.api.mdx b/platform-api-docs/docs/delete-workflow-star.api.mdx index 384c20f87..81552fe3e 100644 --- a/platform-api-docs/docs/delete-workflow-star.api.mdx +++ b/platform-api-docs/docs/delete-workflow-star.api.mdx @@ -5,9 +5,9 @@ description: "Removes the workflow identified by the given `workflowId` from you sidebar_label: "Unstar workflow" hide_title: true hide_table_of_contents: true -api: eJy1VMFu2zAM/RVBpw0I4mzrBsyndW0GFBu2ol2xQxGgik3HamXJleR0hpF/HynbcdwEKXrYKTH1qPdIPrHhXqwcj2/5k7EPmTJPji8mPAWXWFl6aTSP+RUUZg2O+RxYD2MyBe1lJiFlyzocreQaNLvrERfpHcusKVhtKsuUdJ6ZjDkvrMWcLd2UT7gpwQoiu0iR7hwUePjTAa4xASGlsKLAsCWxDdf4gdCBCyGStJbC5/x5Af1dyG6lXg3a6WYLj5VESTz2toIJd0kOheBxw31dEkmbxDebyYjXlSKBgfixAlsfZA5ApqsCrEzG3HtcUntYhaPM2EL4NvTpBNkXJNWVRjtwlPF+NqOfMd+v75iaGLxFezoVZalkEnob3TuCNPukZnkPiacmW5qEly3BTnMPNYN76RWFziyI8byuOp0II+DJ7MMBpf3MmTaeCYWpOIOAPtlH/0RMZiqdvqa8YbK3vADnxArI3Mer7oFHS55ba8ZV4iHaMzdk4DQYOJgWzRjzqO9k1Aw93USudbYDu+5tXVmF+Nz70sVRJEo5TZSp0qmDR+zWVJo9g12HE3aphCfHsDPCs9PLC06GcZBUVvr6mnrS1vcVhAV7WpGybYnE2NuRvpcBhJH2z7fei/dPPvRB6syE9K4fnQqifUkglSsT3CYtmIYpkjDMcfG7JeM8pQpPITNfhgMUQp1red5NP3+czihWGucLEbzQPdcbTb3e7pznGpvBUv9/13Ud9/DXR6USuDtQcii96fwy7GKEx6MVFyyDc82xRAI2zVI4uLFqs6Fwu4PISKl0YqnI+plQDo4U/MKGOij3Aeq9JbgWqiJk8N1aWEn8r9Ty5qp7sW/Z0ZV9UFQXFLreVbMrtmvjZoHoHESKd5G+FnCaJFD6ndS93UKFbd/4+fzH/PccH8M/JqeI2A== +api: eJy1VF1P2zAU/SvWfdqkqC0M7SFP66CT0KYNwdAeUCXc5KYxOHawb9pVUf77dJ2kaWlVxMOeKPZxzoePbw0klx7iB1hb95xpu/YwjyBFnzhVkrIGYrjFwq7QC8pR9DChUjSkMoWpWGzC1lKt0IjHHnGdPorM2UJsbOWEVp6EzYQn6Rym2+/4EURgS3SSya5TiOEKNRL+6QB3JB1EUEonCyR0LLYGIwuEGAYuiECx1lJSDq8N9N8Snpwyy0E7f9nhS6UcphCTqzACn+RYSIhroE3JJO0haJpoj9eXMsGB+KVCtznKHIDCVAU6lexzH3ApQ7gMW5l1haR26fMFNM2cpfrSGo+eT5xPJvxnn+/Xd4ggsYbQEO/KstQqCdmOnzxD6kNSu3jChDhkxzdBqiXYCfdYGECKNC9dOpT793Xb6YSmYeDF5NMRpf2dC2NJSK3tGlMI6ItD9E9LIrOVSd9jb7jZByjQe7lELvdp1z3wpOWZc3bfZRNBgZRbLnAaChxKSznEMO6THNdDps3Yt8326FZ9rSunIYacqPTxeCxLNUq0rdKRxxd0cqTsQcHuwo640ZK4MeKS8WJ6cw1cGI9J5RRt7jiT1t9XlA7dtGJlW4vM2NeR/18EEETdj299F5/WFHJQJrPheJdHp4Jp3xLIdlWCvgPzZcokXOa++V3LWEilw1PI7Jdho4mAk2t5zkZnk/PRhBdL66mQoQzde703HPZ26LwWWQ+d+v/Drouc8C+NSy2VYcnBe90VZhjGEEG8N+NCZ+YR5NYTA+t6IT3eO900vNwOIW5SqrxcaO5+JrXHE4bfGFFH5T7j5mAKrqSuGBmKt5JOMf87tXy47Z7sR3FyZh8V1S1Ks9lVsyu2i7GZNxHkKFN0QV8LmCYJlrRz9GC4sLHtI7+a/Zj9nkHT/AMvmoj9 sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the workflow identified by the given `workflowId` from your list of star id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-workflow.ParamsDetails.json b/platform-api-docs/docs/delete-workflow.ParamsDetails.json new file mode 100644 index 000000000..60eebd877 --- /dev/null +++ b/platform-api-docs/docs/delete-workflow.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","description":"Force the deletion even if the workflow is active","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/delete-workflow.RequestSchema.json b/platform-api-docs/docs/delete-workflow.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-workflow.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-workflow.StatusCodes.json b/platform-api-docs/docs/delete-workflow.StatusCodes.json new file mode 100644 index 000000000..8a0ce1dc1 --- /dev/null +++ b/platform-api-docs/docs/delete-workflow.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - Not content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-workflow.api.mdx b/platform-api-docs/docs/delete-workflow.api.mdx index 3e434d86c..6440667ba 100644 --- a/platform-api-docs/docs/delete-workflow.api.mdx +++ b/platform-api-docs/docs/delete-workflow.api.mdx @@ -5,9 +5,9 @@ description: "Delete the Workflow entity with the given ID" sidebar_label: "Delete the Workflow entity with the given ID" hide_title: true hide_table_of_contents: true -api: eJydVVFv0zAQ/iuWn0AqbYGBRJ/YWCdNIJi2IR6mPrjJtfHmxp59aami/HfunKRNaLUxntacP/v77u67WylRLYOc3MmN9Q8LYzdBzgbSOvAKtc0vUzmR52AA4VcDkAPplFcrCnm+WcqcPgjWvkB3BlLnFHEKM/qdQki8dvweBdt3RECv86XQKeSoFxo8QT08FtoDsaIvYCBDksFKyUkpceuYpL4kq2rQ4w1OJbAnfizAb48yR6DIixV4nfS5D7h0jrCMRwvrVwrr0MeTHjsdJfA07wVDBGYgUq4kBQWsIRd6EYNt3YQOQiWo13BMzNxaAyon7hmXKTibBwgMeDc+4T99zh9fxRvx3aJILGWRo6wG8mQ8PgSeqVRw1SEg0bZoginnjE6iC0b3gbFlR9W+UXdyBSGoJbBxGrF2fg8Jv+c8Wwl1rbQFHmunRI2GQ1Pvrb9uEqSTKip/fyTF1qQipzyVoRKSHoYHSAqvcRvdeQbKgz8tyIqTuxlXr/9M7e7YiZ012RW4FRuNWTxYau7X5TllRL7PLE9F7CXEaeCn5ajt46jcT0LFrQS/bkel8IagGaILk9FIOT1MjC3SYYBHSmao7YF5buKJuDIK2YXiC+PF6dWl5FTaTG+4MXWRu/nu6syMrauimyKIIvWPi9bf9xuMFdT5wsbrTVMaFUz7nEBOVycQGjA7ilzNj/WT76ZMptImjtfCft4fkBCuXM3zdvjpw3DMMWcDrlQ0ZDOEL+xhL4FdjRB+48gZRZNMJFFs2TR3vx7p9qSz6KgFGalhRFnOVYCf3lQVh+tVwD1PdVBzw6OyUCbAAf1u5p5bUEd1PsD2YAeulSkYKXlP/Tv9/+ypJzS1m3GvZsYfXrOcF1bm1XWzb16LJ/9/HJXTBFW+7arplq7pZjUjdAYqpbdYXw04TRJw2Ll6sBk5sd1eOJ9+m95OCa76I/jXyEWCo8rISBFxax8gr6qdUORv1lhVfwBHnakf +api: eJydVU1v2zAM/SsCTxvgJWlX7ODT2jUFgg1b0XbYochBselYrSy5Et0sMPTfB8p2PpagXXdKIj3xPZKPTAsklx7Se1hZ91hou/IwT8DW6CQpa2Y5pHCJGgl/9QBIoJZOVkjo+GULRlYI6SbCLIcElIEUakklJJCjz5yqOR6kMMQRnpwyS6FyNKQKhQ4ScPjUKIc5pOQaTMBnJVYS0hZoXTNJ9whCSPZ4fS0z3BI/NejWR5kjUJimQqeyfe4DLmUIl/GqsK6S1B19OttjL6zL8GXeK4YIKlHkXElljcBnNEIV8XCom1BeyIzUMx4Ts7BWozQQwpzL5GtrPHoGnE7O+GOf88dX8UF8tyQyawgNQUjgbDI5BF7IXHDV0RMkMKDTFmRda5VFF4wfPGPbHVXbRt1Dhd7LJbJxerF28YAZx6sdW4lUp3QAHmsnkCLNR1PnrLvpE4QQQlT+8UiKg0mFsSSk1naFeQzlMWuconV05wVKh+68oRLS+zlXbz9M5+7YiY012RW0FitFZbxYKu7X7BISqJBKy1MRe4lxGjg0jIc+jtvtJARuJbrnYVQapyGFkqj26XgsazXKtG3ykccndHKk7IF5buONuNaS2IXiC+PF+fUMOJUh01tuTFfk3Xw3dWbGwVXRTREESf/lavD3w4piBZUpbHzeN6VXwbSvCeR0VYa+B7OjZBYdtZ/8bspYSaXjeBX28/YiJMCV63hORieT09GED2vrqZLRkf0UvrGJexlsikT4m8a1lsowSVTb9t3d7kdIIN3ZdPMESuuJEW27kB5/Oh0CH3e7gJueKy8XmmelkNrjAf1m6F7bUEd1PuL6YAk+S90wEnhR/Tv9/yyqFzQNq3GrZs4/nGI5b6zMu5t+4bwXL/6BHJXTH0qz3lWzW7q+m2EeEihR5uiivg5wnmVY087Tg9XIiW0Ww+X02/RuCgnI/Rn8a+YiwVFlbdsh7uwjmhA2Qol/s8YQ/gBWQKlE sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Delete the Workflow entity with the given ID id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-workspace-participant.ParamsDetails.json b/platform-api-docs/docs/delete-workspace-participant.ParamsDetails.json new file mode 100644 index 000000000..8ffab50e3 --- /dev/null +++ b/platform-api-docs/docs/delete-workspace-participant.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"participantId","in":"path","description":"Participant numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-workspace-participant.RequestSchema.json b/platform-api-docs/docs/delete-workspace-participant.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-workspace-participant.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-workspace-participant.StatusCodes.json b/platform-api-docs/docs/delete-workspace-participant.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-workspace-participant.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-workspace-participant.api.mdx b/platform-api-docs/docs/delete-workspace-participant.api.mdx index b05a08c10..f9553af42 100644 --- a/platform-api-docs/docs/delete-workspace-participant.api.mdx +++ b/platform-api-docs/docs/delete-workspace-participant.api.mdx @@ -5,9 +5,9 @@ description: "Removes the participant identified by the given `participantId` fr sidebar_label: "Delete workspace participant" hide_title: true hide_table_of_contents: true -api: eJy1Ve9v0zAQ/VcsfwKpNAUGEv1Ex4o0gWDahvhQVZqbXBNvSezZTkeJ8r9z5+ZnN62o0j7VsZ997+7evZbcidjy6YI/KHNntQjB8uWIR2BDI7WTKudTfgmZ2oBlLgGmhXEylFrkjskIcifXEiK22vrTWG4gZzc90Hl0w9ZGZb3jNtSYj7jSYATFOY8w0hmk4OB3A7jo3kEovioyPDZEuOQ5fuAVZWK8OuKSmGrhEr5P/6eJRS7/+igsLzIwMuy4G2Jh4L6QBpCCMwWMuA0TyASfltxtNUWRuYMYDELXymTC7bY+nvCqGrVU2sQOEGrze1E2gyY8y6dX5hdgtKTrVqvcorbwxrvJCf3s9egbe8N+KBYqfAi7XY34yWTyGHcqIkZkwJIiGjTChNapDH2Pg1tL2LLHsuO/4BlYK2Igmdfk1eoWQq8wQ3J0cke0AXZZWmdkHlOVuZMupa25Mcpc1vnhSeWZv38iw0boLFeOiTRVD8iH4BbCwki39ao+BWHAzAps03SxpOKh5BNFwxH54fCDQKc8QOnboPQDUAXdAAdlT4hV0NMBHg1UUXGKbjbNSBUmxXcT57SdBoHQchymqojGFu6R/FiqR9K58ifsIhWOGs++EJ7NLs45UW8yu6JG7Iraz6+tK0Xktaroe+VBuLNbfG0kdfvgfMVkvlb+et2EmgWFPUSQ0pVYpBpMChKhV9Aw+X7KKCKZekWv1efuAIlQ5XZx3o4/fRhPaE8r6zLhBVhP4s7VOt/rm+g+4bIT9Yv6bl15B39coFOB5oDUfQnKWl8LslaL0Gljsb3/CNwdul1fZXQ6dB/UQoJloUfLciUs/DJpVdE2jrIh5eNyI4wUK2ooSjGSltao+7VILTxTpVeX9XC/Zv/h9E/mXW+KfMuJRlrQFy7vYNv+w5CzHkXqkNsfwahf+qN5HXb9I5gN214t8UICIsJhpqbuMLMwBO16tx9598D2zubf59dzhIuhaeyZhA/wJDlUnEdcqzvIq6rl6uibOFbVP1nqIjg= +api: eJy1lVFv2jAQx7+KdU+b5BHaVXvI09qVSWjTVrWd9oCQapID3CZ2al/oWOTvPp0JEGhVJqQ+Qexz7nd3f//TAKmZh3QET9Y9+Epl6GEsIUefOV2RtgZSuMbSLtALmqOolCOd6UoZEjpHQ3qqMReTZdyd6QUacdcJGuZ3Yups2dnepOqBBFuhU5xnmEMKl1gg4e91wNX2PSChUk6VSOgYuAGjSoQUrJsNc5CgmbRSNId9/J9upoz+G7MIU5fodLZld0zh8LHWDnNIydUowWdzLBWkDdCy4izaEM7QgYSpdaWi1dKnMwhBblA2hR0A2tT3pjQ7Q3iVp9PmNyAa83FfWePR84nT/hn/7M3om/ggfliRWUNoCIKEs37/edyFygXDoGdFrKPTBlRVFTqLM07uPcc2Hcot/whK9F7NkGXewtvJPWZRYY7lSHoFug7cVunJaTPjLgNpKnhp4Jx11219EEKI5B9fqHAtdGEsCVUU9gnz+CqPWe00LaOqL1A5dOc1zSEdjbl5JdLc8uXI4+WIF4F3IbFu5pMmXoCQbC9w0nSEGJKODnzS7KgiAGd3i/WVql0BKcyJKp8miap0Lytsnfc8PqJTPW2fSecm7oirQhEPXnzheHF+NQRGX1d2w4NYNbVb36avnBFaVfHzJAaBbP98XUvq/olix7SZ2ni8HUJLwWkPAXK5OkPfBrOCVBYVtFt8t2QslS6ioqf283YjSODOrfKc9E76p70+L1bWU6miAturuLK1rfF1XXSfuNmq+k2Nt2094R9KqkJpw+ixB00rsBF7qwcJ6dpjOx8JCemu3XVlxru79jOWMLee+KVNM1Eef7kiBF5+rNGx9McSFsppNeGJjhrItef/OaRTVXh8pUvvrtvb/V78h9W/WHe7qMwSGKOo+QkkPOBy84lhaz0K6pDdH0HUbf3RXIdt/wiy3bGHcZAwR5Wji0NdxZxnGVbUOf3MvHd873LwfXA7AAlq1zX2XCImeBGuaVYRt/YBTQgbVuJnZgzhH7zNIl0= sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the participant identified by the given `participantId` from the given w id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/delete-workspace.ParamsDetails.json b/platform-api-docs/docs/delete-workspace.ParamsDetails.json new file mode 100644 index 000000000..92b9288dd --- /dev/null +++ b/platform-api-docs/docs/delete-workspace.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/delete-workspace.RequestSchema.json b/platform-api-docs/docs/delete-workspace.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/delete-workspace.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/delete-workspace.StatusCodes.json b/platform-api-docs/docs/delete-workspace.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/delete-workspace.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/delete-workspace.api.mdx b/platform-api-docs/docs/delete-workspace.api.mdx index 5c8df3b9a..7277c1a6f 100644 --- a/platform-api-docs/docs/delete-workspace.api.mdx +++ b/platform-api-docs/docs/delete-workspace.api.mdx @@ -5,9 +5,9 @@ description: "Deletes the workspace identified by the given `workspaceId`. This sidebar_label: "Delete workspace" hide_title: true hide_table_of_contents: true -api: eJzNVFFv0zAQ/iuWn0AqSYGBRJ/YWJEmEEzbEA9VpbnJNfGW2p7tdJQo/507J03SdtrQJCSe4tjf3X33+fNV3IvM8cmM32t764xIwPH5iKfgEiuNl1rxCT+FAjw45nNgHY7JFJSXSwkpW2zCWSbXoNh1BzlLryN2lUvHtAErKBvDxUoojCw2zMJKrw/yCpUy4ZxOpPCY2wjrZSJNCHcRH/Eu2Vnakfu5DcdzjBAr3LPUWMUV/iBO2wzxIy6pI8yW8/02v9tMKPm74anKFViZ9F1aKm3hrpQWsK63JYy4S3JYCT6puN8YqiKVhwwsQpcaG/XN1vsjXtejjspAoEcJdU39AzZzCncGJcUbx4g34yP67Cnyhb1i3zRLNCZSntcjfjQeH+JORMqIDDiPtbZohAljCpkEReMbR9hqwLLnP+MrcE5kQOZryevFDSSUz1i6cS8boltg36XzVqqMFOZe+oK2ptZqe9H2hyd1YP72gQ47YyrtmSgKfY98CO4gKa30m+ChExAW7HGJlzSZzUk8NFiuyX9p8F+wHZ3yGI3m4irYrY77ZxVXg2uvORWw661HS1tgaO69cZM4FkZGSaHLNHJwh/wiqQ+8cRlO2HkhPN0t+0R4dnx+xondlvwlad3oNmyhk44q8tY49L8IINxpFp+3rrm590EUqZY6hLc6tyyo7FMEqV2JOrRgMolIgkl2mx+2jD6RRTDtUn/sD5AIKdfUeR19eBeNac9o53G2UMr2oTWzoZ8t+ySr3qv/25BrL8jDLx+bQuCQwA6DUlXrtBmNNIfQyXa0DWY47g6nDFoiR3UoqKoWwsEPW9Q1beOjteRxXK6FlWJB94qOTKWjNTp8KQoHjwj34qJ9xi/ZX0zQB/tqN4XacKJRlPSHy1vYdJOb5uezSD01RZ/BaChtPUd4DiLFd0PCNYjjJAHjB7EHk3BniJxOv06vpggXu+9z7z2GAg9Sw1sNiCt9C6quO6ae/oljXf8BThTAxg== +api: eJzNVE1v2zgQ/SvEnLoA13bbYA86bbpNgaBFt2hT7MEwkLE0tphIJEOOknUF/vdiaFlWPtAWBQr0ZIuc4bz3+Ph6YNxGKJZw58J19FhShJWGimIZjGfjLBTwmhpiioprUmOdMhVZNhtDlVrv8t7W3JJVl2PJeXU5Uxe1icp5CiinKU+hRUuWm50K1LrbR+eirRTG6EqDTJXyGNiUxuf2OAMN42Hn1Qjuv0M7aPAYsCWmIMR6sNgSFODC9rwCDUYYeeQaHtL8N2zRmi97nLZrKZjyyDLI6EA3nQlUQcGhIw2xrKlFKHrgnZcpxjJtKYCGjQst8n7prxNISY9QJgJ9E9BI6hegWUl79M5GitLxYnEiPw8Ueav+VO+dKp1lsgxJw8li8bjuFVZKwFBk0HCoLnpA7xtTZkXnV1Fq+wnKI/4ltBQjbknMN4B36ysq5Twf5MbZ7IEeCo8sIwdjt6IwsOFGls5CcOHjwA9SShn5yycYjsa0jhU2jbujKh8VqeyC4V320CvCQOG04xqK5UrEa4lrJ/6rsv+y7WQX5i5s47zPdkvz47Oa95NrTyADwu3Bo11ooICa2cdiPkdvZmXjumoW6YYCzox75I1PeUd9aJDlbtU/Uq9OP5yDoDuA/yRa73WbUhilk4kwGEe+17kI9PDnzcE1V3ecRTF243L7oPOAQsZ+D6DQNSXFoVhMgmU2yX3yU8rUommyaTfu7+NG0iDK7ec8nz1fvJgtZNG7yC1mkw0vbR8Ox3B5iLI/mvV3S7nhhpj+57lv0FhhmKXqB6stJdMiaCgO2TYJcQ3FNGZWGmoXWZr6fo2RPocmJVm+6SiIyVcabjEYXMvFLnuoTJT/FRQbbCJ9Q7hnH4d3/If6gQh9ktewiHYHAqPp5As0XNNujG4J0J8C9b0Y/QlEU2nTKmmoCSsKWbh9xWlZkudJ76MovJcir8/enV2cgQa8/0AfPMg84Elofb+vuHDXZFMakbJ8C8aUvgJsgcDr sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Deletes the workspace identified by the given `workspaceId`. This operation perm id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-action.ParamsDetails.json b/platform-api-docs/docs/describe-action.ParamsDetails.json new file mode 100644 index 000000000..9808e4773 --- /dev/null +++ b/platform-api-docs/docs/describe-action.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"actionId","in":"path","description":"Action string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.","schema":{"type":"array","items":{"type":"string","enum":["labels"],"x-enum-varnames":["labels"],"title":"ActionQueryAttribute"}}}]} diff --git a/platform-api-docs/docs/describe-action.RequestSchema.json b/platform-api-docs/docs/describe-action.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-action.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-action.StatusCodes.json b/platform-api-docs/docs/describe-action.StatusCodes.json new file mode 100644 index 000000000..d95b5d209 --- /dev/null +++ b/platform-api-docs/docs/describe-action.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"object","properties":{"id":{"type":"string"},"launch":{"required":["dateCreated","pipeline"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"computeEnv":{"nullable":true,"allOf":[{"type":"object","properties":{"credentialsId":{"type":"string","description":"Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)."},"orgId":{"type":"integer","format":"int64","readOnly":true,"description":"Organization numeric identifier (read-only, set by system)."},"workspaceId":{"type":"integer","format":"int64","readOnly":true,"description":"Workspace numeric identifier (read-only, set by system)."},"id":{"maxLength":22,"type":"string","readOnly":true,"description":"Compute environment alphanumeric identifier (read-only, generated by system)."},"name":{"maxLength":100,"type":"string","description":"Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters."},"description":{"maxLength":2000,"type":"string","description":"Description of the compute environment. Maximum length: 2000 characters."},"platform":{"maxLength":25,"type":"string","description":"Compute platform provider.","enum":["aws-batch","aws-cloud","google-batch","google-cloud","azure-batch","azure-cloud","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform","moab-platform","local-platform","seqeracompute-platform"]},"config":{"description":"Platform-specific configuration. Structure depends on the selected platform.","type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp (read-only, set by system)."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp (read-only, updated by system)."},"lastUsed":{"type":"string","format":"date-time","readOnly":true,"description":"Last usage timestamp (read-only, updated by system)."},"deleted":{"type":"boolean","readOnly":true,"description":"Deletion status flag (read-only, updated by system)."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"}],"description":"Current status of the compute environment (read-only).","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]},"message":{"maxLength":4096,"type":"string"},"primary":{"type":"boolean","readOnly":true}},"required":["config","name","platform"],"title":"ComputeEnv_ComputeConfig_"}]},"pipeline":{"maxLength":200,"type":"string"},"workDir":{"type":"string"},"revision":{"maxLength":100,"type":"string"},"configText":{"type":"string"},"towerConfig":{"type":"string"},"paramsText":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"mainScript":{"maxLength":200,"type":"string"},"entryName":{"maxLength":80,"type":"string"},"schemaName":{"maxLength":100,"pattern":"[\\p{Graph}&&[^/]]\\p{Graph}+","type":"string"},"resume":{"type":"boolean"},"resumeLaunchId":{"maxLength":22,"type":"string"},"pullLatest":{"type":"boolean"},"stubRun":{"type":"boolean"},"sessionId":{"maxLength":36,"type":"string"},"runName":{"maxLength":80,"type":"string"},"configProfiles":{"type":"array","items":{"type":"string"}},"userSecrets":{"type":"array","items":{"type":"string"}},"workspaceSecrets":{"type":"array","items":{"type":"string"}},"optimizationId":{"maxLength":32,"type":"string"},"optimizationTargets":{"type":"string"},"headJobCpus":{"type":"integer","format":"int32"},"headJobMemoryMb":{"type":"integer","format":"int32"},"launchContainer":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier associated with this launch."}},"title":"Launch"},"name":{"type":"string"},"hookId":{"type":"string"},"hookUrl":{"type":"string"},"message":{"type":"string"},"source":{"type":"string","enum":["github","tower"],"x-enum-varnames":["github","tower"],"title":"Action.Source"},"status":{"type":"string","enum":["CREATING","ACTIVE","ERROR","PAUSED"],"title":"Action.Status"},"config":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string"}}},"title":"GithubActionConfig"},"tower":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"title":"Action.TowerActionConfig"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"title":"Action.TowerActionConfig"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string"}}},"title":"GithubActionConfig"}],"title":"Action.ConfigType"},"event":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"timestamp":{"type":"string","format":"date-time"}},"discriminator":{"propertyName":"discriminator","mapping":{"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"ref":{"type":"string"},"commitId":{"type":"string"},"commitMessage":{"type":"string"},"pusherName":{"type":"string"},"pusherEmail":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"GithubActionEvent"},"tower":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"timestamp":{"type":"string","format":"date-time"},"workflowId":{"type":"string"}},"title":"Action.TowerActionEvent"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"ref":{"type":"string"},"commitId":{"type":"string"},"commitMessage":{"type":"string"},"pusherName":{"type":"string"},"pusherEmail":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"GithubActionEvent"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"timestamp":{"type":"string","format":"date-time"},"workflowId":{"type":"string"}},"title":"Action.TowerActionEvent"}],"title":"Action.EventType"},"lastSeen":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}}},"title":"ActionResponseDto"}},"title":"DescribeActionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-action.api.mdx b/platform-api-docs/docs/describe-action.api.mdx index ccf1403c2..834a33c40 100644 --- a/platform-api-docs/docs/describe-action.api.mdx +++ b/platform-api-docs/docs/describe-action.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the action identified by the given `actio sidebar_label: "Describe action" hide_title: true hide_table_of_contents: true -api: eJztfWt32ziS9l/BcZ/dsc9rSYmT6TObTyvLSkbbdqK1nPSZzWYjSoJktnlRE6RtdY7/+1tVAEjwJlGy050o+DDTsYhLAShUPVWoAr4cxM5CHLz6eOBMYzcMxMGn44MZF9PIXeLfB68OLnkcufyWCxZfczbjseN6goVz+lPWYu6MB7E7d/mMTVb0YeHe8oCN5ffBbNw+OD4Ilzxy5N/Q7hn1MuFdKgKfl07k+DzmEdLz5SCAP6CYbgEKuEjO0omvD4o0yjaYAEqDRUZNBAUj/nviRhx6jKOEHx+I6TX3nYNXXw7i1RI7kJUOHh6O0z7vwuhGLJ0pz7r9PeHRqtTvr7ogCxKfR+4033epLzeI+YI+zcPId2L5088vc707MVA0SWIu1nfenc1c/KfjsbQKu3W8BJcqZG4w9ZIZh//SgkRcLGF9OTsce86Ee2J81GawtkkUCOYEjPvLeCWrp0VewbA8b3zE3DkLfTeO+axdNSwnihykz425L8pTe3zAYXqQyWSzyGP3LfytdetEOGqR/xi7scfTZf1vHH1XjxCm6uETLqscDnV38uwZ/ic/Pe9+gY6nIcx4EONXZ7n03CnxX+c3gUW+lEcSTn7j0xiZMUJujV3ZgWTCzeXcWQVjHcPIkmB6jZ8ybvx4MHNi3os4/D9y2dJdcs8NOI2/QSe+c3/OgwVshlcnJ8flPqehv4Tp6ge3WBrX0ZngpMpd4HjeuzltM5MimK25i+tFnAj9ek6MjFr5y5rC6tPGkUyhX9wujicGFTNXZPheVtzYZww6ZWq0jAe3bhQGPnxkTgJ8D4XkmiOz00gF4/euiFFQTL0wmTGg6Raaizr/HPaYQVKbjThnH+USmR8+HV7H8VK86nRm4VS0Bf8d5FrbDTt6ClrO0u1MqV7LqHfUxoUJo0VusLUyAZncmb0LvJVetQKDRwsncP+g0VXIH3aI1Vsh1D9mgscomcVKwBaVdJhC7gmoWScKN5HSgKM3dd+rYgBvee1soGbBA1RKUnGZNElhnKPq+bNnZbLyZLwPXBDWDCsTX6LkreDNNrtIRAxfAgGsiMr0eQtaz1F8zGaOuD5m0EoSAHuKaRhBY9egJaeoJInKXO/5KXy2mdqz7C+t0KuJde5dP/GZR22/Yth2kZJ0+xfI+HuZCK0NnDvRmjjxFPU5/pu2I/x7EYYLj7c8dw70uTyYkiZUv+oK6k9dx/kjibKP8i/97eYfomVIJ36T+3Nxw80/k0XuT+ElsJ+NHzwxN/90PMBDkfmLHzqTXIVw6ni5JkleqInOtbV+PhqNfKuxbhpcYS6KIyuP/c8d6yNW+S8beQlea8GlS6TqqC21OGnSErgZak0jlnwKUm3KZMkkUspuBEJyCuAOEfuSBzNA7BIHCu6BKgZ5pztERLdeTaOmOHOjzQoadQCbgY6dxmG0YgjVSQoK+JOAOSiXyOczFxUqtjr3wjs2dz2uZEjEL5NgRC1u7g3wL3OY/AWG5sSg2PkUcbPGvMG8JaGXLrWMXBTKCI5vwxsk6S2/j4kKGDLIGQCUSu0PYeqcAKYpFHErSgLVRAPlTwzZkR13nNmtAwJs9hOMrQXttXR7LdWe1Db469MM3ZnDHIMi8SqGxq6dWyniPY5Y/q8YqaFYGlgQNRyplfP6WeobWAAMDRcBMKlmIoRMnR0bobrUyjVACaORSRh63AnKCwbGBxrGrsgaATZEJk2XCZtiv4WTtgHfn6hprdWhddxpD8c52K8AvJyQ4/yfhjXWIwkD8/FBdVMCIJWTRcYogj61KasQBgEuRWwvFXkb94A2f41xGkIQ+0Wjb6X4vFCK5M6uPK6Jbcm2WtiW5O+Zi0T6buCA0Ns8Ci3IGRZjucpl1OwIkNswsFRXSGEOLR21Swj5oYoYtY1Wb6WrIf8d9BzMF1KJGC6n8nAcig0u4EN+oisUSGZfPpFqSRfvLq9jlFabeoCnefQ3wQTAUpglXBCF5xXYnqCUY85EhB7pW1ROKPYMA435WJCEJE39XQTyiDlTlJ5WQf0gCmpP5JAs2WhvnaW76e6aR4bagLkRT7R72CB1IYJhy+dO4sWkGcZKBIyJ6kTw6G0j5f4eSqZm9mj0T5zNQApDbBZ9OaRQg3CmNDWsdrOm/wklqWloeTBkzmwWwRDQQi63ugyjeKP75MVJqQ+kGOu22ZmcjFdsfHIyTjHFfye8CTq5ulbOBmW+/47VCkKRJag2YE6UqMkhA7kt0WQwUMcOnVd2DH3eXbvQpXZuEgBhIKCZSCbKocx6wFjAXuEtjyJ3BtykzxDSWnnbBgn1nXsicuT+wXeZfiTdV16NIPEnQCwMgqjLtifQJcnUeEoOUkAtsP8CHiYCN3W2gM+fPctW8L/CybulPFPZRoaoHkNZNXUiVaNEVKbOAqypf9Z1WIcaYTuSG42N87SOaXVgN0uZ5UrOMSlopUtXAStTz/0ERupM4zewokqQ4glHXvlvCZU0dpF4EoFPDk8qaWqY4AU8ZG2PvbI98BzowXQkGRi1++uIneKPG4Fqfm3RUeEs+BUVqlodgA5TOrDRLIWSLuJ1pxel4regPn0uGnBfdpJT4InTEVOt4FT7YQLMcSjFHYigDqq5DqrnVx08/HJAfkb093gn++Txmy7ii/zZWZ0MhDWTZRUMAaUbJhGgB3bnAlqc0BkMueoPeXvRBtGViBZ3AMM9V2PbTn2ZTCJHI+U7ilxAPgGib8W0UBX5Iti65azFs8vum/7b1OulUfzAg6WExVDfm+JAkSwRPfDZZxHO4zuQ2R1JYQfV6K3L744MsgeBiBEv1vN1jsN6J2B+yBrSLK2iP12E+fP2yb3nRAueXwXQKZeh16A/LMW6l2+RxRaRA+w8B6ZtwT/hPzM26F4wYEHfFYI0IpSqky0g4TWcadY1th3p7nGU/d6IxY64KeCiLRBZ1drXi1qlfL/WRK2R8Z47xEiKzQ4KRPqqKRxb73wgucPzpHWTunWUsEkPFyttD2tE/xBGtOLr3jIRu8Dztykk7w3fCxxnSHp0PU+rTi+4D7bsxWSXjmVd3SGyd+3+PUb+8/nCmaxidX5h8eU+4UuQYrCR+gH+2WQeZEn28Ve5/ZQ4rN9g2PqRaT7Owezi0oCcJyjDT7bv/DVVNN2ftf3LPo6MwJgC5TW0BbfAMSOJlLcm8O2HC56hC4W3DRLK9EtvVrh4E4XJskGQEEqrX0kBn4cLAYoSqqkYITUwBq2JffL1yZUcBc5SXIdxE/O/wC5p1Q3M0lkk7ox3hC5+tHnlYEALXj7AlhDpNX4szKDyfLTZR6NM0znT5+0giUUnNQ1/ov9vESkto4gWfkcYKxaCXlBBrmXLIBdWFJAoU/guT7wWPcRwYP954SqPP5RLS2w+dY9rwLqOnhkN313Bn4DWy0EFAxO+t9kYCo0VOYIlAZ3DRwmURiYIg9aM+zgqE/nDAoyxi6xevtZoGcZZYXYIo+O4x0QseRKMml21/4UbkGOOdD+FQyBnwaRuOEH0nfudu1S+wG27XCyTrUXgm+F7Y5YJN0xEFxhwNHW8Oq2Y9yTUevNS0immF30FyNktfr+E9aXewf6/WTcq9jaM6YMj1/nOBfxfs7ddw658jE+jF/q+0xIcI8AR5XkqKA5h2B3P8yWxtJw2QmmjGOssVuu2yml/dPX59QC3i/7n5+HluzeX/dFo8KEPPyOnf+51h93e4Opfn98NrwYXg//pn+kvw8tBr1/1vbTzzjCA3ccdzq5hv0spIh0nIr+/UFVMYaZWLExiEiipzZnTvFUUj0m+ZBs3axT/Gq+lWdbNb1+5mj6o4kZxuAnobZ91LwZscIbDSIS0c6XGQoFXkCTGERLK1nM3SO5bJ2htt1Dc++4fuNWwf2nn+JzHIsei2hn0N0H96rAnFe1kHi5hLQ9FeYyaGPYDNH0LaMYIcuz6zh/wV757bNYMJc7cT4A+8QhFIuvltMkUfRj2cG6wvYDHaA1DKWpAJBP45TG75VztDuxDtUbGrghx2DT1Ge3zCFaKO8CEIYw8onBSnAIS5lBV0gR8F7nxiiDWU5CmG1Toa3BGFM44+ivQpOVUag6a8g5t2CihMBFceQRpUejRKPRK4GEbyDdnDgsuMYW4v0C/5+Z1eD26p0U4Jzet8pYuQ1eJb2io2ZFgoR1DEGZGFzS263HUmuYFNIny+s2pdt+Cxc3fBWcgUwpJCRvPemZYR8Ibw7l6zYNKnANsLytIzufTk1/4aug0OVHG1bvhGAHoRukBrRFHQYL9NJnePM1OcDJYPnrBJrJd1Z+rbMY6DQ669xTUyM2uS5f544tLJSHzeniwXq0rwFDWvuzw9rmEWRN3NuSwjmDaLHaiXyMfrWuXkTulE10nryOOmQNTig5G1ZkWppkWklWlw8SJ8xq7XQSM5NMPQlILUm9A57A7XU/K/SSKkAkF1pINAz9OOIJoCmOVCoAOIYEJMrIK57H/Jm1WPhcyj2Ob7SKPGwRI8DvWfz0qwR9otIku6Ot0k0IbIBZ1Mw2lWbEBQ5wh3xmWe+b7396F8OQnEUyVMajq+m6TqVMQA1nqK5BVAuGnYRjvKgewrgTXJAaQ5LT9Y0Mq8Klo6m1QOCtvYWp/JJ5U4Hhg/dO8SRnpMVllBmybdZcY/p25TscdHk87QAX+ry3bHkuuAiIJKejwDQpyYV0P/o3sS244Kug7K1QgsMmwjgN/e3PYwUgfFszb9hUmBrlGsgHkBlhYYLDh2w7BNaDV70jkBlU7EuJ1ZvwWZAJsf+mZgDG1qFHlJGlfx76nnCROpCMlmu+JyyQoOzExzOW1bM1wKglkq+l6XxbB85wgzCw2nDkfZtxrp43DfAcV1hiKAWyIUEPWuFKtkf/zy603fffy4ueX7PBN5Ny6cRiYe8MYjyTruOgnPJbUVNuIu5xADjaePuajTYjV0jAT6XKaXWqEs40rPkMSQ8MZo06yi3nRGkHpY2nYeCbrZ+G7R2W/tDoVz07Kjss/YXhDLgHGiHB4Q78z8nZuGeTwp0cA2AO//T/wW3fguydednu6Z0/39v90D9gVGbcJOs/pIFVPGzVNo75ybajwLyO8C426yPF0gBdgvwaMn2sTqxBsSu/BqOuj5eCVGHVx6lh37kZga1KLqjVK2J5wvGTAI7e18qcRFOxOp2ig9X3H9TZTPZKV0G1BZh3HagR+MLBHOjOkjss5bbcCVhcOumcVrtJTEDxvYRszJ5pRJF1uChw9CYWQMNMn2thxDKacchpIXy85BKVpwZm6HQb+MrAyKh0VbQQAS5tyqRH04aLNPr6fwHQl7PxqlG0Gku1tCZ7IcFByhHZJh3oXnVC01HU2PyXUxmdY6yOm2GeZTDy8N4DKqph1ZVO2EeHhOU6Lyy1smnoOmKqcL9k5dyIa3IeLNXTNoGjLU0Vbt75J4E+Y8PVZ+a6BMPxTzRzZAb33Z93CDMGyqKNM5EiQrjrdt83eaU/3MShNlBKt8A5PuKbSylTj1KGWzi3MCwkdsvDmCeUSR9AaEPFoQyPPw09ziAYV4jOwv9GAf7NT8A/W1Aw6Sc15zWs6UbsfLNwgi2Fos/Fylm6gcboxcBfhvQ3o8s7to78/Y29OtcvQ3EZ/odkiReUTmi1mar4Zl40/fx9Gy+4RjJtxvwWTFkz+EGByk+W3NYCRAuTDhXSyagQzUtL389mJ+Hz7QoHFOghKn6QQbBhTJnvVlYyQsg8XOo6MzngbnQy7UZwAWFRVslYVcBbJJC3eyEVOtJm1dEu+E4BKnw0oPzNeNWkMkypbjhDuApGBakBdnRSvSrQWeuh5LvyjST8XxZanVFX7+gs3d6kAwF8rL6yq6eE8XLAu6MMVtCJYeteV7sEPA1deSqJbv8JN0ewwWPnl41SQIkbKdSg9n07s9EJPZej3gxkd1Gxu/gzqwdbSFRlXNWWIhQ5dzLd+mXiNpqXYNp686zmBphlwdqwn5RF4JK+mbnhFdE696jE9uxfOst0H82z1eUQf2/I/n8tnwY/DNTrcO4dsKn4kl6x5lVDZJfvml356grLFNQmqkV+SCcVl4DhyYGUPgZL1/O6D5xedHbwBp+U4Wwb5QL9gSb2/PE81uSZwBXu5hTd6YTojGspKpwvh9XjUYEJHo3M2xV1BQWIEBQ2twnXKkr4xgOxp/M2kUm7i9DZAUiBbjTOtRfI1vfAqyy0zUJMyD8cm7B3l/EhbdS0K3iQjSq8ikTuXn19LFSLzpyVJrYAG6lpsIvOqfV6etPReTlUYuJPiRstnx82ixIHLflIdt4y2FL/JBIWe57h+M3AwRHeNwEtnP5CJT1UlSqDTeUfgdpRhobLxGuY4ZmpPxBhZ3VKVxiqYksJ12PgSluRXvGcDENVqrL2Evr6dQvVA4SXN0v0uZEgJJv0pT8gyHZB2WkxpSDWjMbmnkxItReKshwaJRNyFWQtn0Cx9BLHludOVknt43K7kG0HBLKg3DD6LhMZLivTOWeE/An5Lrp51Xz+Vr6SsuI54UwtKYQ/TUQ2Jbr1R4PfRkk8fGeUBc5bmItdkoWkvLqz5iBR4GI1lGDAGTALMBb7Ai0ZjTBONzWBctN/dGVOUsn91L87xCm11byCYZRG5Y0k2jjHg6tXYdG8/zQirIg+1pIDR/xXjs76Z/fLNfK1k1Eap3X9SNmo5GXUvTt0LbKCwZoYDTXNtzcdP38DlM9ahbIXWFkKrgeu06Rk7XnZleiXUEXgLc0FadJwtb4Sgr81QbrFJGlsTZ/RGV7l+3qHizMmksPIEqrqAEUZXuihI+Wx0mpaEHd+4wyV1S20XCJHqkEM5X0ekTOTI6eKz+rCLdaILA/Qb7Kb3opgy+kSHtoW4awq0zuVx5TucLpOh6btrPn9ypgACGDdnkw+cQip2iL+oJLIyKuOlWocnis0R4vrMAWjRJHdIHRZh/s6M6qjM5kmyWKQpbeJ64OfTT+osgTRaWoYx6NQg2bT0a2PTFwD2d2GGM6zMPIwJZ4fPWi8kj8dRmOBFxNfAKprmabhcPYJorI62Q3Z3OZjDw8i9BWDYlfdFNtwUS1nJuGiS413toHoOg5CBEsBrLj34LPS9nvRKTuMggI1JVHXJt7KjFPThP+QWSFPH2tbF+2O4eK0B9d0aUDCMubjC29kasOjb1yMmrSgWUxX5eoO8UVv791SbDVPWsEk/8ymWs9Ss3bJfdosNhKmiTWx5bDKi9NYV5cpXhQWnd1JjUj9qk6AqRlGHHMah1jXm/Y0RBzbwZXIg7nPYUrNEhxykTJ7eik7hKg3iW4a9NLYl3VvymoJmDYzSsvLUxIjdhrZNzZAmlXEfpWODzaunNU5vro7YPPG8Vev3xPFkPnHE5zzCR6dkEvTHDxdG6LPqqXGgsarY0hXF0TENCK/8oGxM/QGaGuNR1ty9PzYP6zZKBJgH8SNMREPZtU0gR/bulBmiindcfg8Bqk90h0Id/K+9SGHddUg73PUrb109qbCAi7f7bhcpWL7FVrcbv2jjG1SJ/1VzHdBD1vSGnPIFNpqQjypU38ezLXnNKzS6821o9PNPKmyvJfOqW8qD0aKhwY/uURbETm4bah77ldfRT7i8cIGwN1K/yUVkTcT9NxH3xFiy1oi1RvbfGvlKt6k+JiPMiUAJxVyGZhj3UJSuzENJVrr2/dEZZLUt73zrVe5torrszUfeOZPDOJPcQYi+cqYAcGTy2XixfDEupKBhuLRCHTm0NYxCZMVu1PCgcTzIVxzTjfW6B3lzjYnMQMoLgXQ48ib+u2tkfBXzpLLo0suedOqiTFNMr06hewWhF4rk4UGYLK6LN+FDg4Yl2gTASTtUB8dn97V4zpSTvD0UUM3j6g4+HQz7RDfpjSpu0DPvx9MmsnGp2j7lDxbe5zXssxF+se8PWiRtkfQ3jaTt+4P2/UH7/qB9f9C+P2jfH9xP74J8fxCT1Kpwqk3ktMDz+wKeNpHTJnLuSpJN5LSJnDaR0yZy2kROi7dtIqeNQ/6KiZwgwmPHjSqNri59YsPTkT0hsIbavhpqeyEQ7AmBPSGwJwT2hMCeENgTgn21WOQJgSfmlWB1cHrBzkevLVK1SNUiVYtULVK1SNUiVYtUvxOkmgRu/DqMzqHPuDqgGTqQblMqUzGPssyVI24uOfn8qstYTLx/mFi+D1O6jks+ZkA/22gZC22/ZWjbONVZvR2Se3UO85oTMc5u1xnCVt3clrx/aQllN+gyfAMMmyzco1X/8rxOHykf6OcfczahOAYnsGwXtnOP3+ZfIdMvqcvJKFwjxWYJjrbyAJkqqniB9QLg1r9aNckLT1+QwWK5vKRsdstHzybhqq4JVrIHaF7SAzRSXfi9QmjNDieVHy5SKWDS9+s1QDucYwETjJMHsly9RXcsJXuEKyzwAg+qXAZo2HIKKmWIAvAVArVFFN7JN50Lb8nBf2Sq3DO0bgKWBGlePJYc4ffmCXhYpaXp1/xsDJKSolwB24+/C864DBxp0DwV1S1ppqLBEdF1sQowZzMu5YlUpyq/8ZIvBrPH3bCgMyVRCkCp3EM6RbD3B9FdeNE6Dm94cKZ14WYjVG9RZcmMuiNGTZg5W1py5ED3iQrxkTOBd4u8C3pp1E5ZOnRzDDIzZ16aJ3P5DMo3HPeDAQXFuB85EJSgpfFvwlb1E4IsWDEj1Sm6FvTuE+i1iei7vQ/3nfgHt3gHLUg8elZVwq4qV4p8JNdhH0vPr8lH0na7/CWzt9LrX3S7R8yJY2d6nbknTLSDQvA4xUnpfJbCsMNcLQQPo/TCwF2TgGloehyVycAyG7wXfhcJFo3v65Z3L6buRGU9SJZOHyFm2SVKgn3Ep2YjBpt0yV4y9DzvxCayVEv99pNECy28Hsr8vWUop80XRD/B3fbKx42P111yDGCGMStlvYV3DtF3hDc/OYDA6OJe8s8p0KcU88k/2AyAAi6y3CdpcPcUyOwkIr0Cc/P97FaH75MO31GI8Zvq/LAuXb7F+r+M7GuB1m32w7jNbJKZTTLblSSbZGaTzGySmU0ys0lmFuXbJLOyMLZJZva1QPta4A8ptJ7wtcDMrUgzsO2rgFjddGrolwE3vPrX5OnAbV8GNB7+89w5UOriawbC9MKoZ9LwM9Pfv3UXSt1Cwid8y3Gbo+qHda8JbpZC3IdRTSrP/B92edvvYe0Tdw/rX657WPcQHTmRt3hY7mHtC3EPzZ57e3iC19qeRtxviWl2wyPNxNCa56ge1j0sZZXWniktbCpZVJ/rvQ9gazEMeNZPGdkkKesS31OX+F6YXjZJyiZJ2SQpmyRlk6RsOv/+ItZPhFrByC7EYaDT43SHrCV1Cna1qstcKGVpoKCLah+gKxWXZ3CPiV7vn47USZ4MiqITv0Mp7fDQDrVcB7Xzq04a7kl/qzP4b8Y9Uu/nUigkS0ih12VAQ+ho+boXCbfTXiaTyNFI8Y4SV5/ape8OzZAvgq1bzlo8u+y+6b/N3ntVWHDgwVLCYqjvTWFgGnX4WYTz+A5EdkdS2EEteuvyuyOD7MEjX2qsoj9dhPnz9sm9hy6E/CqASrkMvQb9YSl6LghYbBE5wM5zfP5wEcn3FQfdi+LjQXWiBQS8RjPNusa2I929fPlyxGJH3BRg0RaArGrtNx4zfa2JWiPiPbdZSAGWSuOQ8S3W84HkDs+Txo2rU3iUsHlkAKq1offBhv5ah7ZrefrPPbM9Lh/aWni5T/DSJgnVJAndAseoZJKtCXz74YJn6CKNOktJKNMvnVlf54XMPXH1yZUcBc5SXIdxE+u/wC5p1Q3M0lkk7ox3hC5+tHnltk5jV46PNvtolNn5hW2ZYkX/3yJSKpNmdGI1FynOyVsGZnwbalGM2ZH4Lk+8Fj3EcGD/eeEqjz+UR0tsTqCPa8C6jqAcDd9dwZ+A1lGQFXCtCd/bbAyFxoocwZKAMm+iRB4WszBozbiPo8o97grVsIusXr7WaBlm77KDNeBhnCsl5agcPDfYVftfuAH55Uj3p4+KYuZdbba49gnu3KVyBW7b5aMfupW4YSK6G/L1856EWmdeSrpAbz36Ciirn98v8UIE7J1epF0zKvY2jOmDI9eZ4itr9rZr2JWPy8j3fUxqo+htmHTPFTElXWKYNJ+xkkWq3jdGlDaKsc5itW6rnPZHV59fD3C76H9+Hl6+e3PZH40GH/rwM3L651532O0Nrv71+d3wanAx+J/+mf4yvBz0+lXfSzvvjGNSG+5wdg37XUoR6TgR5ceTpzBTKxYmMQkUM0g+07xVFI9JvmQbN2uUQmvX0izr5revXE0MrmjyEq+KCO5eDDA51shNkBoLBV5BkhgnSChbz90guW+doLXdQnHvu3/gVsP+pZ3jc67uydAsqp1BfxPUr3qBWGL0/NkS1vJQlMeoiWE/QNO3GAWf3b+gc71y3WOzEibkexT6RWaJrJfTJlP0YdjTLxWrl4GhlAy/pteJH7NbztXuwD5Ua2TsihCHTVOf0T6PYKW4A0wYwsijY6bMGRLmUFWFhD/RK8maNFHxWnKIp354mAMmLadSc9CUd2jDRgndY2K+p4yj0CuBZ20g3zBgfCoxhbiviUopEvR6dE+LcE5uWuUtXYauEt/QULMTwUI7hiDMjC5obNfTqDXN4+Ph6u3wXS9gSbWDuv5CelpT5ypewtLgApadX17PP7qeSu6702R68zQ7IYvdYqMXbCLbVf25ymas0+D45DuokZud33xP/fHFpZKQeT08WK/WFWAoa192ePtcwqyJOxtyWEcwbRY70a+Rj9a1ywhzN+jGg5yOOMZsIQcdjKozLUwzLSSrSoeJE+c1drsIGMmnH4SkFqTegM5hd7qelPtJFFEyCdaSDQM/TjjddQDf0yfoCXIaZBWOY/9NJYXMRY8OD7bZLvqWrIDfsf7rUQn+QKNNdEH/HtiUlGK+DRCLupmG0qzYgCHOkO8Myz3z/W/vQnjykwh9R4JBVdd3m0ydghjIUl+BrBIIPw3DeFc5gHUluCYxgCSn7R8bUoFPRVNvw9rMKzypwPFgul8EKgjUuUivBUkN2DbrLpc8mGWu03GHx9MOUIH/a8u2x5KrgEhCCmmoOMa4sK4H/5YZbLADqaDv0JVZsMmwjgN/e3PYwUgfFszb9hUmBrlGsgHkBlhYYLDh2w7BNcwj7kjkBlU7EuJ1ZvwWZAJsf+mZgDG1qFHlJGlfx76nnCROpAMlmu+JyySoyNaBZXgtWzOcSirtba1HRN7DYgrCzGLDmcPUT6+dNg7zHVRYYygGsCFCDVnjSrVG/s8vt9703cuLn1+ywzeRc+vGYWDuDWM8kqzjop9Q3k1XYyPucgI52Hj6mA82KdzORn6e2aVGONu44qujwNVJdoE1UgRlXOJmsv4hBcGFgbeqyIVqeF1FPqSBfJvfejrEE2G7Op9ALcBb56bZIQZBngab9npd1IH7yNN13W78oo234SR4W0LOonV0vGShommXNjbeKSeooeVeNqw1IR/lTU8tH7N25fEzNLqzl5Z+Ti/CkvIe2kaKeIuGBj+6R+mI2XugW102Bf3KKLkJl0CQFDVSbw+i7UH0npzw2JNle7K8/yfLX+mU9zGQ2IlACcVcXjph4OOSKx8lWSkc7dHHQ7Ut7+yNy6VMqBtnSEM9oS2cwziTnGGsTeECwPn7M/iRjRfLF2PtTXMzc1ahjhzaAnyOrNiNGsA6xDzjQb7imCLpzPvG88gMpLwQSIcjIwTvrpHxVVwokZ8EqRPqWIMR8mqlJh2dd0AvZLXxIEwW18UIPWjQOBZoAuBGVFK7RTI70nOmnOTtoYBqHldnA/qaryfy8I8qPPum316ddpjO3r/QHJMG09cwx+xNp/am08aOZHvTqYWLf/pNp1/spRr2Uo1NlNhLNeylGlZ0f9VLNUpyWMeEyVsSv3E5XC85i32p0UnInaZPHEpBfkTGivEQjeFMx4P7yPG0O32dOMZogAZLTt7hcoDb9rJ6wyEvmbK5oLF8h9NlMjRvU2k+f3KmesP36eKoCFdyiTc7abiQhbNDtBKR6SoEz1tCPZnVeqnWYY2SWku6qqejG9ZpsxoPCHomZlRHhVGDTluk8XO16q98gqQ9QTKyUDs9ZNPtrdVlOdQTKjMPD6DZ4bPWC8njYAUnMAhxDayiaV6jZZsQjdXx8IAsh3ZTxVy1KZayknGpBTABmsTsMAjB7MOYQMeDz0LfIfJIzd70VE92lPrW8R+FV+ns9Ts/yImNve/1Oz6nWgN8Swv1esTkpa8slm4nnC51e5dI3ypaB5ermvSzK9DLIXEWXO8TuLbHaNW0iS1feRjRMcaKAvPzjzxw33G97P4rzCBAbSKVp/Z9qxsBdWhIHGpdY14WEXFgA19GIuI+hy01S+RlXcamTA/t6RBhM+WYAqFPHNK9Jc89mjUwSsvKgzE8qVHYANo2NUMawcZ9lI4NNq+e1ji9JSti88TzVq3fE8eTwcsRn/MIHXLqjbkPF8YRlOop4w+Sxm15hS6FQ6qtRYzT0RVbuqI4OqYBYX4RhX7qD9DUGF/emLv3x2YU0EaJgA+Q/ggT0VB2pcax6Yut+DEfyGffVLdQ/PuA4vZNdfumun1T3b6p3sSvY99U/4afubJvqltr3Frjf401vieePfum+td4Uz0zCwenF+x89No+rGDNyX01J/dEEtqHFezDCvZhBfuwgn1YIfMUJ4Ebgz1/Dn3G1f4C6ECer1OZ6kBSKHPliJtLTufC1WWs0bhPRiM+4WBm1XhJ5FsIbCGwhcAWAlsIbCGwhcAWAn8nENgC0z0Gpr8kE7oulxInv4uUbxu782MjTRlavXmIOc6WdzhAv6AX31+ep7E8msBVmEStm3+IFuIdDLxT4T1CeD0eNQk1HZ2zKe6KeXqkkj9ikS9JaaxFF2fgbyaVUv9LOI3n4Etn2kDcGS2ktUgB6iBVA60YWlehybEpu0ZbxtcaXRcDbCtiDg0VmEM2tVSheH1aktQKpLfqKcSFzKv2eXnS9H7uqcLAnZTk45au9Gx2mgdc9pPquGW0pfhNHrv1PMf1m8HuId4AL/AGhw90vQxVlQCTEKwjcDvKzEx17UI1cxwzfV0fPnjRUpXGypKhyw/Z+BKW5Fe0UC6cYDXW1+z4GterHiirodkrbBdZVoMC48t0QPrCnCkNqWY0Jvd0UqKlSJyp2JBy6MswBBwmP4LYwsgRJfcwh+WbjngZpqPKIl5kEOIMw5EbJOKtu3wX5ix9IrLmcTCdWQlrPiIFHkZj+ToD3mMfuDHwBTSOSBasCFEOx1OUsn91L85hFaNE3kElYiei26RJNo7xCqJXubD/pxlhVfSYlhQw+r9ifBZg7xPAtol+37EHsMAGCmtmONAMe1nzMZ8XoR5l+WWUAo4tDgKsnWbtNGunWTvN2mnWTrN2mrXTrJ1m7TRrp1k7zdppT2Wnfbd20mZzwgqtvRNaDS7p3P5RIJoBiXWbodkr9Zi46dSgcWzMlmuS1IaH1DVZRyaV628FfvNL3/pbrL/F+lusv8X6W6y/xfpbrL/F+lusv8WaLtbfYv0t1t9i/S1WaP3J/hZ0mpheCXWvYAszploMX//ZyQ9jNql9MJtdLBv9NNv6YI63ctK8D9xbh2Gii75m1ybHWtfMnrpm9gIC2ORYmxxrk2NtcqxNjrXJsfsK9wvJsV3Yk27Ehqcji04tOrXo1KJTi04tOrXo1KJTi04tOv2r0elF6EwsLrW41OJSi0stLrW41OJSi0stLrW49C/Bpbki1E/2ANoM9kVPvl1WNdWphMByrdiljvMsU4pkVC8LMiwtYsdf4kO8oOpCqHIMTBmj6JKoU2thEb9fzp6QhnNokSXUZA0Z8uOskhTxxHQIDGDeigz1Xl4lc63vUT/nh6GbcQKi0XMWTXqUxauGXeyvZLXUltRRyL3Lfvdq8PYNFOl+6A7Ou6fnffj3Wf+8r37uX16+u+yfwb8Gbz90zwdnB2WeBb5ujySVyNHF8NkooqhYOWql6KviZrO5ODIjpWtoLBN23LzoJ9TBAIoc+fwnqNJzHiwwwvzls//4uRhgTZrK9Z1o1WDZTTWSzc/n3Pb+fIA26YEGCAUSTp49q6BgXQBexG9doYKpjIaeVzYkFc0VyLfKtihef03YFmYY+KK2+hPEAvqOa3zeODHAOtFKI2Oj9D+qCovpNfeditI0V2AWAO5Drv34v/+7/PImcpbXD//+7x//r/PpU/bD/zuoaBggduJX6Zz02znBV/lEmjmokyp2SzzvHJ+PrXkZQ8TJBCax5iMwNjBDqacXVYwNNlLTuZOMM4xCtNK2eR1UGUYjDtZWvGVFZHtKQtqpNsJQ3/2DtF55Pqpm3qxx5UQLXvN+yZZR2btFVKd2cPqeaiUt2yOFnVS7uRq5l/6q6f/5ZQlv/aqro9HCI3eqHvqbu+hSESKcuqQBVT4bwDI5/Dw4lxtJ57VVr04Y3lQ9Rqg+vY8qXp7Oq4Sy5KDXa6umSiuqBVCdTA6UCEU9WZGXUy6U2hxk/LdHsp+1ir9KNfauBh9SZQf/HXbfj/pnVR0oTa039GaTYaOhU9aApSra+pHCpvAdZf5yiW1BSTVDT04VTNstvg29jQQxuO4NkSXn0Hyl+C63KZ9uBgurdoUd5XsnARfwRo7qr0LA8XewRGX+l1+usBnd4ddgttSqaCpdv9VdE/F5pUAECO+7lU++ph8v1shTUJzXdc7S9HMfsGC1qN5leqv4pE/r//V28g6USjWLzofKyV27NdVwvqZo+FE4Yj84oSz/6IMWf4gCR5xXpuFUU/TngU3PmXCviS6oWSC3EUZdByNr/JzSpCviQcMCc4Vyqtd+XkGf7rTu8wCIjZah51R7mnZbhRyChpk9m5zFYV6BSg655GIZBoLLz9nXM8LyE54vRZ7M44OXz57Rpsjh/VNnxtBbinYswc1YKVvyzcuk0M5vQjoupGmO/zIdrBqSf9p0c0w9djeG0I+iMCpR/qJM+TtoWfpKg1BdVwD0PJB1PU0iN16RZD3lTgQbLkFz8iO5c30eX4dA+QFYjgfkUYBPBx2H5kx0vsh/DGYPBzrlU1BLCZokB/oU1Vm6bToxzY5Sy0dw9IUN1YEB62F51h0OaNNrMkc4q3KGTGLTScIeD5RfhHiMCsEv8h+vNSP9dhfT8N1gHlJ1/USjpAK73USgyosXqjCyA8wGNpYfvDlkLsU9dfuf2Qfcm3ixA/XzvP0ff28/074l3wmyY46UZ5mc9yKNXzKmPLjkwC8ABwU5KGccDG4v9VfK6pm5OtOHfAsXxCkb62UdtzPnUMzvYzwAd2nHJtLmlAzx8UAxBJR+pesij+MpL37+8mXiCA526sMD/gxbKJIcB1pH5R7OHU8UnczmeNYZ23VE3nDoJWflp0LwgFRi8+6NM0EnhpmdoLuX2hIyQGTqJTOuI0kitSfZ4ViK/fFRm8GKJFEg8OSe+8t4JaunRV7BwDxvfMTc9Gy+dvblwFJCRG5cn/APdS6z3RwfXipRdcSkVGRS6DSYaq3TgpVJS0qp5glyFKPrCMEp0CY/d6dTvoyNiiWBmpNFb/pXGNSU3/mFnW4ixTxRwItU4iq84cHDQ0pjjH8jgQ8P/x9GTGxQ +api: eJztfVtzG7eW7l9BMTUzVg0vspzZlaOnQ1O0N3dEmyPKSu3x5IhgN0gi6m50ADQlxuX/fmrh0neSTUreiWQ8pGKxG8ACGlj41v1LS+KlaJ1/bmFPUhaJ1q/tlk+Ex2kMf7fOW1dEckrWRCC5IsgnEtNAILZQf+pWiPokknRBiY/mG/VgSdckQjP9fOTPuq12i8WEY/1367x1oUaZk756pdVuxZjjkEjCgZ4vrQiHpHXesj202i0K5MRYrlplGnUfSEhOo2VGDW+1W5z8nlBO/Na55Alpt4S3IiFunX9pyU0MA+hGra9f2+mY94zfiRh7JBv294TwTWXcX+yLKEpCwqlXHLsyFo0kWapHC8ZDLPVPf/uxMDqWktN5IonYPXjf9yn8EwcobYLWOEjgUzFEIy9IfIJopD4IJyJmkSDo1SzAcxKI2UkXXRGZ8EggHCESxnKjm6evnKMoCYLZCaILxEIqJfG7ddPCnGOgj0oSiurStlskSkLYZLpb2GMPHfits8YcZi2KDyWVAUk/63/D7Pt2hq2vX7/+Cp9VT0cNd3Z6Cv8rLs/Hn1vtlsciSSIJT3EcB9RT+6/3m4BXvlRnwua/EU/CZuSwWyXVA+hNuP896tdsrHYrwEnkreBRths/t3wsyYATLAnsspjGJKARUfNvMEiIHy5JtJSr1vnZWbs6psfCOJFkGK3hbfiOeA6Lqk8BDoKPC3XMdo/lcaI2NA7EqGZu5S05yF7PnQS0YBwZehCJ1pSzKCSRRDiRK3hJfxXYjmp1BCIPVEg4yl7AEh/FnK2pT3jv75MBypHURVNC0Ge9iPkHv75aSRmL817PZ57oCvI74bhLWS8OsISj18Ex7XmqXSfX7qQLS8f4sjDZracWtiH2P0bBxq5raQvyJY7oH2p2NRwCvYLmHRYFmzYSRALvFBshSajpyLOhJ6BmF7PaR0qDPbdv+EHdBgjiFd5DzZJEcG3oqyVPk2aXBapen55WySqS8SmivycEQWO1L4E31uzNLhonQiKPRYIKCdfd687r09MCxW3kY7FqI8ZREvmEC49xgrwV5tiDa0xRWRi9uISn+6m9yP6yV249sfiBhkmIAtX3OYK+y5TYvV8m47/2EWG/nO0gPY/dHGvH96Izx9KDyxn+rU5uq91aMrYMSPrI/Gmf4j8Snj3Uf9lndz+JTkpzu0XuCn8u70j+z2RZ+FMECQ/zPwRikf8TBxJTnv8lZHheaMA8HBS6VEzErH724FfFa6MFXVavoInlNiImHl1QD+k3E24Y3lTyxJMJB1wVk8gXiOnbWpCAeLDn7Tiw1LtZNXCLC8r3M2ngA8innHiS8Q0CQKVOgpBMw6dIEh4SnwJThV4XAbtHCxoQs484uUqiqepx/2h930cY6V+QXGGJyAPxAN1YZBItOvqCtG/FnMLBBAizZndA0gfyIBUVMWceEYJY1j/hBOHIRzETssOTyHTR4AJQu6ynB+5hf40jj/g/xJx0cOR3bH8d05/mOPDr00wdLyThCAdBzdTQCq/1MQ8IIK4/Y6Y55tIA523ZkZZB716lYe4+WGNOAaYo9qwIUYD0yE5UW9XLiuD8FTpnLCA4qn6wOA5AfKEi60QytUnTzwRdod/YvJsDWU/UteXsv7E5nLSv7QJcVKtpFyQHkgeKpQyj9Y3pt3Lr1K6OkhHgpjensO5aUbesoW6Q8ri9m95KJbmJ5bgejAtYfGM2duktxWiO3dSW2I7uqwN96Q3tUyAypBGWrAGPtJwbwWuo0LgKlbAgPjDu9H7U3Juy6KRbgUVf64gx52bzQUuAxeftVojjGKiEi7twTcE8zDYYMzwvLnTNjdEU9je+S+pAHTQGpp1eMUfcGtPv8b6onfRf/aZ4ev5gZPZuJjk32oqXek9kwAYwTTqEXk8AXdBtIgj/0Oh2+iQIT2WF6fTvJZnV8nAlmAaJkACK4cJhQjYb4O9MSDUA42g0Qdj3ORGpfi3Xr755IuYTs7e43CsVvjmrbrLp3xG0NUJ5FAGnipZ1E0EXZIGTQJ6j2dnZLL1I/zshTa5k9VomZ4lkDhokNdS++/TRI2y7UoGVPqhmU/oHOWb5rKAVJeGccPhM0LU+sx6O0Jyg36F/H2GJWESQpGGGQf7B5h9jrWc95KAw3SaVV+2a6SkLYbc1MHG8xJL8fdtY2+DJaIGUzJ51bcfEnKC0Xx+2SWFNc3tkgQNBZhq4pBq8uZAgg77n1DccAjSdxdvmwLvZXpYawMBNWwAwBkbkJLfSBezQ7fNGt6AA/trOKRxyKKj/yxS9hR/3QqHixwTZFy/JtXqp7nPEnHhKU2v3EPBITrYpRSuvr1mQhEQ02G6ZCre0Cd5OkekF1jZkSSTRK82uztGsB1dOD4T58x7coJhGhKu/Z0ch4MefMk6WRaX5Nkb3yxTpd9H9inBlqmAJ94hA9zQIgKVqTa2PXpHusttGs0R0CBay89rM7bB7I79J9GwUy1bslSdRBDdIemH4sC+ig3vOery46r8ffkgVKRaJjoIggY9hnjcFZyKJ4fYm/q1gC3mPOelpCntsTfiakvuTHNmjSEgAcdv3dWGHDc4QNS204FNHf/oRFq+7Zw8B5ktS/Ar/YPMrFjQYD95C/asPsMWWHEcSLWhEOksOe9dHo/4YxYSbC05t+u33eorvmg0NfXM7PMxyOJgiicVdCSgegHfqvv123mrQwLdaqB1MPaATMKHuF4FBL2i6grkNLkd6dwSBhr6p4sAwm9RmUQvXneLwu1Acmn09iBNxDLz+kMLqweSTgHkyz+LOvYdpTELGN+P5UbhetbUDwvbeen7bsP9CssTzjTQqcQconzWgbLfu8ZoMI/izycT1m+jzL/q8Gf63/URB7ye1olK7tUiAaZ8dPvg71VCpS41ZdOv4eoyTnIG9RPkW2qJ1FJKphsYHE/jhZkwyOGEAdo6EKv1a48OW7zlL4ga6R2BPv6gb95ItBVpCM6vW0BNDAVuKl6TG1l9yGuFYrJhsItmXtkvadM9m6S0T6pOesK+f7P9yC8aXpGoE1ZjoHTwsraBRMXTR59w7TdfMGmJJtBa9VBb8ASeShVhSr1MYq8MW+oVOKlycIPOu8WyrSgUFT4VIq0U0tivOw7Idtfd8EgdsU8QexrVH7Dfiyi1A3VrZp5OP1602IPWqo94oD927aDYcnM0MOQIlkTLr8iSWFPYDizo+CWFWedQvumgGQ2Ttiq2mMZPZy+hVwO4JHDch9fYMaXTszT+mkVKsqXtfORjAJiP+PvtUiB+OHtLo8g4dchknB3PD95NPuVVWmGEu+olkUw8H227EohZhq84uJV058oGeAHZ2hzzEOPLV6D4Vd7tmhT4wqR5g/Z3vqVxtO+Y0J1M+Rp8xYGGIO4KA2ycgvMD42QAEuyfFfam2tF42hdCmEtosN7uOytvh9Pr23QiOi/3n7eTq4/ur4XQ6uhm22uow3Q76k/5gdP3P24+T69F49D/DC/tkcjUaDOueV07eBXithnDC0YrdGy6ilSaieL6U/hRzvkEskYqhpPJm4RKuo3im+Et2cLNO4a/ZTpp12+Lx1V8zxMutWqzC50qEZCHqj0dodAHTSISWcfXlBQyvxEmUA9UchA/FWy9plDx0zkDS7gDnD+kfcNRgfC3jhIRIUdiillf/h1DjWi8a4zwzSp1S26pVAKxcwqXM2Zr4aE24yPlN9UP8B4tKw0O3ee/ETPVEBczQ16g69pos0c1kAGsD/UVEGjOo6kAk84jIx5yWS3M6YAzTmxJ0BYNpq6XPaF9wFiKCvRVickW48lCDJVDMPCKaiwniJZzKjUJbT0Ga7dAAsdGFotAnoKsAcZaotxaUk3uQX3minBCU4YRFkrNAzcJ+CTB0IcnxYkE9DS/Ewxh0nvu/w7vpg/oIl0pFazSlMaOGfS/EQzPTXKmfHCPMBK6FeDjWlLSje0H/UI7b799a1W3MBPkYXZCAlDyR91p0fGij4U1OsboiUS3OocI00DufeGc/k80ENzHAwte7I+BQRnlmLvVAN5Fy7vu3iXf3NCcBZwh9+gbNdb9mPGrkxW03OJmLtwHz7o79dJkuvvypNHreDQ92X+sGMFRvX/Rq/VrDrDn1J4R7JJJ4+Sgrpr1rY049oha1eEe0ERYIg3LRDGaZaXYL6aZaWYJl8cbulgGj0udHTF0L+t4gPkoiSQPN9xPOYRMKaKU7pgLNCYBo5RWpLwDiK8iZIyt/db4+Pf03Lb6ShdCu4YccF21qECgi92j4blqBP2TRyBN+aD3YS32g0YXtpiE3K3eQY2ew73JCfKb3P1yb8ORWCGTeyVHVD2mTpTMQA7bUNyCrAsLfMiaP5QPQVoNrxQaA5LT/do4rEE80VTwYnFWUMK0uEqwUMB+JsmApBVPANz4VYLuoH4M3caY2nfWI9HrEE/BfV/c907uKRhopWC8T5WCC+oEkXPtqUKFfDPEGLpAkUNsOoxAHiyRSbm7wYlHMrxExlJYkm0BhgqUPjO9FFyu41vVY2NPIbTiY9jTE6/lkTQIQm7WSgniiozo1Mn93JcPA6Eswt/4Qzc/EVRJVFZjg4PdO95bTLwnYVt5utZaC5wVGmElssHIh80nQTTunQnHIsjQGbAA6Uqgh69xcrTz8248HH/r+1fhvP6JX7zleU8mi/NnIzUeT1S6rDNuamnoZ8Rjr42iv5bHoWqK2WupTorVP/pVFOIeo4TMkMckpY4wVuxwMaRGUNUnPN4WtnzmHnlR10sYinlnJwI+hEBGRc2V4r35HSst5oDfDv9zU7yx7L9+yt8uy+0K0686M58x4L9CMF3MGO7UJ9i5cOqadFVma+nMV+jCOXTnHLRDZOA6s69YfLGqw0wt9QhMFitLQ9m1jdDBEuecVhb5eoNRJZkG5kLpH05uK8JwT8PAOlFLaaMsU0Ot7HohfwxDToIFDv24ESgkltBFopqANuOxoVYW+1Aoq2YNg0xiD8tWgJrsE0esO9OFj7isfucISYLsIJWevvMazsVp4dGFVAlqTq9R91snbJHyIlnkkDLeM8SMiPrKCWiri3Iy76POneRLJBF1eT7PDoJh5V6MlJRYYxqFOSU+NLnpMdEyGih8S1cdtIMUJMtsnTuYBBBqrd5VncyoxdgG/gZWmQ/QRzgtyGH2+ICRGlwRzNbmb8Q66fELiTmBe7azDPIE/QLDQrdFMixMVO2RWTqH8waeLfmmFqECpURMHwSaNDe2ij1aP3UZTxSU67B7sV56WIc08rRMlXmOqkgBo+W2RqMBTTgKCBXm0GFHcw09jIpszJi+oUGq690e59UBLu0HnqbBu95qNXhpGSxplzgpdNIv99ADN0oMBpwgCvUGhXThH/3WK3r+1CsH8MfoThRLNKo8VSvKR2Hn3avj5eYgkxzsi7kf1Dio6qPgyoeI+Qe5geKI5xs1YK0gtPpka3np7cSZu128MFNwGMNUjzeIauobpUW2jnGfYzdi6gyn7bCOrLuUywYE16Wa9Glgsknn6eiP1tqIt38r2FOIIL4k/UnlQ5KZJZxCe2MFC0CXc+6YDk0lFbiq0lkYYBJREjeSCcblnTzW1evpSIh/jx/dLbf6abeGbbIn6EQ42knoCpalv7Aghi6jOT2F7v4ZD0cyQa3TqMuWcgIAKA2qtJZZ4wAITuz2MfGVk2d/9BZYYeWlDRExL7R5hPRCLvV8lQaNlKfcNVnO7JgFbIs4SaRflEWijeC/dkRrPmu13TV4rO8ZxdxhJvrmdqodd/b/bqh33cajFummXlan5rDBVZer7n4epoeOAWHnTyc/JXLlPAMkFIPICQZDT2b4EnS1oLUiDnVbY2doXJw5wRNCnq8v00rYEbljCO5CcCSIOQeI117cQwYDwJnkOppfIg1OhfLkUzMtdIMRGFUWG5SnBGH7LU5mLtVcJBOGuOGieaSvFStM0R1n4Vw4gGTlvloe004JC6KChRUktlHOms9uoY4LZwTfDeA9X4q0LVAHqflqSzBewINyyTdi85pxXFy3NyGdejrl276yaeJv5dd/9JH4wA3dyfZn9pkMKBgGmYTMcMAG9i4DkEjdKVldNNSBQRnQs4Dhq703d+ZbN0UbmTEhwgO6YRjPj86i8atDsimD/F04lGeNoM7PqvtAmcDAjKC+QZhF5Y+35AXF5RqURpxOy2gdPTWnLbPK7p5cSrVmiPwDZQ4Pr0qoxH3n6IYpZQL2N4XtgFTf8TaG+zPeWRbciUfNVF+k93sA/IgLM6NdqurmaZKD7ejBX8iSle6Ios0dhwvxpTLxHulvEzE8DgreEglmFK/PJVF3RjM+0Py54LkZUbmYqiaCEWE2Z94oF6Zv6yFCK/tkfX0ICW5MPTkjMleZUcb8ZeD6dz/Ka6KeZYZ0LoOUFMfP/jPk5zcoz16x8qxDQRgHV/6IY0GoI6IswgZe+u4GPGbQrCFt/ehoXp+J1jGgXI2qgzGxq075eFZUHxuTcgciKjjIf69wK6mkzMFruUs2tiXp4r/LaZkivsfHkKax1Q6tk1DGaExvTpKHBX1ztkSqHDvMrSNn+K71eJ4r/65mrLF/bvRh2sSLwZm9wOj6JcnzlE9lAS07Kyiu5EPRUHNCLk0leg9Z8/fRKDSafclmLldJZeSgc4c5QS2Stk8OP5js8kauLEKsLTMJGgTbGOgPBLr5qY8KA58lymcZ/idUoLMZqbE2oaV2LtVeAjaPRXWtFMnQ9Zv5RHusX0BgF4ECNXp123ug9LjlLICfsirFUm+yxePMIoqE54Pssb3QiyITTNZakr5McNjwUsW6Uy45IIE92sEGvIobIA8S04QCNJkbpZepINLap74042hapqgdKcRr8Qx+BNM6q6xSt34ei1ck8z1bmabeihbiGNGYNtuiHd1OkpSIkVROdeXSFIf2D1bKZPhvGd0GXYabZq4Z0OTnkmcshztWkjjZxoLViqoI/NyqSvM6tNs2cDCHvcH1EdT5+1mVPMnu55DMbcuKxMNShc3CwY878xBr1012dZr5WDiENPEgmg9R7JD1MOoi/WQfT9F1trMj5Pt9MBvmrIA25IiGwwwan1S6rQhYmD/UiCYJN5/cEBzralpMF4SSyIcKfb8Y512EzUmNHXdOwYxuKk7aaECTEULGK9sF5rzcDC9KCPrTzNrK9LOAfbC6+h4VoyKy2uEpkRXrOi/lzn4V75xMlE9gG7bdmFNiVF+iIhLc69ehZjXRbTnF7mNtdNZWr7Ve+6UJtnyT8pmEBoNxqmiqmmsnFEvLZeLWHYFvSuU7749HRGcLUzz8YH7iODjDuGO1ER02tg0N6kvl7K5WM6h7G1fnX50RnHlC4Gqjfp/5x4t/LF/9eiCDkJA0nabxASeMbpRR9TLQU5t6KSqJ9IXIZGCrJ4oB1VZKdPzq6amvPR+d7KtbI2RLZ+MhsKwVQMy9YNWyylRKi0YFZs2X8ZlYKzwJnYwMzCvBqwhlsxT5vaBScjYoNZypPux1B52zJQzGGsBBAB9b55+9XsPGNk5GJMEvTHNmwPh3ClyYNURn1rj5o1xkSsWS5Kud/50mUkzKbIDYtY1rX8ixTSYA9ohjsK0EjMJjoLq1/6RPlkJvW5I7LZ4az4m8undizja0r1SbNSV9TeOKKuD1rFOuKuElXxM0VcXNF3MoHxRVxe1oNoBNWn7Wwqou4FWq8n7tQO6cCfK4qQBdq50LtXKidC7VzoXYu1M6F2jkI7ULtnNvpk4XatXAgMeW1olJfPUKTt1OnOX7Wwo/THDvNsdMcO82x0xw7zbGDvfs0x4FY1MKh0dsxupy+c1jIYSGHhRwWcljIYSGHhbZjoSSi8h3jlzSkst5RLyZcK3vUOzULqN+5xuLuiig1Rv07DnW9ANSl6wJUksTonNbqZ2en/w7g2TO20zcO0jMp5Jf50kIQkZeIWZbzYcJYgzpAOitIzFiwR7MOhV6gy1J2l+3Fg60fdNWUWKzHmQeVYBZF2SnsFuoXFkvN2GK4ejFKyU2Qn8Bsaw1bqqGxVO5mAOvwwEICKigx72CfrW7VJJYn3LTN39NZHYIfVR0CfT+Eg5JR/wiDys045QJ5+n6ButuwxsLDASweFcgUHGprVs7hCwuIMleNwwrIgp4lg8ABb2VMpyxQgGvJ2b0uy1kqGOThQMd8nOrC30mURnTCm1N43jySBJp0LP12P+cm2TqyYvmFLlT+1twielOpySmit9lQSxXL00CdK7Ic+Y+LDbYhP8AFhOSFegqlaqT9PxTdpaKkkt2R6MLehXv3uH3TijzT/hSpLvLBB5ZzFGpenxnnAr0SEAD/MRqk/gJV7tAvbBA/v/IKxGsu/id7HIBls+xxoEkFHlmZ4T64tH3KsMlq5lwfTeZw7LPGsS5I8rjKP8/CqH5QhZsoCVQ5PI2k6oL7dHFDjD5XCuvo8jfHZSLIRKg0F4Ht9wRhKbG3yiq35wEMcL12Cn3S9az4dLJCK1V9PM1M1ShATc3DEl0bqKbDEgfPwzW7cZJXndEr1Y8a9K/3b1opEmXpOwT6DPUAORKSxOhHtCK88ZYu7An9Vsf89oO+7TuQmCT/eyd39exPO/oEGZCN2yvUILoioIimLDJX8QF6NEDPHHKOYNBEQzpIpUkzoM1cu2c/IR9vFEjVhyJ1C/WYkL1EpInV9if1dTf0s76hm7AoclcfN9JXSV3Q8Oepq/PklFrfjVLLBZ+44BMXfOKCT1zwiQs+ccEnDqW74BMXfOLqPLk6T98HI3rCOk+Zbq91TD0naJ7XPdiaTnvqNTUp+nRMTadkWa++/RTRNUbgiGbTojtv6eesuXDe0s5b2nlLO29p5y39jZGog4rPGiqCDzO0ZxEpmXwAuL09wn3ZKNy2uzBW3DWBRfKtNRQqr2t132Pc2IZvp0ZpqK2rSrn4SnMr0A/CjdMDZeN5L3USUX8bdf9f1lyfK6NxD5b3nGeqypc8J6nb3LaiGoddG/lNomejOLbirlZ9mN4XPuyL6OCesx4vrvrvhx+y6kQGpI2CIIGPYZ43xWap+8KtYAt5jznpaQp7bA16QHJ/kiN79MhiI3X0px9h8bp79hCAr0XxK/yDza9Y0GA8eEslwJYMLTmOJFpABY8l1yVCRv1xOR329ms9hXfNhoa+uR1eF2+ZIonFXQknHgB36r79XvXXt1qoHTw9oM2sF/BW6r0E5YQuR3p3BIFGvtT68hpm80hPFmfBfgkW7G+lTN65p/+1uuR2VZns8OSzxpPOl3iLL/E6ConxOT2YwA8346zad2bRTkmo0q8VPt+myMuLMPfY3TKNcCxWTDYR7EvbJW26Z7P0lgn1SU/Y10/2f7mDA9iMhqGLPufeOboqnPbETiOmOoWxOmyhX+ikwsWJja4iIsU4Rakgr9OGGxS0IhrbFedh2Y4pGB8HbFPEHsYjSOyPopNbgLp11JhOPl632oDUgaeVMG0eunfRbDg4mxlyBEoi5b7Lk1iqEogs6vgkhFkVShV10QyGyNoVW01jJvM1DgNwp1GevcZrn0bH3vxjGim9mrr30xI54Ku/NWTM6vOOHtKo8g4d8tFlmzRmmIv+nqC9ohZhq8ouJV1ARSHQE6jQPvIQQ1QkjK7qK+2YFfrApHqA9XdWTh5bjnm+gOW3KNmpvLGIjyrSqKnWBQhtKqHNcrPrqLwdTq9v343guNh/3k6uPr6/Gk6no5thq60O0+2gP+kPRtf/vP04uR6NR/8zvLBPJlejwbDueeXkXRDwjIcTjlbs3nARrTQR1VJgHuZ8g6A6LDCUvC9edgnXUTxT/CU7uFmnyr9nJ826bfH46q/ZtBKocUtqWgw071kUKd56SaPkoXMGknYHOH9I/4CjBuNrGSckxATL2i1qefV/CDWuqael8Xm12qiqvSvhUuZsTXy0Bme7LAjTupQXhoduNWIojigK5VLXsddkiaA+tKm7ZepcQS2wVlq+6zGn5dKcDhjD9KYEXcFg2mrpM9oXnIWIYG+li2i3kRFlFDOPiDR+aU9U88uSJmpqfzEozgaGaaj2rd5aUE7uQX7liQpmzlcHg1nYLwF2LiQ5eK15Gl6Ih3EzP9l30wf1ES6VitZoSmNGDfteiIdmlrlSPzlGmAlcC/FwrCVpR/dQCs9Uwjs2Cju9HUyErNaypopViMRuEIV9dB3BYgnBlHM/Qalnu92y4m/bqzxvu8GhgGHAvLujKximuvjyp9LoeTc82H2tG8BQvX3Rq/VrDbPm1J8Q7pFI4uWjjJj2ro05tbXQC3dEG5ySMSgXzWCWmWa3kG6qlSW4VHO6WwaMSp8fMXUt6HuD+CiJJA003084Vx6t0Ep3TAWaExUduSIoLaioIGeOrEIM/enpvxnP1IUYKMPBIcfFpsqIyD0avptW4A9ZiCZ3wfCBCmWJLvWBRhe2m4bcrNxBjp3BvssJ8Zne/3BtwpNbIWygZY6qfkibLJ2BGLClvgFZT1rJ9G2heGmh4qZo57gC8URTxcNO92+wUsB8IKqA4xBgZ1YGNRVgu6gfxyTyM7XprEek1yOegP+6uu+Z3lU00kghdXUD/xLUDyTh2lWDCv1iiFXeDF1YHmEU4mCRRCrkB14sivk1IobSkmQTKEyw9IHxvejqsu4QrtTTyG04mPY0xOv5ZE0CEJu1koJ4oqM6NTJ/dyXDwOhLMLfuEM3PxFUS1XgQswi9073l9EvG936nckRHbucZYSaxwcpBhEnQTTunQnHIsjQGbAA6Uqgh6/zxJYxzVYtz4D2bjyarXVYZ6gQ1W2TEY6yPo72Wx6JnSSlFy59YRja/9Q8uI1v0XdAVaf/iUapPBOS2KQC2orldOpkjnA202TcvnG9zL6CPNKPbfuWbLsTPJxCBWapwbYIDSw3zQmhjSV05MDcU06tStCXks84N0QkhTkjbmfvj0dHaWfVzmidDM/dOiIEi0lFT6+CQnqQzRp8EsVWz++ORdn2bE4361K0M1DuLs7M4vxDLjjMhOxPyCzQhfyNz7mMAL+beikqi41pz6LeiqAfWVXE0e7TxZ2vPR+vaiuEJOmxdXUlPKOkWQM28IPZaQbeEaP7rFL1/i2bL+M3M6spoJqwamFGAVxPOYCv2eZMcTyDVjooNZ8pHLp9StAjFGMJCAB1Y+/7dr2DjG49PRX4SpSqmtkUfSmeVCmzKmnH1QctkJGLJclX2veNJlFP6N0FsU/WmVXpkUmKAPaIY7CtBoyUcUvWizRXyRPr7aY3ePq+VN7aMvCr3TxS2tIT0aGHLZT5zmc8a64Rd5jMHBp8481nGid4zBqzdOg3oXB5/cX5knWT3j2Vmp7l26lv7Si/JibrvcumKcwoYsOxwHFgVzC4+AeaiBntAaRSqHhAAZi6oULbA90f5DpesAAoNFbwKigN6cTLJB3M3Xz+9UoPJp/TjGBcopUZppp0a65czLWuFyPQrRK87wiRW7/xovkPMGWzBJqimQLppZ81fQqwuMAkbWbINiAZw66s2xs9uniyXqYOFWI3CojF0a8C6FSa064nFzbprrb2Grkup+xtvhgtojAKwUKBXp503eo9LzpJ5QMSKMWlp9li8eQTR0Fxlbof7yAY1TzhdY0n6Ooi44aGIdaNc9DERCFAVehUxRB7AaQQHaDQxGpcAz0lwALg7WhOsB0r1MfCPUu2CIzILOC3fc9TyuSRFz1i3GS2Elkz2z+DDuynSaYyQ1MKMiuxfYfCvFmn6a9VnQwcK6DLMUvFVfSYc2n7WaNupXutpEwemF50q1ddGuWoWs4uSENMgy0wCPqVwfejb0qpQTAYiaz+UzF4u+dBhTjwWhto3BQ52zJmf6LSxuVOYWnaU4qmZ463VUqWHSevKmnUwTd/VylTQ7hkwcDMZ5K+C1KeBhMAOG5xWu6wKWZg8L4skCDad3xMcaHc2ThaEk8j64H2+GefUlmakbH8o9ttdKnitHGTMWVIbp2cbdmxDcdJWEwKPc+UMZB+c93ozSPm6oA/tvKl4LwuAujTfw0I0ZFapNLxbwn8Wvh0OS798LL1Ll/JCEKeDdA7SvUBI90Tat6bmpEIfpRKaVRXtHyxqsNMLfUKTPNjaPkYHl33mDNBM050sKBdS92h6w0G8wnOiSsUpnVINLB4CtG2AXWoRMWAESL6yzeZ+mN9gQTNbp4N9/U3dBnWRLBUmpnSMKnDLZusDtohVPEPOpxluGZMRBoRz43KfQsibcRd9/jRPIpmgy+tpY9gGo4seEx2fSEwD8UOi+rgNpDhBZvvEyTygnqZUG+NS62YXjMPgctExBTnzLvkYfb4gJEaXBHM1uZvxDrp8QuJOYF7trMM8gT/MsSC3JsZQnCD406yc8g0YfLrol1aIinJBTwXRgOSPNiLRuh102D24XHo6GsDM06bDwmtMVckz7Ym/SKSucRsQLMij/WOKe/hpgp0fb2SBlnaDZv4ndq+VhNDMvXUW++kBmmXepcrXQ4cmFs6Rdlopuqu8EI8HV9vbCSjPREBxtb1dbW9X29vV9m5iOXa1vV1tb1fb26l/vgf1zwtRzrra3o+u7V0W656FbcnVf3JM3zH9p2b6B+uZUylNeStbsTkTs86UmLVbElePNM5uGN5nZXUDzrPovpux9XVTDhiNEq1RLhOcRSblIL91/Uhfb5RxRtGWb2V7Kl1VTTqDgkEdLARdggK3ciuVaT3gMiybC2rvOxtFVixTZGMxf2H8TlVRbjLCJVuifoSDjaSeUF48ugCzGSFkEZWMW3fmgC2v4VA0y61m0tzIlHOCJF4YUMtKWOIBCwJdWnoY+SrvUQMpDUuMvLQhIqalToVgo0iLvV8lQaNlKfcNiezsmgRsiThLUh/vR6iNi/fSHalJdrn9rsmLvWMcd4eR5JvbqXrY1f+7rUrTj1M/73ODGb0do8vpO1ej7lmrlV2NOulq1Lkada5GXfmguBp1TystJxGV7xi/pCGV9arwmHAdnKLeqVlA/c41FndXRAVV1L/jBOdnLThDNbx8ZoMg4aEDWQ5kOZDlQJYDWQ5kOZDlCgF/H9Dn52Su6luAAut5JHZyno7ft6ejDnXfP8XCztZp2eIARwR9urpMTTiWwA1LeOfuJ9EB7AGO7MaYI0QwILwJ/JxeIg9OxSK1Vhet17rsa2QU4MrfHX7LU5mDQMqnCCwHB80zbaUuOxtDnINvuQvHuG/P8sxqemD4c27ocvxzTUhox2AMKJ5hyrtVrsECVcBPn5Yk8wXSzNgGHMLmNee8umj2PA/MyzHXSVeqOfibOUrc/SR+MAN3cn2Z/aY9GgYBpmEzCDyBcAoBmP9GueCrphrXKZcKLOA46kxZJrla/eZoI5tyGyrUdUyjmXE+VQnM0eyKYP8XTiUZ42gzs1E8ocXVZgSVZaJZyeRxlmXCoPY4nZANKvDUlLbMJr97einRmiX6xs+u6ig4YT7y9EMUKy88w/cAvf3J/oGTlO7MP1A7ZfsQD97YUFhfDyNmflqxfUutXhtHxXwyVVc04zNdMA1KS0VUbmbQOYBTGklRdU82lKJ/9seXSEie6MSxQmKuJAzF/WaQN/S8kHfhaWZY501reUHM/D9jfg4zP2vM7HIpPWPnydJ3N/Axg3bbnARN7cOfpylMOEBB7KQrJ1056cpJV066ctKVk66cdOWkKyddOenKSVffu3T1bKUbF071PTCiBoFDh1fNVFPWkLQZ6FTVKH+ZFnQPah57A76axGWBBXhLtGSeyt2JOd//PHRqEacWcWoRpxZxahGnFnFqEacWcWoRpxZx0ohTizi1iFOLOLXIi2JET6gWAd1GXnlgMpF2IIKno1KRH6UuyXdpVSX7NSF71SmPUpV8iugaIwjesDmWXYThc1ZfuAhD6SIMXYShizB0EYYuwtDhxaYRhv1AYsrR5O3U4R+Hfxz+cfjH4R+Hfxz+cfjn+8A/Y4bnDvk45OOQj0M+Dvk45OOQj0M+Lxz5lD6PbXLJoKpwyvAroMhBHQd1jprjbrZROhHwK1wPpObsil3+XF3Hgv76LOhb494Dr8TJQVdit9Y555gSP6U6ObbUtzmdTev/lA5lWi/81hYuNxWCGnlbbKHUlANan6G1KVHjQ1FKOk+Uq1pWJcjQfkD5oP3k2wJDxtMj21jq82QFL30syUDX96j75ik0hfc6ACwrH7JyaZlKsgqGConDOFcppI0EkVBIRE/wxEhcQn6K/Sek4RILiRLV5RYy9EO/lhTxxHQI8BI/iAxTH7V2r+0e0ZZvBe9ZmQi0CPCyyYj69bppl8erKHS2vmldvQdXw/716MP7VrvVv+mPLvtvL4etdutieDk0Pw+vrj5eDS9a7dbow03/cnTRqu7ZYbTuTjWVsKPLHsycK8dkPWsjyta5Lheq1uylsYYwkOiIgG8KqxXih0sSLcE3/8fT//O3suO6gmY0xHzT4FuWbwfNQ1tte02k8kXt4twWzvZtCxBry0aGlEg9Oz2toXSXsyQnayqMH1yuo9e1HWnCr8lDvdekiojY4XEHMRyh2Nr8Cfw2Q0xzj/cuDIGCSVa3knv7p7qXhbciIa55W61VjKUkHLbs5//93/jLe47j1dd///fP/6/366/ZD//ZqumYE5GEdbgkfab1UbpsVX5SZ3XbMgmCS6gVvqVWhJDJ/Cqpq9OrAgyUBqAy0pu6A8CTqOna6Y0z4QwuwUNKQRsF25R4nMgDG6a1zI5qDUqLkP6hrrzqetStfL7FNeZLsqWix4FO8sc5uKcKz7R4di0th8OEo+71/NcoVF+rp/9vP1awV1rTDtRlhFPPlMRbUJDzhGAeVdefiRikwkSqFXVI+iDZyMH6r8NYbXlC8+gTD+o5T3Z1VDmHqrdWt1T2llpSuUrmLcNC4R6oiYuqvpSqxlS0ZHeqx9l569fdi4Pr0U16KbbarUn/03R4UTeAuabtgd4vVu4VPqo3ZaWJVdJpZlN6Djw/jqGv8y92hZ6cqnaLrEl0GAfJ7br3iiy9hvmS9PeFQ/l0K1j6atcwUHF0xeAi0siA900IqNG5/eU+UXX/6yeqAKsd8FtstlSkaMpd/6qnhpNFLUP0WBjS2vqn6cPxDn4aJ2K1zeiWPh6GmNaz6mOWt26fDNX3/3Yn+QhK9TULCqHaxd15NM10viVr+F52xMvYCVX+px5Y9gcocEpIbQRVPUX/OrAZ4DkJHlGIlzbCqLtg5LaSvVlJ7XoJjApjBd36eBPhkHrbHo8iSXjMAlyvZjruKxQQ9JwEF/MLyYoXqN4hV0TELBJEP86eXigsPyfFt5T9rd368fS0Vck88Bb7CHQmIMcquCnNZQtxscZjoveb0IoLLZrDv/JqFgvJf92Xm2c7ds9NYcg54xXK31Qp/xgTo4WPmEkIQXzVlSBewqncKM76lmBOeD8BcfLzr3DYQiJXzG+dt5ZE0agSQ7R6WK2Z6H3R/xj5X1s2u4tQPSUgkrSsRhnHtKu0x5lauWoyU0/QxOidTPXn/mSkDr0lcwqrqlcoT2y6SDBiy+hF1B5TL7Xa5h/v7Eb67V6q6dNowVRzW8NQUwHD7iPQ5CUQ5mVlCPDUdihOPj9lotm9Gvb/Zg/gbELqDDXO6+7r07PuqVUuhVhtJ32o002L9MKXifyS7crWFZGckjURSj3pE4lpkGordfNMXlU6WniwpGsSoZn9rrNuph2S5EGCNYCqI5tooVPviM8tsyNa7da5bQubHByF4PGXL3MsyCcefP0KP/+eEK63nE+FMXUo/4od89klbW8jUhUvL4j5KRdsqTux+fA5AxeWxrKiLYRCG6y9IPGJtWxzcyjRq5nm+7OTLroiMuHgcxIhEsZyo5unr5yjKAmC2QmiC8R0tp2tq68nlhIiCvP6Ff4wtrzD1vjVleFVJ0izRaS5ToOltpdatMnTklJq94TSFIPuCNDpZ1NevtX3PBLLXMMKRy0wo/fDa/D2LB790lHPQ8UiUV++6Deu2R2Jvn5NaZTwNxD49ev/B3T4iQI= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the action identified by the given `actionId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-compute-env.ParamsDetails.json b/platform-api-docs/docs/describe-compute-env.ParamsDetails.json new file mode 100644 index 000000000..9cfba36ea --- /dev/null +++ b/platform-api-docs/docs/describe-compute-env.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"computeEnvId","in":"path","description":"Compute environment alphanumeric identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Additional attribute values to include in the response. Returns `labels: null` if omitted.","schema":{"type":"array","items":{"type":"string","enum":["labels"],"x-enum-varnames":["labels"],"title":"ComputeEnvQueryAttribute"}}}]} diff --git a/platform-api-docs/docs/describe-compute-env.RequestSchema.json b/platform-api-docs/docs/describe-compute-env.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-compute-env.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-compute-env.StatusCodes.json b/platform-api-docs/docs/describe-compute-env.StatusCodes.json new file mode 100644 index 000000000..2afb98abe --- /dev/null +++ b/platform-api-docs/docs/describe-compute-env.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"computeEnv":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"platform":{"type":"string","enum":["aws-batch","aws-cloud","seqeracompute-platform","google-batch","azure-batch","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform"]},"config":{"type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"status":{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"},"message":{"type":"string"},"primary":{"type":"boolean"},"credentialsId":{"type":"string"},"managedIdentityId":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"workspaceId":{"type":"integer","format":"int64"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}}},"title":"ComputeEnvResponseDto"}},"title":"DescribeComputeEnvResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-compute-env.api.mdx b/platform-api-docs/docs/describe-compute-env.api.mdx index 77595d354..b29f778e2 100644 --- a/platform-api-docs/docs/describe-compute-env.api.mdx +++ b/platform-api-docs/docs/describe-compute-env.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the compute environment identified by the sidebar_label: "Describe compute environment" hide_title: true hide_table_of_contents: true -api: eJztfWtz2ziy9l9BeerU2lW65LZTe/LpyLKS1Rkr0Ws5Tu1JpSJKgmSOedEQpG1Nyv/97W4AJCiSEiU7M4mCDzOxJFwaQKPxdKO78fUodhbi6PWno2noL5OYN3lwK44+N45mXEwjdxm7YXD0+uiCx5HLb7lg8TVnMx47ridYOKePqiqDqm4UBj4PYubO4P/u3OUzNllRqYV7ywM2VoV7wW1/Nm4dNY7CJY8c7KY/g47OqNsJ76bFoMjSiRyfxzxCSr8eBfABipotQSEX6Vw68fXROvHdEvocb3ntBInPI3eaERshQRH/I3EjDtTEUcIbR2J6zX3n6PXXo3i1xI4FzEWwOHp4aKS03IXRjVg6U56R8kfCo1WBlo+6ICvvvNCZG8R8wSP4aR5GvhPLr359leveiYGkCYxRbO69M5u5+KfjsbQKu3W8BBc2ZG4w9ZIZh39pxSIulmEgeIvB8idRINjYcybcE6+BeM8bM3fOQt+NYz4rJd2JIgdpcGPui+L8NY44zAHynmwVvlB/APvdN/HH5q0T4RCFUQp+jN3Y49nCAgf8PxxuRw8J5ubhMy6kpJ/6fvHsGf6Tn4/3v0Gn0xCmOIjxV2e59NwpcWP7d4FFvhaHFU5+59MY2TJC3o1d2UHGjtvLurMSdmqo1Sz5IUd1ye9Lz4mRPTZNsnMnmhMnnuL+wL+nXpggswr+B2xAvf3TlhpHizBceLzpuXPo3eXBlLhLfZu29GcSZZ9u/iXMFvhN7uPiJtd+ssh9FF4S+eYXnpibHx0PhE6UffP5gZZu7i62zzduzzM3Kpue4vZkM9j90ziMVgzFCYPemICPUJ7hbox8PnMd2DjY6twL79jc9bho0UJE/CIJRtTi9t5gOzKHyW9gxzkx4/d8ittYb8Fg3vScJJhe61LLyAVyaK/ehjdI0jt+HxMVMGRYImD3Fhtxzj4NI86cYMaWoYibURKoJsTn4+s4XorX7fYsnIqWXP+WG7b11ErWaMuO287s1oG1n/0CY2tCe03dXlO1dyJHDt8+zdCdOcwxCGivZGjs2rmVB47HUez8HSM1jpEawq6CI8u3+vos9YwTC0Sh60w84AmoSoSQ4N6zEapLrVxzx5RGkzD0uBMUFwxEIx7krsgaATZEJk2XCZtiv4cTaldJlCdqWmMMaB132oN5TH+Ss6knpJH/mDsvUFzAfFypbgqytXSy6GwUPNabsgTv0IgDRWx3XSpV7wF9GhvjxLqJRETYLx5JK8Xna6VI7uzL45rYpmyriW1J/p65SKTvBg4Ive2jGKp+GBZjucrsOAKOaIaBt2rQBE4cAYAQBqaJg2892B7Q0omEXs7sPZSW0OuhjBi1jVbvJPLJ/9448mG+kEoo6YfOpJk7GRUbDOCH/ERDxfXtCvLn/Zzg5hMdLeni3eXPmFAxlZcIkHv/EExcO8DWtLhMrOBLv8UG8COboJRjzkSEHrIfHU4o9qZQHDGkA5Dcx4IkJGnq7yKQR8yZovS0B9RPckAdiBySJWvtrbN0N91d88g4NmBuxBPtHtZPtZ0GaMBzJ/FiOhnGSgSMiepE8OhdrcP9A5TEk4oA5mj0b5zNQApDbPbfw648UINwpk5qWO16Tf8bSlLT0HJ/yJzZDHQh0teLrS7DyNwO5frmyxeFPpBirNtiZ3IyXrPxixfjFFOASlYHnVxeS0SjjQl/YLU1ocgSPDZgTpSoySEDuS2hMRN17NF5acfQ5921C10u3SX33EACEAYCmolkonRf1gXGAvYKb3kUuTPgJm3zSGvlthMR6jv3ROTI/ZPvM/1IOrTh+omPpoQJEAuDIOqy7Ql0STI1npKDFFALtKmAh4nATZ0t4PNnz7IV/N9w8p66K1XeK2WI6jGUVYm7q1EiHqbOArSpf1d1WIUaYTuSfYaN87SOaXVgN0uZ5UrOMSlopktXAis1SOhMYKTONH4LK6oEKRpc8of/jlBJYxeJJxH45PCkkqaGzruGh6zucVC6B1qpHhqGYcbAqJ2PI3aKX24Fqvm1RUOFs+CXVKhsdQA6TGG7zVKWQkkXod2yXvFbOD59LmpwX4X56qh3OmKqFZxqP0yAOY6luAMR1MZjro3H8+s2muYckJ8RfR7vpZ88ftNFfFFqeCvwEqyZLKtgCBy6YRIBemB3LqBFOCIAbOBssmPeWrRAdCWiyR3AcM/V2HY7vkwmkaOR8h1FLiCfANG3YlqoinwR7Nxy1uLZRedt711q9dIovu/BUsJiqN/r4kCRLBE98NkXEc7jO5DZbUlhG4/RW5ffnRhk9wMRI16s5usch3VfgPoha0i1tIz+dBHmz1sv7j0nWvD8KsCZchF6NfrDUqxz8Q5ZbBE5wM5zYNom/An/zFi/M2DAgr4rBJ2IUKpKtoCE13CmXtfYdqS7x1H2uiMWO+JmDRftgMjK1r5a1KrD91tN1AYZ77lDvO3ZbqBApK+awrF1z/uSOzxPajepWUcJG2q+Uq+3SvRPoUQrvu4uE7EPPH+XQvLu8IPAcYZ0jm7madXpgPugyw4m+3Qs6+oOkb0r928D+c/nC2eyitX9hcWXh4QvQYrBRuoF+LHOPMiS7NNHuf2UOKzeYNj6iak+zkHt4lKBnCcow1/s3vkbqmiaPyv7l32c4P00zZdga5RX0BbcAseMJFLemcB3VwOeoQuFtw0SivRLa1a4eBuFyXI7T3dRWn2kA/g8XAg4KKEa7eJ0YAxaE4dk65MrOQqcpbgO4zrq/xq7pFW3MEt7kbgz3ha6+Mn2lYMBLXjRd0BCpDf449oMKstHi30yytSdM9MPp52qhr/Q/5tEStMoooXfCXOSOIRzQXnoFDWDnPNLQKJM4bs88Vr0EMOB/ueFqzz+UCYt0dqqi8YVYF17JIyG7y/hI6D1osNR34TvLTaGQmNFjmBJQPfwUQKlkQnCoDnjPo7KRP6wAGPsIquXrzVahnFWmB3D6DjuMRFLngSlZt/Tf+AGZJijsx8m5dZFzoJJ3XKD6Dv3e3epbIG7drlYJjuLwLfDD8YsE26YiA4w4GjqeFWnYt6SUGnNS0kXaK5HWwFydpPfL2F9qXfQ/282jYq9g3XFHxy5zncu4P+Kve0aeuVjbBrd0PedpuDoqYYoz3NFjOAPYdgdz/MlsbScNkJpoxjrLFabtsppb3T55U0ft4v+88vw4v3bi95o1L/qwdfI6V+6nWGn27/8z5f3w8v+oP9/vTP9y/Ci3+2V/V7YeWfoaOfjDmfXsN+lFJGGE5HfX3hUTGGmVixMYhIoqc6ZO3nLKB6TfMk2btYofhpvpFnWzW9fuZo+HMVVlqzcciVwbvusM+iz/hkOIxFSz5UnFgq8NUliXCGhbD13g+S++QK17SaKe9/9E7ca9i/1HJ/zWORYVBuD/iGoX7HkU3eunM3yl0tYy0NRHuNJDPsBmr4FNENni7wl6fjOn/Ap3z02K2FCvkcQfIKuUCSyXk7rTNHVsItzg+0FPEZtGEpRAyKZwDeP2S3nandgH6o1UnZFiMOmqc9on0ewUtwBJgxh5FGDKXWGhDlUlTQB30VuvCKI9RSk6QYV+uqfEYUzjvYKVGk5lZrDSXmHOmyUkJsIrjyCtCj0aBR6JfCyDeSbM4cFl5hC3A/Q7rl9Hd6M7mkRzslMq6yly9BV4hsaqncluNaOIQgzpQsa2/c6akPzAppEef32VJtvQePm74MzkClrHo1b73pmWEfCG8O4es2DcidkoSpIzufTF7/x1dCpc6OMq3fD0QPQjdILWsOPggT7aTK9eZqd4GSwfPSSTWS7qj9X6YxVJzicvadwjNzsu3SZPX59qSRk3gwPNh/rCjAUT192fPtcwqyJOxtyWEdQbRZ70a+Rjz5rl5E7pRtdJ39GNJgDU4oGRtWZFqbZKSSrSoOJE+dP7NY6YCSbfhDSsSDPDegcdqfrSbmfRBEyocBasmHgxwlHEI2/qwOALiGBCTKy1u5j/0vqrHwuunR5sMt2kdcNAiT4Heu9GRXgDzRa5yzo3QOb0qGYbwPEom6mpjRbb8AQZ8h3huae2f53NyE8+U0EU2UMqjq+W2fqFMRAlvoGZBVA+GkYxvvKAawrwTWJASQ5bb9hSAU+FXWtDQpn5TVMbY/EmwocD6x/Gt8hPT0mq0yBbbHOcsmDWWY6Hbd5PG0DFfhfS7Y9llwFRBJS0O4b5OTCOh78jexLZjgq6DsrPEBgk2EdBz57c9jBSB8WzOv2JSoGmUayAeQGuLbAoMO3HIJrQKvflsgNqrYlxGvP+C3IBNj+0jIBY2pSo8pI0rqOfU8ZSZxIe0rU3xMXSVA0YqKbyxvZmmFUEshW0822LILnOUGYaWw4cz7MuNdKG4f5Dkq0MRQD2BChhqxxdbRG/q+vdt70nYvBr6/Y8dvIuXXjMDD3hjEeSVZj3U7YkNSU64j73ED2t94+5r1NiNVSNxNpcppdaISziyk+QxJDwxijbrLXg7o0gtLX0rDxTNbP3HdPinZpdSue3ZQ1il+he4MKGJHhJoaHw1v6npG1c0cnh7/cA8Be+B3+hd+mC98DsbLb2z17u3f4t3vArsi4ddB57gxS9bRSU9frK9eGcv8y3LtQqYscTzt4Afarwfi5NrEKwaY0LLeqj6YDvVT6qWPduRuBrkktqtYoEHrCY3cKwgrN1sqeRlCwM52igtbzHdfbTvVIVkKzBal1HKsR+EHHHmnMkGdczmi7E7AaOGieVbhKT0HwvIltzJxoRp50uSlw9CSsuYSZNtHahmNQ5ZTRQNp6ySAoVQvOVCQ7fDKwMh46ytsIAJZW5VIl6GrQYp8+TGC6EnZ+Oco2A8n2lgRPpDgoOUK7pE29i3YomioW/5eE2vgCa33CFPssk4mHAeZUVvmsK52yhQgP73GaXG5hU9VzQFXlfMnOuRPR4K4GG+iaQdGmp4o2b32TwF8w4OuLsl0DYfhRzRzpAd0PZ521GYJlUVeZyJEgXSViQ5Lfa0t3Aw5NlBLN8A5vuKZSy1Tj1K6Wzi3MCwkd0vDmSZyQSyaQKvijFY08Dz/NJRpUiM9A/0YF/u1ezj9YUzPoJFXnNa/pPAi9YOEGmQ9Di42Xs3QDjdONgbsoCaTJO7eP/vmMvT3VJkNzG/2NaosUlU+otsjA9oLW0sGvfwylZX8Pxu2434JJCyZ/CjC5TfPbGcBIAXI1kEZWjWBGSvp+OXshvty+VGCxCoLST1II1vQpk73qSoZL2dVA+5HRHW+tm2E3ihMAi6pK1qoCziKZpMVrmciJNrOWbsl3AjjSZ32Kz4xXdRrDoMqmI4S7QGSgGlA5duJVgda1HrqeC3/U6Wew3vKUqmpbP0CYa/xhmgX8eeHio5ElaGsP5+GCdeA8XEErgqUJhnQPfhi4MimJbv0SN0W9y2Bll49TQYoYKdehtHw6sdMNPRWh3wtmdFGzvfkzqAdbS1dkXNWULhbadTHf+kXi1ZqW9bbx5l3PCTTNgLNjPSmPwCP5Y+qGl3jnVB89pmV34CxbPVDPVl9G9GNL/vOleBf8OFyj3b1zyKbkSzLJmol4iibZt7/10huUHdIkqEZ+Sybkl4HjyIGVAwRK1vJ7CJZfNHbwGpyW42zp5AP9gib14eI8Pck1gSvYy03Mh4XhjKgoqzNdCK/LoxoTOhqdsynuCnISIyhonCpchyzpjAGkT+N3JpVyE8sDHtOo4QGy0zjTWiRf04RXWWyZgZqUejg2Ye8oZ0faqWuxZk0yvPRKArlz8fmVVCEyf1qS1ApooK7FJjKv2ufFSdP7uasKA3eS32jx7rielzhw2S+q46bRluI3GaDQ9RzXrwcOhmiuEZgS74pUfKoqUQLdzjsCt6N0C5WNVzBHg6k9EaNndVNVGitnSnLXYeMLWJKPmGcDENVqrK2Evs5OoXog95J64X4D6VKCQX/KErJMB6SNFlMaUsVoTO5pp0RLkTjrokIiEffarIUzaJZ+BLHludOVknt43a7kG0HBzKk3DL6IhMZLB+mds8I/An5Lpp5Nv35uFCahJGHithbUgT1MRzUkuvVGge9HSz59pJcHzFkai1wRhaatuLDmIzrAw2gs3YDRYRJgLvAFNI75GABEms64qL+7M6YoZf/pDM5hFaNkSrY+UMsiMseSbByjw9XrsWnefpoRlnkeakkBo/87xmdtM4dlm/lWwai1Qrv/omjUYjDqQdy6r7GBwpoZDjTVtQ0/fv4Oks9Yg7IVWjsIrRqm07p37JjsyrRKqCvwJsaCNOk6W2aEoF/rodz1JmlsdYzRW03lOvl0yZ2TSWHpDVR5AcONrpAoSNlsdJiWhB3fucElNUvt5giRniHHcr5O6DCRI6fEZ9VuF5tEFzro19hNH8R6yOgTXdqu+V2To3Uujivf4XSZDE3bXf35kzMFECBdHGUDJ5eKPfwvSoks9cp4pdbhiXxzhLg+cwBa1IkdUpdFGL8zozoqsnmSLBZpSJu47vv58JMqTSD1lpZuDDo0SDYt7drY9ADA/j7McIaVmYc+4ez4WfOl5PE4ChNMRHwNrKJpnobL1SOIxuqoO2S5y0EdHkbuLQDDjswXWXNTLGUlI9EkMAFaqdlxEDI4BDDNpQc/C53Xk/L413YC2BpEVRV8KztKQR/+IbdAGjrWsiben8PEaxWoH1aBgmHMxSVmZ6vBou/ejJjUolhMVeTrDTKjtrbvqTZrhqxhk35mUyxGqVm95bD0FusIU0ab2PHaZEThrSuKlS9zC05zUmNQP54mQZmPonY5jEN91pj5GyMObODL4EDc57ClZol2OUiZPM2KTu4qNfxbht3UtyXdWzJNQb0GRmlZeWti+G5D2+bJkAaVcR+lY43Nq6c1TjNXR2yeeN6q+UfieDKeOOJzHuF7PTII+tPVwHB9Vj3VdjRWFZu6ojhp0IAw5QdFY+ofoKkxXmXN3fuGeVm3VSLAPIifYSJqyq5dHDmyd5xMF1XMcfkjOKg+UQ6FKvhfmUhhUzqkPXL9yqyrL0o04PXsvrt5Chaz2Op245ctfIMq8b9prANayOpmyCkmsNGEfFKu+j7ebck0r9Do3tnQ6OtflNteU8ZVN5UFo0lDgy/dk8yJncw21Dz2K9PRT7hMuEDYG6nfZiKyKuLhq4gHoixZbcRqI4evjXyjbKqPiQhzIjiEYi5dM4w8FIWUeSjJCmnfHx1BVtny3lmvcm8TVUVvPjLnTA7jTHIXITrlzBrAkcFn48Xy5XgtBA3dpRXqyKGtYRQiK3aimheN436+4pgy1useZOYaE5mBlBcC6XBkJv67a2R85fOkoujSZE86dFGGKaapUyivIPRCnjw8CJPF9XomfGjQ0ETrADiph2rn+Cxfi+dMOcnbYwHVPK5y8Gln2CfKpDcqyaBn5sfTKrKRVO2Q4gfXnrM19LMR/mLfH7RI2iLp7xpJ2/cH7fuD9v1B+/6gfX/Qvj94mNYF+f4gBqmV4VQbyGmB548FPG0gpw3k3JckG8hpAzltIKcN5LSBnBZv20BO64f8DQM5QYTHjhuVKl0d+okNT0f2hsAqaoeqqB2EQLA3BPaGwN4Q2BsCe0NgbwgOVWORNwSemJeC1f7pgJ2P3likapGqRaoWqVqkapGqRaoWqf4gSDUJ3PhNGJ1Dn3G5QzN0IM2mVKZkHmWZS0fcXHCy+ZWXsZj48DCxfB+mkI5LPmZAX1tvGQttv2doWzvUWb0dknt1DuOaEzHOsusMYatub0vmX1pC2S1nGb4Bhk2u5dGqfnleh48UL/TzjzmbUBydE1i2C1u5x2/zr5Dpl9TlZKylkWKzBEdbeoFMFZW/wGYBcOtfrurEhacvyGCxXFxSNrvFq2eTcFXXBCvZAzSv6AEaeVz43TXXmj1uKq8GqRQw6ft4DdAO51jABOPkgSxXb9E1pGSPcIUFJvCgykWAhi2noFK6KABfIVBbROGdfNN57S05+EeGyj1D7SZgSZDGxWPJEf5ePwAPqzQ1/ZqfjUFSUJQrYPvx98EZl44jNZqnorolzVQ0OCK6ylcB5mzGpTyRx6mKb7zgi/7scRkWdKQkSgEolXtIZx3s/Ul0r71oHYc3PDjTZ+F2JVRvUaXJjDojRk2YMVtacuRA9wvl4iNnAnOLvA+6qddOUTp0cgwyM2deqidz+QzKd+z3gw4F634/ciAoQQvj34atqicEWbBkRspDdC3oPSTQawPR93sf7gexD+7wDlqQePSsqoRdZaYU+Uiuwz4Vnl+Tj6Ttl/wl07fS9C+63RPmxLEzvc7MEybaQSHYSHFSOp8FN+wwVwvBwyhNGLhvEDANTY+jNBhYRoN3wx8iwKJ2vm6ZezE1JyrtQbJ0+ggxy5IoCfYJn5qNGGzSJXvF0PK8F5vIUk313S8SLTQxPZT5fdM4nLYniH6C3PbKxo2P111wdGCGMavDegfrHKLvCDM/OYDAKHEv2ecU6FMH84t/sRkABVxkuU9S5+4pkNlORJoCc3t+dnuGH9IZvqcQ4zfl8WEdSr7Fer+N7GuB1mz205jNbJCZDTLblyQbZGaDzGyQmQ0ys0FmFuXbILOiMLZBZva1QPta4E8ptJ7wtcDMrEgzsOurgFjdNGrolwG3vPpX5+nAXV8GNB7+89w5UOriawbCtMKoZ9LwZ6Z//95NKFULCT/hW467XFU/bHpNcLsU4j6MalJ65/+wz9t+DxufuHvY/HLdw6aH6MiIvMPDcg8bX4h7qPfc28MTvNb2NOJ+R0yzHx6pJ4Y2PEf1sOlhKXtoHdihhU0li/J7vQ8BbC2GDs/6KSMbJGVN4gdqEj8I1csGSdkgKRskZYOkbJCUDec/XMT6mVArKNlrfhho9DjdI2pJ3YJdrqoiFwpRGijoosoH6ArF5R3cY7zXe6cjdZMnnaLoxu9YSju8tMNTro2n8+t26u5Jn9Ud/HdjHqm2cykUkgWk0OsycEJob/mqFwl3O71MJpGjkeIdJa6+tUvfHZohXwQ7t5y1eHbRedt7l733qrBg34OlhMVQv9eFganX4RcRzuM7ENltSWEbT9Fbl9+dGGT3H/lSYxn96SLMn7de3HtoQsivAhwpF6FXoz8sRc8FAYstIgfYeY7PHy4i+b5ivzNYfzyoSrSAgNdopl7X2Haku5cvX45Y7IibNVi0AyArW/ut10zfaqI2iHjPredSgKVSP2R8i/W8L7nD86Ry4+oQHiVsHumAanXoQ9Chv9Wl7Uae/mvvbBvFS1sLLw8JXtogoYogoVvgGBVMsjOB764GPEMXqddZSkKRfmnM+jYvZB6IqU+u5ChwluI6jOto/2vsklbdwiztReLOeFvo4ifbV27nMHZl+GixT0aZvV/YliFW9P8mkVIaNKMDq7lIcU5eMzD92/AURZ8die/yxGvRQwwH+p8XrvL4Q1m0xPYA+rgCrGsPytHw/SV8BLSOgmwN15rwvcXGUGisyBEsCSjyJkrkZTELg+aM+ziq3OOuUA27yOrla42WYfYuO2gDHvq5UlCOisFzg31P/4EbkF2Ozv70UVGMvKuMFtc2wb27VKbAXbt89EO3EjdMRGdLvH7eklBpzEtJF2itR1sBRfXz+yUmRMDe6UXaDaNi78KYfnDkOpN/ZcXedg298nER+b6PQW3kvQ2T7rkipqBLdJPmM1bQSNX7xojSRjHWWaw2bZXT3ujyy5s+bhf955fhxfu3F73RqH/Vg6+R0790O8NOt3/5ny/vh5f9Qf//emf6l+FFv9sr+72w8844BrXhDmfXsN+lFJGGE1F8PHkKM7ViYRKTQDGd5LOTt4ziMcmXbONmjZJr7UaaZd389pWric4VdV7iVR7BnUEfg2ON2AR5YqHAW5Mkxg0SytZzN0jumy9Q226iuPfdP3GrYf9Sz/E5V3kyNItqY9A/BPWrXiCWGD1/t4S1PBTlMZ7EsB+g6Vv0gs/yL+hYr1z32KyECfkehX6RWSLr5bTOFF0Nu/qlYvUyMJSS7tf0OvFjdsu52h3Yh2qNlF0R4rBp6jPa5xGsFHeACUMYedRgSp0hYQ5VlUv4E72SrEkTJa8lh3jrh5c5oNJyKjWHk/IOddgooTwm5nvKOAq9EnjXBvINHcanElOI+wqvlHWC3ozuaRHOyUyrrKXL0FXiGxqqdyO41o4hCDOlCxrb9zZqQ/P4eLh6O3zfBCzp6aDSX0hLa2pcxSQsNRKw7P3yev7R9VRy350m05un2QmZ7xYbvWQT2a7qz1U6Y9UJjk++wzFys/eb76k9fn2pJGTeDA82H+sKMBRPX3Z8+1zCrIk7G3JYR1BtFnvRr5GPPmuXEcZuUMaD3BnRwGghBw2MqjMtTLNTSFaVBhMnzp/YrXXASDb9IKRjQZ4b0DnsTteTcj+JIgomwVqyYeDHCadcB/B7+gQ9QU6DrLXr2P9SQSFz0aXLg122i86SFfA71nszKsAfaLTOWdC7BzalQzHfBohF3UxNabbegCHOkO8MzT2z/e9uQnjymwidI8GgquO7daZOQQxkqW9AVgGEn4ZhvK8cwLoSXJMYQJLT9huGVOBTUdfasDHyCm8qcDwY7hfBEQTHuUjTgqQKbIt1lksezDLT6bjN42kbqMD/WrLtseQqIJKQQuoqjj4urOPB3zKCDXYgFfQdSpkFmwzrOPDZm8MORvqwYF63L1ExyDSSDSA3wLUFBh2+5RBcwzjitkRuULUtIV57xm9BJsD2l5YJGFOTGlVGktZ17HvKSOJE2lGi/p64SIKSaB1YhjeyNcOopMLeNlpEZB4WUxBmGhvOHIZ+eq20cZjvoEQbQzGADRFqyBpXR2vk//pq503fuRj8+oodv42cWzcOA3NvGOORZDXW7YQyN12FjrjPDWR/6+1j3tlkLTsb2XlmFxrh7GKKL/cCVzfZa6yRIigjiZvJ+sfkBBcG3qokFqpmuoq8SwPZNr/3cIgnwnZVNoFKgLfJTLOHD4K8DTb19SqvA/eRt+u63fhlC7PhJJgtIafROtpfcq2iqZfWVt4pJqim5l5UrDUhn2Smp6aPUbvy+hka3dtKS1+nibCkvIe2kSLepKHBl+5JOmL2AehWyaagX+klN+ESCNJBjdTbi2h7EX0gNzz2ZtneLB/+zfI3uuV9DCR2IjiEYi6TThj4uGDKR0lWcEd79PVQZct7W+NyIRMq4wydUE+oC+cwziSnGGtVeA3g/PMZfMnGi+XLsbamuZk6q1BHDm0BPkdW7EQ1YB1innE/X3FMnnRmvvE8MgMpLwTS4UgPwbtrZHzlF0rkJ0FqhGpoMEJWrVSlo/sO6IW0Nh6EyeJ63UMPGjSuBeoAuBGV1GaRTI/0nCkneXssoJrH1d2ATvP1RBb+UYll37Tbq9sO09j7N6pjUmH6FuqYzXRqM53WNiTbTKcWLv7lmU6/2qQaNqnGNkpsUg2bVMOK7m+aVKMgh7VPmMyS+J3L4WrJud6XGp2E3Gn4xLEU5CekrBgP0RjGdLy4jxxPm9M3iWP0Bqix5GQdLjq47S6rt1zykiqbcxrLdzhdJkMzm0r9+ZMz1R1+SBdHebiSSbzeTcNAFs4u0QpEpqsQPG8K9WRW85Vahw2H1EbSVT3t3bDpNKuwgKBlYkZ1lBs1nGmL1H+u8vgr3iBpS5D0LNRGD9l0a+fjsujqCZWZhxfQ7PhZ86XkcdCCExiEuAZW0TRvOGXrEI3V8fKANIdW3YO5bFMsZSUjqQUwAarE7DgIQe1Dn0DHg5+FziHyyJO97q2e7Ci1reMfa6/S2fQ7P8mNjc33+gPfU20AvoWFejNiMukri6XZCadLZe8S6VtFm+ByWZN+lgK96BJnwfUhgWt7jVZOm9jxlYcRXWOsyDE//8gD9x3Xy/JfYQQBniby8NS2b5URULuGxKE+a8xkEREHNvClJyLuc9hSs0Qm6zI2ZXppT5cI2ynHEAh945DuLXnvUa+BUVpWXozhTY3CBtC2eTKkHmzcR+lYY/PqaY3TLFkRmyeet2r+kTiedF6O+JxHaJBTb8xdDYwrKNVTxh8kjVsyhS65Q6qtRYzT1hWbuqI4adCAML6IXD/1D9DUGF/emLv3DdMLaKtEwAdIf4aJqCm7UuXYtMWWfJl35LNvqlso/mNAcfumun1T3b6pbt9Ur2PXsW+qf8fPXNk31a02brXxv0cbPxDLnn1T/Vu8qZ6phf3TATsfvbEPK1h18lDVyQORhPZhBfuwgn1YwT6sYB9WyCzFSeDGoM+fQ59xub0AOpD361Sm3JEUylw64uaC071weRmrNB6S0ohPOJhRNV4S+RYCWwhsIbCFwBYCWwhsIbCFwD8IBLbA9ICB6W/JhNLlUuDkDxHybX13fm6kKV2rtw8xx9kyhwP0C+fih4vz1JdHE7gKk6h58y/RRLyDjnfKvUcIr8ujOq6mo3M2xV0xT69U8lcs8iUpjbUocQZ+Z1Ipz38Jp/EefOlMa4g7o4W0Fh2A2knVQCvGqavQ5NiUXaMd/WuNrtcdbEt8Do0jMIdsKqlC8fq0JKkVSLPqKcSFzKv2eXHS9H7uqsLAnRTk4xZSeta7zQMu+0V13DTaUvwmr926nuP69WD3EDPAC8zgcEXpZaiqBJiEYB2B21FGZqq0C+XM0WA6XR8+eNFUlcZKk6Hkh2x8AUvyETWUgROsxjrNjq9xveqBohrqvcI2yKIaFBhfpgPSCXOmNKSK0Zjc006JliJxpnxDiq4vwxBwmPwRxBZ6jii5hzEs37XHyzAdVebxIp0QZ+iOXCMQb1PyXZiz9InIisfBdGQlrPmIDvAwGsvXGTCPfeDGwBfQOCJZ0CJE0R1PUcr+0xmcwypGicxBJWInomzSJBvHmILodc7t/2lGWOY9piUFjP7vGJ8F2IcEsG2g3w9sAVxjA4U1Mxxour1s+DEfF6EeZfltlAKOHS4CrJ5m9TSrp1k9zeppVk+zeprV06yeZvU0q6dZPc3qaU+lp/2wetJ2dcIKrYMTWjWSdO7+KBDNgMS69dDspXpM3DRq0Di2RsvVCWrDS+qKqCOTys1Zgd/+1rP2FmtvsfYWa2+x9hZrb7H2FmtvsfYWa2+xqou1t1h7i7W3WHuLFVp/sb0FjSamVULlFWxixFST4es/e9lhzCa1DWa7iWWrnWZXG0xjJyPNh8C9dRgGuug0uzY41ppmDtQ0cxAQwAbH2uBYGxxrg2NtcKwNjj1UuL8WHNuBPelGbHg6sujUolOLTi06tejUolOLTi06tejUotO/G50OQmdicanFpRaXWlxqcanFpRaXWlxqcanFpX8LLs0VoX6yB9BmsC+68u2ysqlOJQSWa8au9GDwHBF/WM72qCR2qaFejSv3kBCxEyelUiPP0ZkzbPei17nsv3sLRTpXnf555/S8B3+f9c576uvexcX7i94Z/NV/d9U5758dFacOprc1kn2jiIUzz1mUcCnJHdd3olU5+QYkKHvP6KHw9lFFqTBa5H4pF+6/vjpS3lXkal+7hudMuFfnib4KMeDW7ahcXlQLAdog8qm/8vl1hTpxKn9eQZ/utOrnPhAbLUPPqWTAPXaOIfvPcWbPJmdxiJu0jMsuuFjCWcNlkazEGQmXCS+WpO3eOHr17FnRefzUweeO4WwWuEoYXKLkOx1g0nOy/buQrlJies19B/8ypZDm9c/bwquqN4UxjF4UhVGB8pdFyt9Dy1JFCELl0w/0PJCP9TQB+LwiFfqUw5kcdRJ04P9EMs/n8XUIlB8tONFIvv1H+cCGr9N0Fvuzh9RBUlCTSeRBBa1zOEu3JZ+AThWPImClX9hQHa+si+VZZ9g/QoI0vSOcXjlVJtXpbGGPSAoVQ6ajQvCN/OON5qzf72KaBzeYh1RdP2ggqcButxGovMiFKkzvyk2JL/KDN4dM77PT5p2H/5P9gJsVwyCon+et//5n65nWiUGUZaAgZeAyt/Z1gr9mrHp0wYGL+C2X767OeAxkCI3pSx8eJdFJL30rsLxwbwE5j81FHxsv4MZwHKMy6dIGpxn4qvjm05HJN1DltdkI7glUnbDc168TR/APkffwgF/DloskhwKSUw599FDfhpF+1IIaYTeP3Gk2lKiS3BsO3eRkfCo9jwhX1u/fQNpODJM+wZmltoQ0u4DuMuPaPhOpTYyPFMZJBHh8LM+N1wwf5RszN9VqtxCfdiZytH/GDwrR7DaRx+rZxNkJ65YwiOMtr50dplgfgsHKpE9Tn2MINAcS9sSwP6BZFumAnr+MjcoF6ZsTXG97l0f0ArApHdakgWk/zBMGjEglLvGB2oeHlE56sBYJfHj4/457IGY= +api: eJztfWtvG7e29l8hFBycGNAlSXs2Cn96FVnJ1q6V6FiOg32CwqJmKIn1DDklObLVIP/9xeJlbhpZI9nZrR1+KBprhuQih1x81v1rS+GlbJ1+aQU8TlJFOoStZeu3diskMhA0UZSz1mnrgihByZpIpFYEhURhGknEF/pP2xQRtqaCs5gwhWhImKILSkI03+i3lnRNGJrZl4dsPQpn3Va7xRMiMAwzClunrTM97JwMstda7VaCBY6JIgIo/dpiOCat01axp1a7RYHOBKtVq0r8oIY+HCUrzNKYCBrkxAogSJA/UipI2DpVIiXtlgxWJMat068ttUlgYKkEZcvWt2/tjJZbLm5kggOSk/JHSsRmi5bP7kVUP/jWYJQpsiSi1W4tuIixMj/94+fS8FgpQeepIvL+0fthSOGfOEJZE7TGUQofliPKgigNCaJMfzFBZMKZJF10QVQqmESzCM9JJE8RS6NohugC8ZgqRcJa0rEQGGigisRye/3aLcLSGPae6RV23V0HfuussYCZyfJDRVVE8u85ZOv/hVn23Uxa3759+w2+nyFbD/nm1Sv4X3kZPv7aarcCzhRhCp7iJIlooDdh73cJr3zdng2f/04CBbtRwJZV1AyQ78L979KwZhe17UeseVCiuuZ5EmEFu+K+tcW3sjPHKoBjAf8OIp7CHpXkDyKwO/VZT+3WkvNlRPI2f6Yi/+vmF1l8l9yU/lzelHpKl6U/ZZSKuPhDJBfFP3GkMBX5L7990x9pQZf7VxbO3xkVdQuxff5QSAUJFBcbBPwCLbhAUnF4H8FxEzEJKVYEQa+LiN+iBY2I7OolF+QiZVPd4/7R+mGIMDK/ILXCCpE7EsA5dWeMLToRTlmwcm8lgnJhDuOa3wBJH8id0lQkggdESiK7aEoI+jIRBGEWooRL1REps13I316ulErkaa8X8kB2zZfuUt5zS2s2Qc8M3MPhGrOAhC8SQTqYhR3XX8f2d2JmzqV6nKnjhSIC4SiqmRpa4bW5USICfOWvmGnhnmjAzXbsyPpDXV2lYeFKWmNB8TwiCJpqQjRnPrIT3Vb3siK4yHfmnEcEs+0PliQR3NRU5p0orjdp9pmgK/Q7n+t+Le94pK4diPidz+GkfSvew1/MaroFKV0FwB+GbH1l+91im7Wro287SZQ7hTUIRk+RWeoGVTa0e9O7+7UwMWibGowD48Jts7Ebu/KWZjTHbmpHbMf01YG+zIYOKRAZU4YVb8AjJ3YcBK+hUmP0UhAcdjiLNm29gHMsSYg4Q444JElEAujpxIApHH5k0caAqW91xNhzs/lgsEz5ebsV4yQBKk+/tmKO553SpWe3wZjjeXmhW+2t84mj6ONCA8hHukvqcCU0BqadXTFH3BrTH/G+qJ303/2meHz+YFGp7t3Q0mgrnps9kQMbwDTZEGY9KWe621QS8aHR7fRJEo3DdW/T6T8RTtUKpJUgY2awJ/85GaAgSqUCEQYuHC5VswH+yaXSA3CBRhOEw1AQmcmVhX7NzcN4SOzeEsUtVS8j/fRme5NN/4mgrZ5QwBkDTsWWdRNBZ2SB00idotmbN7PsIv3flDS5kvVrKFs7mc5BTtJD7btPHzzCrisVWOmdbjalf5Jjlm+M72icxiC6zomAzwRdmzMbYIbmBP0B/YcIK8QZQYrGOQb5F59/1D3VyoI7Dwo3bfQsYfHcmpkpS+m2NTBxvMSK/HPXWLvgyWiBtKSfd+3GxIKgrN8QtklpTQt7ZIEjSWYGuLhbqT+XSuBAvRc0tBwCZPbybXPg3ewuSwNg4KYtARgLIwpSVeUC9uj2aaNbUHF8axek+gIK6n+eorfw414oVP6YIPviJbnUL9V9jkSQAA5AtoeARwrQdTV7fc2jNCaywXbboftoDd9Oke0F1jbmKVPopWFXp2jWgyunB8L8aQ9uUEwZEfrv2VEI+OGnTJBlrdZma/N8niLzLrpdEaGVbjwVAZHolkYRsNRAEM19XpLusttGs1R2CJaq89rO7bB7o7hJzGw0y9bsVaSMwQ2SXRgh7At2cM95j2cX/ffDD5kixSHRURSl8DHs86bgTKYJ3N4kvJZ8oW6xID1DYY+viVhTcntSIHvEpAIQt3tfl3bY4A2itoURfOrozz7C4nX3zV2ExZKUv8K/+PyCRw3Gg7dQ/+IDbLGlwEyhBWWksxSwd0M06o9RQoS94PSm332vZ/iu2dDQt3DDwyyHgylSWN5UgOIBeKfu2+/mrRYNfK+FuoepR3QCFoL9IjDoBW1XMLfB+cjsjigy0DdTHFhmo7vfKTl6xeEPoTi0+3qQpPIYeP0hg9WDyScJ8+SBw517D9OYxFxsxvOjcL1u6waE7b3z/LZh/8VkiecbZVXiHlA+aUDZbt3iNRky+LPJxM2b6Mtnc94s/9t9oqD3k1pRqd1apMC03xw++DvdUKtLkdxIReKd45sxTsCIqRdIogrlO2hjaxaTqYHGBxP44WpMcjhhAXaBhG36jcaHL98LniYNdI/Anj7rG/ecLyVaQjOn1jATQxFfyuekxjZfcspwIldcNZHsK9sla7pns/SWKQ1JT7rXT/Z/uQUXS7JtaTaY6B08rKygVTF00ZfCO03XrOis0ctkwRc4VTzGigad0lgdvjAvdDLh4gTZd61Hx7ZUUHKWYEYtYrBdeR6O7ei9F5Ik4psy9qAJiSiDu2KfHKp2AHVnyp5OPl622oDUtx1URkXo3kWz4eDNzJIjUcq0WVekiaKwHzjrhCSGWRVRv+yiGQyRtyu3miZc5S+jlxG/JXDcpDLbM6bs2Jt/TJlWrOl7PxF8TWGTkXCffSrGd0cPaXV5hw65TNKDueH7yafCKmvMMJf9VPFpgKNdN2JZi7BTZ5eRLhFmCPQEsLM75C7BLNSjh1Te3Dcr9IEr/QCb73xL1WrXMacFmfIh+owBj2PckQQ8mwDhRVQqAH4AwW5JeV/qLW2WTSO0qYI2y819R+XtcHp5/W4Ex8X983py8fH9xXA6HV0NW219mK4H/Ul/MLr89/XHyeVoPPq/4Zl7MrkYDYZ1z7dO3hk4ZsVwwtGK31ouYpQmsny+tP4UC7FBPFWaoWTyZukSrqN4pvlLfnDzTuGv2b00m7bl42u+ZoyXO7VYpc+VSsVj1B+P0OgMppFKI+OaywsYXoWTjFOpQHmDmeat55Sld503IGl3gPPH9E84ajC+kXFiQpQsbVHHq/9b6nFlQgK6sJaXLhplrldt3SoCVq7gUhZ8TUK0JkJvYGtK6cf4T84qw0O3BjGUR5SISphhaFB1EjRZoqvJANYG+mNEWTOo7kCmc0bUQ07LuT0dMIbtTQu6ksO09dLntC8EjxHBwQpxtSKijawoo5k5I4aLSRKkgqqNRluPQZrr0AKx0ZmmMCSgqwBxlui3FlSQW5BfRaqdELThhDMleKRn4b4EGLqQEnixoIGBF/JuDDrP/d/h3fROf4RzraK1mtKEU8u+F/KumWmu0k+BEeYC10LeHWtKuqd7Sf/ULojv3zrVbcIl+cjOSEQqrnB7LTohtDHwpqBYXRFW77QqbQOz80nw5leymeAmBlj4ejcEHMqoyM2lAegmMs59+zYNbh7nJOAcoU9/QnPTrx2PWnlx1w1O5vJtxIObYz9drouvfiqDnu+HB/df6xYwbN++6OX6tYFZcxpOiAgIU3j5ICumu2sTQQOiF7V8R7QRlgiDctEO5phpfguZpkZZglX5xu5WAaPW5zOurwVzb5AQpUzRyPD9VAjYhBJamY6pRHMCIBqe2wuAhBpyFsgqXp2vX736LyO+koUcaMPBIcfFmBokYuQWDd9Nt+APWcgmd8Hwjkptiq70gUZnrpuG3KzaQYGdwb4rCPG53v9wbcKjWyGQfadAVT+mTZbOQgzYUt+BrC0Q/pZzdSwfgLYGXGs2ACRn/bcLXIEEsqniweKssoTpdJFgpYD5KJTHA2iYAhEGmQDbRf0kISzM1aazHlFBjwQS/uuavmdmV1FmkILzMtEOJqgfKSKMrwaV5sUYb+ACSSO97TCKcbRImXZzgxfLYn6NiKG1JPkEShOsfGB8K7tYw7VuwOOeQW7DwbRnIF4vJGsSgdhslBQkkB3dqZX5uysVR1ZfgoXzh2h+Ji5Stq3ABAe/d6a3gn5JwrYK7ldraXheYoS5xAYrF/OQRN2scyo1h6xKY8AGoCONGvLO7dUq4n/8fPCh71+M//Ezevle4DVVnBXPRmE+hqx2VWXYNtTUy4jHWB9Hey2PZdcSvdUynxKjfQovHMI5RA2fI4lJQRljrdjVICCHoJxJer4pbf3cOfRkWydtLeK5lQz8GGywgQlKKLgyvNe/I63lPNCb4T9u6veWvedv2bvPsvtMtOvejOfNeM/QjJcIDju1CfYuXTq2nRNZmvpzlfqwjl0Fxy0Q2QSOnOvWn5w12OmlPqGJBkVZkOauMTp4dlJWFIZmgTInmQUVUpkebW86LHZOwMM70kppqy3TQK8fBCB+DWNMowYO/aYRKCW00EagmYY24LJjVBXmUiupZA+CTWMMyleLmtwSsNcd6CPEItQ+cqUlwG4RKs5eRY1nY7Xw6MypBIwmV6v7nJO3jWtmyyIShlvG+hGREDlBLRNxrsZd9OXTPGUqReeX0/wwaGbeNWhJiwWWcehT0tOjyx6XHRuZ/SLVfVxHSp4gu32SdB5BuLF+V3s2ZxJjF/AbWGk6xBzhoiCH0ZczQhJ0TrDQk7sa30NXSEjSieyrnXVcJPAFBAtdW820PNGxQ3blNMoffDrrV1aISpQZNXEUbSxEA5I/Oj12G001l+jwW7BfBUaGtPN0TpR4jWmkmY6W3xapSrWzZUSwJA8WI8p7+HFMZHPO1RmVWk33/ii3HmjpNug8E9bdXnPRS0O2pCx3VuiiWRJmB2iWHQw4RSkzCu3SOfqfV+j9W6cQLB6jv1AoMazyWKHEhDxvySR9+PlpiCTHOyLuR/UeKnqo+Dyh4j5B7mB4YjjG1dgoSB0+mVreen32Rl6vf7JQcBfA1I8Mi2voGmZGdY0KnmFXY+cOpu2zjay6VKgUR86km/dqYbFM59nrjdTbmrZiK9dTjBleknCks6GoTZPOIDyxg6WkS7j3bQc2n4rabNFaGWEQUcIayQXjas+Bbur09OWgSOfH97mQEWbvCOd8ifoMRxtFA4myZDJuhJgzavJTuN4v4VA0M+RanbrKOCcgoNKARmuJFR7wyMZuD1mojSz7uz/DCqMga4iIbWncI5wHYrn3izRqtCzVvsFq7tYk4kskeKrcojwAbZTvpRtS41mz+64pamXHOOkOmRKb66l+2DX/u9624z4MtTg37aoytZh+ZVuZ+v7XYWboOCBW3nbyazrX7hNAcgmIPEMQ5HW2z0FnC1oL0mCnlXa28cVJIswI+nRxnl3ajsANT0UHsiBBxCFIvPb6ljIaENEkz8H0HAVwKrQvl4Z5hQuEuKgiZlmeFozhtyKVhVh7nSYL7oqD5pm10qw0S3OUh38VAJKV82ZFSDstKYQOGlpW1EIFZzq3jTo2mB18M6z38Fa8dYkqQN2PS5L9Ag6EO7YJm9ee8+1Fc+d5YF9OhHHv3DbxNvPrvvlFvrADdwp92f1mQgoGEaZxMxwwAb2LhOQSV1pW100NINBGdCzhOBrvTdP5js3RRvZMKHCA7thGM+vzqL1q0OyC4PCzoIqMMdvMnLovdgkc7AjaC6RZRN7YeH5AXJ5VaSTZhJz2IdBT2jGb4u7pZUQblhgOQPYw4LqyajxEgXmIEh7RYGP5HljFLX/TqC/3veXsWqZ6vvoivcUb+AcjwIx+a29Nsybl3b4e7JU8yeieaMrcUZjwcJqQ4IHuFgkPs4DgHaFgTuHKQzLVVzQXM+OPC56LjKrNDDqHLAiUqaJXLEjfNESWUvTv/vgcSSXSQKvlpMJCa04195uB59PprKiJfpwZ1rkAOl6Q8PCvmJ/XrDxxzcr3CgFtFFD9H4oB3Q4BfRYm8Mp3t/Axh3YlYesvT+PiVbyeEd3HiBooM5vatC9XZeWBNTl3ILKio83HJreCftoMjFa71HNroh7eq7x2OYBrbDxFCmvd0LYy6ljNiYtpMtDgb672yJRDh/kVZGz/pVmvE83/zcx1lq/dXgz3sSLwZm9wOj7JanzlI9lAK07K2iu5FPRUHjBI0klRg9Z8/cxKDSafso9jlc7aQ+EId4ZaImudHH623+GRXF2kXJ1hEjcKtLHWGQh2CXUbGwY8T5fLLP5LrkZxOVZjZ0JN51psvAJcHI3p2iiSoesxD4/yWD+DxigCB2r08lXnJ7PHleAp5IRdcZ5pkwOebB5ANDQHfJ/njU4lmQi6xor0TZLDhociMY0K2RGJRKAWRi8ZR+QOYtpwhEYTq/Sy2dIb29T3RhztilQ1A2U4Df5hjkAWZ9X1itYfQ9HqZZ4nK/O0W2whLyGNWYMt+uHdFBmpCCndxGQeXWFI/+C0bLbPhvFd0GWca/a2Q7q8HPLE5RDvalJHmzzQWjHVwZ8bHUle51abZU6GkHe4Plidj59z2VPcXS7FzIaCBDyOTegcHOxE8DB1Rv1sV2eZr7VDSAMPkskg8x7JDpMJ4m/WwTR71xgrCr7PV5NB8SrIQq5IDOywwWl1y6qRhc1DvUijaNP5I8WRibYVZEEEYS5E+MvVuOA6bEdq7KhrG3ZcQ3nS1hOChBg6VtE9OO31ZmBBWtC7dtFGtpcF/IvP5Y+wEA2Z1Q5XibwSzmk5f+6TcO98pGQCu6D9zowC9+UFOiLhrUk9+qZGuq2muD3M7W47lavrV/3Uhdo+afxdwwJAudU0Vcx2JhdHyBfr1R6DbcnkOu2PR0dnCNM/v7A+cB0TYNyx2omOnloHx/Qk9/fWKhndPYxr8q/Pick8oHE1UL9P/ePFv+cv/j0TQchLGl7SeIaSxndKKfqQaCksghVVxPhCFDIwbCWLA9a1lez8wdFVO3s+Ot9TuUbOjsjGB2ZbKYGaecmq4ZKtVBCNCcyaLZOfZpXwLHA2tjCjBK8mgsNW7IuGRsHZqNxwpvO0uxFMzpYiFOMISwl0YJN//nYFG986GdkIsyzNkQvrMyF8WdIQnVHv4oNxnSGMp8tVNf+7SFlBymyC2IyM6VzL80wlEQ6IZrAvJWVgMDFdOv/SR8ohN63JHVfMDOfE30I6sScbW1cpAlqQvqbwxBdxe9Io1hdxU76Imy/i5ou4VQ+KL+L2uBpAL6w+aWHVFHErFVM/9aF2XgX4VFWAPtTOh9r5UDsfaudD7XyonQ+18xDah9p5t9NHC7Vr4UhhKmpFpb5+hCZvp15z/KSFH6859ppjrzn2mmOvOfaaYw9792mOI7mohUOjt2N0Pn3nsZDHQh4LeSzksZDHQh4L7cZCKaPqHRfnNKaq3lEvIcIoe/Q7NQto3rnE8uaCaDVG/TsedT0D1GXqAmwliTE5rfXP3k7/A8CzJ2ynbxykZ1PIL4ulhSAiL5WzPOfDhPMGdYBMVpCE82iPZh0KvUCXlewuu4sHOz/obVNiuR5nEVSCWRTlp7Bbql9YLjXjiuGaxagkN0FhCrOtNWzphtZSeT8DWMcHFhLQQYlFB/t8dbdNYkXCbdviPZ3XIfhZ1yEw90M8qBj1jzCoXI0zLlCk7zPU3YY1lgGOYPGoRLbgUNuwcgFfWEKUuW4cb4Es6FlxCBwIVtZ0yiMNuJaC35qynJWCQQGOTMzHK1P4O2VZRCe8OYXnzSNJoEnH0e/2c2GSrSMrlp+ZQuVv7S1iNpWenCZ6lw21UrE8C9S5IMtR+LDYYBfyA1xAKlGqp1CpRtr/U9NdKUqq+A1hZ+4u3LvH3ZtO5Jn2p0h3UQw+cJyjVPP6jXUuMCsBAfAf2SDzF9jmDv3SBgmLK69BvOHif7HHAVg2qx4HhlTgkVsz3AeXdk8ZNlnNnOujyTyOfdI41gdJHlf550kY1Q+qcMPSSJfDM0iqLrjPFDfE6MtWYR1T/ua4TAS5CJXlInD9niCsFA5WeeX2IoABrtfOoE+2nls+nbzUSlcfzzJTNQpQ0/NwRNcGqpmwxMHTcM1unOTVZPTK9KMW/Zv9m1WKRHn6Dom+QD1AgaQiCfoZrYhovKVLe8K81bG/vTC3fQcSkxR/7xSunv1pRx8hA7J1e4UaRBcEFNGUM3sVH6BHA/QsIOcIBk00pIPUmjQL2uy1++YXFOKNBqnmUGRuoQGXqpfKLLHa/qS+/oZ+0jd0ExZFburjRvo6qQsa/jr1dZ68UuuHUWr54BMffOKDT3zwiQ8+8cEnPvjEo3QffOKDT3ydJ1/n6cdgRI9Y5ynX7bWOqecEzYu6B1fTaU+9piZFn46p6ZQu69W3nxhdYwSOaC4tuveWfsqaC+8t7b2lvbe095b23tLfGYl6qPikoSL4MEN7zkjF5APA7e0R7stW4bbbhXHLXRNYpNhZQ2HrdaPue4gb2/Dt1CoNjXVVKxdfGm4F+kG4cXqgbDztZU4i+m+r7v/bmusLZTRuwfJe8EzV+ZLnJHOb21VU47Bro7hJzGw0x9bc1akPs/sihH3BDu457/Hsov9++CGvTmRB2iiKUvgY9nlTbJa5L1xLvlC3WJCeobDH16AHJLcnBbJHDyw2Ukd/9hEWr7tv7iLwtSh/hX/x+QWPGowHb+kE2IqjpcBMoQVU8FgKUyJk1B9X02HvvtYzeNdsaOhbuOFN8ZYpUljeVHDiAXCn7tvvVX99r4W6h6dHtJn1At7KvJegnND5yOyOKDLIlzpfXstsHujJ4i3Yz8GC/b2Uyffu6f+sLrm9rUz2ePJJ40nvS7zDl3jNYmJ9Tg8m8MPVOK/2nVu0MxK26TcKn+9T5OVZmHvcbpkynMgVV00E+8p2yZru2Sy9ZUpD0pPu9ZP9X+7gADarYeiiL4V3jq4KZzyxs4ipTmmsDl+YFzqZcHHioquIzDBOWSoo6rThBgWtiMF25Xk4tmMLxicR35Sxh/UIkvuj6NQOoO4cNaaTj5etNiB14GkVTFuE7l00Gw7ezCw5EqVMu++KNFG6BCJnnZDEMKtSqaIumsEQebtyq2nCVbHGYQTuNNqz13rtU3bszT+mTOvV9L2flcgBX/2dIWNOn3f0kFaVd+iQDy7bZDDDXPb3BO2VtQg7VXYZ6RIqCoGeQIf2kbsEoiJhdF1f6Z5ZoQ9c6QfYfGft5LHjmBcLWH6Pkp3aG4uEaEsatdW6AKFNFbRZbu47Km+H08vrdyM4Lu6f15OLj+8vhtPp6GrYauvDdD3oT/qD0eW/rz9OLkfj0f8Nz9yTycVoMKx7vnXyzgh4xsMJRyt+a7mIUZrI7VJgARZig6A6LDCUoi9efgnXUTzT/CU/uHmn2r/nXppN2/LxNV+zaSVQ65bUtBho0bOIad56Tll613kDknYHOH9M/4SjBuMbGScmxAbLui3qePV/Sz2uradl8Pl2tVFde1fBpSz4moRoDc52eRCmcykvDQ/dGsRQHlGWyqWuk6DJEkF9aFt3y9a5glpgrax810NOy7k9HTCG7U0LupLDtPXS57QvBI8RwcHKFNFuIyvKaGbOiLJ+aY9U88uRJmtqf3EozgaGaaj2rd9aUEFuQX4VqQ5mLlYHg1m4LwF2LqQEeK0FBl7Iu3EzP9l30zv9Ec61itZqShNOLfteyLtmlrlKPwVGmAtcC3l3rCXpnu6hFJ6thHdsFHZ2O9gIWaNlzRSrEIndIAr76DqC5RKCGed+hFLPbrvlxd92V3nedYNDAcOIBzdHVzDMdPHVT2XQ8/3w4P5r3QKG7dsXvVy/NjBrTsMJEQFhCi8fZMR0d20iqKuFXroj2uCUjEG5aAdzzDS/hUxToyzBlZrT3Spg1Pp8xvW1YO4NEqKUKRoZvp8KoT1aoZXpmEo0Jzo6ckVQVlBRQ84CWaUY+lev/st6pi7kQBsODjkuLlUGI7do+G66BX/IQja5C4Z3VGpLdKUPNDpz3TTkZtUOCuwM9l1BiM/1/odrEx7dCuECLQtU9WPaZOksxIAt9R3IetRKpm9LxUtLFTdlu8AVSCCbKh7udf8GKwXMB6IKBI4BduZlUDMBtov6SUJYmKtNZz2igh4JJPzXNX3PzK6izCCFzNUN/EtQP1JEGFcNKs2LMdZ5M0xheYRRjKNFynTID7xYFvNrRAytJcknUJpg5QPjW9k1Zd0hXKlnkNtwMO0ZiNcLyZpEIDYbJQUJZEd3amX+7krFkdWXYOHcIZqfiYuU1XgQc4bemd4K+iXre3+vcsREbhcZYS6xwcpBhEnUzTqnUnPIqjQGbAA60qgh7/zhJYwLVYsL4D2fjyGrXVUZmgQ1O2TEY6yPo72Wx7JnSSVFy19YRra49Q8uI1v2XTAVaf/mUaqPBOR2KQB2orn7dDJHOBsYs29RON/lXkAfaEZ3/aqfuhA/n0IEZqXCtQ0OrDQsCqGNJXXtwNxQTN+Woh0hX0xuiE4McULGztwfj47WzuqfszwZhrl3YgwUkY6eWgfH9CSbMfokiaua3R+PjOvbnBjUp29loN5bnL3F+ZlYdrwJ2ZuQn6EJ+TuZcx8CeLEIVlQRE9daQL9binpgXVuOZg82/uzs+WhdWzk8wYSt6yvpESXdEqiZl8ReJ+hWEM3/vELv36LZMvlp5nRlNBdWLcwowauJ4LAV+6JJjieQakflhjPtI1dMKVqGYhxhKYEObHz/blew8a3HpyY/ZZmKqe3Qh9ZZZQKbtmZcfDAyGWE8Xa6qvnciZQWlfxPENtVvOqVHLiVGOCCawb6UlC3hkOoXXa6QR9LfT2v09kWtvLVlFFW5f6GwZSSkBwtbPvOZz3zWWCfsM595MPjImc9yTvSec2DtzmnA5PL4m/Mj5yS7fyw7O8O1M9/al2ZJTvR9V0hXXFDAgGVH4MipYO7jE2AuarAHtEZh2wMCwMwZldoW+P4o3+GKFUCjoZJXQXnAIEknxWDu5utnVmow+ZR9HOsCpdUozbRTY/NyrmXdIjL7Cux1R9rE6p2f7XdIBIct2ATVlEi37Zz5S8rVGSZxI0u2BdEAbkPdxvrZzdPlMnOwkKtRXDaG7gxYd8KEcT1xuNl0bbTX0HUldX/jzXAGjVEEFgr08lXnJ7PHleDpPCJyxblyNAc82TyAaGiuM7fDfeSCmieCrrEifRNE3PBQJKZRIfqYSASoCr1kHJE7cBrBERpNrMYlwnMSHQDujtYEm4EyfQz8o1K74IjMAl7L9xS1fD5J0RPWbbKFNJLJ/hl8eDdFJo0RUkaY0ZH9Kwz+1TJLf637bOhAAV3GeSq+bZ8Jj7afNNr2qtd62uSB6UWnWvW10a6a5eyiJMY0yjOTgE8pXB/mtnQqFJuByNkPFXeXSzF0WJCAx7HxTYGDnQgepiZtbOEUZpYdrXhq5njrtFTZYTK6smYdTLN3jTIVtHsWDFxNBsWrIPNpIDGwwwan1S2rRhY2z8sijaJN548UR8adTZAFEYQ5H7wvV+OC2tKOlO8PzX67Sw2vtYOMPUt64/Rcw45rKE/aekLgca6dgdyD015vBilfF/SuXTQV72UBUJfmR1iIhswqk4bvl/CfhG+Hx9LPH0vfp0t5JojTQzoP6Z4hpHsk7VtTc1Kpj0oJzW0V7Z+cNdjppT6hSRFs7R6jg6s+cxZoZulOFlRIZXq0veEoWeE50aXitE6pBhYPAdo2wC61iBgwAiRf2WVzP8xvsKSZrdPBvv6uboOmSJYOE9M6Rh245bL1AVvEOp6h4NMMt4zNCAPCuXW5zyDk1biLvnyap0yl6Pxy2hi2weiyx2UnJArTSL5IdR/XkZInyG6fJJ1HNDCUGmNcZt3sgnEYXC46tiBn0SUfoy9nhCTonGChJ3c1voeukJCkE9lXO+u4SOCLOZbk2sYYyhMEf9qV074Bg09n/coKUVkt6KkhGpD80UUkOreDDr8Fl8vARAPYebp0WHiNqS55ZjzxF6kyNW4jgiV5sH9MeQ8/TrDzw40s0NJt0Nz/xO21ihCau7fOkjA7QLPcu1T7epjQxNI5Mk4rZXeVZ+Lx4Gt7ewHliQgovra3r+3ta3v72t5NLMe+trev7e1re3v1z4+g/nkmyllf2/vBtb2rYt2TsC35+k+e6Xum/9hM/2A9cyalaW9lJzbnYtYbLWbdL4nrRwZnNwzvc7K6Bed5dN/V2Pm6aQeMRonWqFApziOTCpDfuX5krzfKOKNpK7ZyPVWuqiadQcGgDpaSLkGBu3UrVWk94DKsmgtq7zsXRVYuU+RiMT9zcaOrKDcZ4ZwvUZ/haKNoILUXjynAbEeIOaOKC+fOHPHlJRyKZrnVbJoblXFOkMRLAxpZCSs84FFkSksPWajzHjWQ0rDCKMgaImJbmlQILoq03PtFGjValmrfkMjOrUnEl0jwNPPxfoDauHwv3ZCaZJe775qi2DvGSXfIlNhcT/XDrvnf9bY0/TD18z43mNHbMTqfvvM16p60WtnXqFO+Rp2vUedr1FUPiq9R97jScsqoesfFOY2pqleFJ0SY4BT9Ts0Cmncusby5IDqoov4dLzg/acEZquEVMxtEqYg9yPIgy4MsD7I8yPIgy4MsXwj4x4A+v6ZzXd8CFFhPI7GT93T8sT0dTaj7/imWdrZJy5ZEmBH06eI8M+E4Ajc8FZ2bX2QHsAc4sltjjpTRgIgm8HN6jgI4FYvMWl22Xpuyr8wqwLW/O/xWpLIAgbRPEVgODppn1kpfdi6GuADfCheOdd+eFZnV9MDw58LQ1fjnmpDQjsUYUDzDlnfbugZLVAE/fVyS7BfIMmNbcAib157z7UVz53lgX06ESbqynYO/maPEzS/yhR24U+jL7jfj0TCIMI2bQeAJhFNIwPxX2gVfNzW4TrtUYAnH0WTKssnV6jdHG7mU21ChrmMbzazzqU5gjmYXBIefBVVkjNlm5qJ4Yoer7Qg6y0SzksnjPMuERe1JNiEXVBDoKe2YTXH39DKiDUsMrZ/dtqPghIcoMA9Ror3wLN8D9PYX+wdOMrpz/0DjlB1CPHhjQ2F9PYyEh1nF9h21el0cFQ/JVF/RXMxMwTQoLcWo2sygcwCnlCm57Z5sKUX/7o/PkVQiNYljpcJCSxia+80gb+hpKe/C48ywzpvW8YKEh3/F/DxmftKY2edSesLOk5XvbuFjDu12OQna2oe/TjOYcICC2EtXXrry0pWXrrx05aUrL1156cpLV1668tKVl65+dOnqyUo3PpzqR2BEDQKHDq+aqadsIGkz0KmrUX6elnQPeh57A76axGWBBXhHtGSRyvsTc77/dejVIl4t4tUiXi3i1SJeLeLVIl4t4tUiXi3ipRGvFvFqEa8W8WqRZ8WIHlEtArqNovLAZiLtQARPR6ciP0pdUuzSqUr2a0L2qlMepCr5xOgaIwjecDmWfYThU1Zf+AhD5SMMfYShjzD0EYY+wtDjxaYRhv1IYSrQ5O3U4x+Pfzz+8fjH4x+Pfzz+8fjnx8A/Y47nHvl45OORj0c+Hvl45OORj0c+zxz5VD6Pa3LOoapwxvC3QJGHOh7qHDXH+9lG5UTAr3A9kJqzK+/z5+p6FvT3Z0HfG/ceeCVODroSu7XOOceU+KnUyXGlvu3pbFr/p3Ios3rh165wua0Q1MjbYgelthzQ+g1a2xI1IRSlpPNUu6rlVYIs7QeUD9pPviswZD098o2lP09e8DLEigxMfY+6b55BU3ivA8DSiEhSfUrCIxrJQ1rYKqH1/i1SYZXWYtryPss9jgcXw/7l6MP7VrvVv+qPzvtvz4etdutseD60Pw8vLj5eDM9a7dbow1X/fHTW2l66IVt3p2ZswPZESrysq7kCjJPGWGzqyQ8E0aV6cCTrysw0qzb0rd3iYll6Ui9V/OPnlnWG2673c1+LCM9J9IBCNbTpQPXXyj0lbfKSU/XrS6WVEnY+3jAc02DX4xFTRCQ8wjs34BEnpyClnMPKns3PFIcTWrfLLohMOJPEvJK/caZ5zZxsv6lxarv186tXrZrq0iGCm4dI+EqW78Nr4D9qNQu936VxdJPBisQY/lW8rNxe/21fDNvuQ1GYxlAILrYo/2mb8o8JsbcV4zZwgoS6K0mCVFC10drFtwQLIvopREl8+Q14XkzUioet09aSaBp1AEWrHD3yNchWcRR+a7lwKKm7TEXUOm05FowT2tXsNufD2xhTP0ETy55tuaT+ZNQCghy9U1hes1RFqrPVghGBFP0abDr9Uqtt//HO7azfb5VeB8oWXDd3Sf8NFTDsPgKtI7+0L+ubM9D7ojz54pRJjGmkD++C/7/8ARxWiDXR47zuvn71pvvKwfQYsxw8Zju4DopWKf6a79XWBVGCkjUxhbZDojCNMrVVbaVpzTsXNC89vqRrwtCs+NVnhZLnitwpuFypPuF6Cb7ajfOlVdw4rXbrtNgJHApQwMF7X7/OsSSfRPTtG/z8R0qE2aIhlRZCaL3FPTPNKrOB0ocIGuRTETvJ1VXBSkw+Y58trQJpPn4BOWJlIYuB3tJIgkGUhsSJjMKeYqhmqFLBJJqZi+MUQcnWGaILxE2o2h7is8Fkifbf4A8LhA9byJe2vmJ4guqEaRwlK3zAErtbkG2K9DnqSxsCFAZaRoHgyi+2ZlurHwQkUYXGW+y3xLneDy9buuR7kT1U2EHRtlIm7OtX88YlVCT/9i2jU1coBwK/ffv/7NoBWw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the compute environment identified by the given `comput id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-credentials.ParamsDetails.json b/platform-api-docs/docs/describe-credentials.ParamsDetails.json new file mode 100644 index 000000000..e6940e2f5 --- /dev/null +++ b/platform-api-docs/docs/describe-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"credentialsId","in":"path","description":"Credentials string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-credentials.RequestSchema.json b/platform-api-docs/docs/describe-credentials.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-credentials.StatusCodes.json b/platform-api-docs/docs/describe-credentials.StatusCodes.json new file mode 100644 index 000000000..6ee23a346 --- /dev/null +++ b/platform-api-docs/docs/describe-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"required":["name","provider"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"name":{"maxLength":100,"type":"string"},"description":{"type":"string"},"provider":{"maxLength":16,"type":"string","enum":["aws","azure","azure_entra","google","github","gitlab","bitbucket","ssh","k8s","container-reg","tw-agent","codecommit","gitea","azurerepos","seqeracompute","azure-cloud","s3"]},"baseUrl":{"maxLength":200,"pattern":"","type":"string"},"category":{"maxLength":20,"type":"string"},"deleted":{"type":"boolean","readOnly":true},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"keys":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"s3":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"},"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},"azurerepos":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},"azure_entra":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},"container-reg":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},"tw-agent":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},"k8s":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},"ssh":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},"google":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},"bitbucket":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},"gitea":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},"seqeracompute":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},"codecommit":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},"gitlab":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},"aws":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},"azure":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"}],"title":"SecurityKeys"}},"title":"Credentials"}},"title":"DescribeCredentialsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-credentials.api.mdx b/platform-api-docs/docs/describe-credentials.api.mdx index cf62f30b5..2387933b6 100644 --- a/platform-api-docs/docs/describe-credentials.api.mdx +++ b/platform-api-docs/docs/describe-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the credentials identified by the given ` sidebar_label: "Describe credentials" hide_title: true hide_table_of_contents: true -api: eJztWt1v2kgQ/1esfbqTSEiTXtXj6QjNpVGqpoJW9xBF18UezAbjdXfXUIr4329mbYO/CEQJp5DkJQHv7MxvPnfWzJwZ7mvWumauAg9CI3ig2U2DeaBdJSIjZMharAtGCZiAdswQHA8MF4F25MB+ze10hP00EOA5/Zld9cUEQud7jujC+37IGkxGoDjxv/BQwgcrrw+dHIwGi7jiYzCgCOKchfgFaQu8kEoQxIibISvjznFzNKoQ+iuECqkV/IgF0rCWUTE0mHaHMOasNWdmFpGoZBNbLBpL6VOpRjriLqxk/4hBzSrC/8kInTAegxJuUXZFlggN+HZpINWYm+TRu7co/Yag6kiGGjTtOD46on9FeVeXuNWVyCU0tMqjKBCuNXHzVhPJvCpU9m/BNWRqRQ4xIhGQjwb8urLTdWIGSz9BfRQFy928hEd/x/znJwh9dFLr+LhRtm8jtW6B7s3RUQ1hQemKo3LASszelXk1GKBjSCU+pWDjv2IF2f9/UXvF8ZsvpR/QY1+YYdxPPgScPvSF6cfuCEhlrSn6Ru916gMuQlAHCkiMmR5wn5xCSx64cjwWJmEEPBOoIJK0WcMPzAukiWKzRHPgBjKmcNMn7AZ17HMN31RQtivZC/MA84XigdUYD8MBfInBWt5Za+gAU8/LGbkvZQA8tInDvaswmCWJg8QB1+abLlAvzbwMZw+lHxhh46fCgRYxX7l5CBMLI/IexmQEM705RTxBcTgWITdS1Qkr8SUVy1tSjrPPSWkprjfQQ1FEvChxTx4fEQaX64LWlzCrzSQNWAZM7WqDTRVGb4EZVeCemQXQtlzPQt4PasOHTGEwiehZ76QHboy8Zpdk9cUyz3agbawxMdIyUy0bXGss7bVhU9Y1h/9cmI9xv6xDLqP3RI82Ie4S4lpd0nJYowwPgquBPZ0fW80+N+7w8zo9NbLBqrp23e7eOnZTblvSl+1WMtn8warjEc5Dc1HjRKrhgYANiz2buVupQr1FQZkz8nTm/OJRtqNYXuvD+8Qy8fYFLtfVspzDOplG3ZQ8U3V5Su9ASzRjiJzSZrdGU2oqP4gaZhSbQ6421tG2n7i9kLrUjuxCG9o8oNZyjduUmODa1sln5Ahqerk78+7yfaVQUQu2A23vqw0FbTRU2KHdU6Ve72PlLEyazx1ohQ1QzT3n7qPOgilDXDXBO0C5dWTs5lA8FebU6lbTo8AWt6incbSfE9hKshSuGf/ruf6oTSeaBC/XXSyIbVV3H8yXyGm5ZDz0oC4cnj1r0U5i0bK5c/e+PYmaDiLuWMQ1wU/33+eX7pgon3i1l5/u5BB9OlmQvvjYgY772sHTsgzhBdS/p9pW7EeNrL38v4yy+Oy0XNfr7U0kVnq8Z3UVeim32NdDeM8yb+2L02f8ruy5vCDbjwhbexN7fRn/ol7Gv76j2ek7miduxEf5dbVgisKNN1ducqMf+ec1EzrddCaFbsxI+bZuKuWUew6Nj4BO5h+2HE/JT5yMUV+sB5snTTLCO0PsTCmpKshPqsivsgElJ5TGwVyTU8SzSFxnbWdT7xTw9FHtmOYorm/IxGMwQ0lDTb4dDbGTSS3WzM3UNOeFGaYFI55qks05xTTawYbGRLrVbPJIHNr5j8Pkpe2hkKw8a5QEtvMl4IZmHJwO0TvtLxfW5xneHpk3MVUe9dJaJJGlk0k2pCwRPkk+/J1NT9xOjbWDCAfSbi+klxW7CSCpKzCQU2L7O6Nr46KofF5lDA1BayT2r9UCAiHLJXLeHP75x+GRPW2lNmNuwyqd3MoiOD+xVgY6X4XoTqbeUksb+GmaUYDNFUGNk1GeJFCKo3gN1iqOu6E7h6gZ0c3n6RzQYkGPkyk0ih8sVWl1GOAmuEPFDTNqtWhHVLJKY3ATHsREacNtwpUg+ffE8ls3zfnfnU1ze7W40oc8nOUBZXiLVlzQFNUQCzbNiSHKhIZKa2Ryuys1qpDe52df6RAu5lApZ/KncxEZes9SfKV742KxBJrcIxHgYvEffE6opA== +api: eJztWm1P20gQ/ivWfrqTzEuhqk75dJByFFGVirS6DwhdJ/bE2WJ73d1x0pzl/36atR38FgKCnAj0Cwne2ZlnZmdmd50nEwSBEYMr4Wn0MSYJoRHXrvDReFomJFUsBuISSUucoXFoio6PBDI0jprYf2szHWm/TST6znhhRwM5w9j5VhM687/tCleoBDWw/jNfDMR7a2+MwxoMVySgIUJCzRAzEUOEYiAauoQrJENMgKaijbumzTGkZRzcItTCFRp/pFKjLwakU3SF8aYYgRhkghYJmyomiTx3l9bnSt+YBDy8tf0jRb3oGP+7EnTiNEItvabtji0ZEwZ2aKJ0BFQ8evdW5Pk1QzWJig0annGwv88fTXsX58IVnooJY+JRSJJQejbEe98Ni2Rdo2r8HT3iUGteEJKFgXo2DLJanK6KMFj5mfRRc7LcrUv6/DeCnx8xDmgqBgcHbju+bhndhtyb/f0ewYbTnYWqAWspe9fW5QqM04hdgjknG/ybaqw+/8GYNAhXBEoFIT8OJE3TcfElBP4yljROvRtkl43h7Lv5w5RrADJGvaORzdB8BwJeFB7y0VNRJKlQhFAZ1JgonmzwB2rwVJSktESz44Uq5XQzh+I6d8UYDH7VYTuuHK8EiFBzPoie4HlAGCi96MzsDXSIhH4tyGOlQoTYFg74F3G4KAond0UIhr6ahvQyzMt09oFwh6TNn44GHhxqBHqMEgsj8R+n5AYXZn2J+JLzMJIxkNJ9xlp62cX2lFLj4lPRWprjroggSVgXF+7h0yNyBXgeGnOOi95KMuhppN5RV8y1JGwo4w48okWIR1brSQzjsDd9OBQkKeRno8MReqmWtDjnqOfLOtuAt6lBXbWZbtsAY+ZK96ZN29ca/lNJH9Jx24daRW+JH0eM+JIR9/pStsMeZyAMLyZ2d35qN8dA3vTTKj8NKQ0Brhy3s++du6W2e8q349YKWfZo1wljiOmsZxG5h4cS1wyObOXeyxU+WzScOeGVrha/uZVtKJdXruFDcpl1B9KQ7utltQUbVh5dluKVq8tdegNeeiqO0asOuz2e8qHyvexRxrk5Bb22jx4FxbI3SpePI5vwhidP+Gi5Ytm0nAHdt5hcQeoGe85yd9bd+R+dRsVHsA14+1BvOGmTqQbTE5w7XRqNPnT2wuLwuQGvfKCee87dW50F04Z4ewjeAMp7Z8ZmNsVjScfWt54zCt7jFvU8tvZTBtsplsY143/d15/00AnGpBFeqhCPdN99sN4i5+2W8diNurF5jmxEh0VE2+Gu3fu2JGuGysehRdyT/Hz/fXnlfirpI3TP8vONbKLPpwrKFx8b8HFbT/A8rGJ8Bf3vuR4rtqNH9l7+X0dbfHFerjrrbU0mds54L+oq9Fpusb824S2rvJUvTl/wu7KX8oJsOzJs5U3s18v4V/Uy/tc7mo2+o3nmQXySX1cboWjceGvtpkb9qD/vYehclpwUvjHnrnjbx0o5Bt9h+ggaegg9pc44idAYCHA906QSvDPFTrRWuoP8sIv8oiIoObEiB8JQzdG3qkwZO1t6xwga9VHKPIqraw5xhDRVTGoKLDXEMpMGYq/GqdnLGhym3PI+9KziOaVM7RBTosQM9vYgkbuW/7FbvLTdlarDNSoS2/kcAjHHwRmyvHP0+cyueYV3xOEtQlVHvYwWW6yYSTalrBAzXeyXvyr2xPc52TjIeKLs9EZ5WbPrALK70kNTCtvfGT2bF03n6y5jBDK0rKiJ+vN2IHcFR66w82b3zf7B7r7dbpWhCGxeldStKoXrlLU20uw2RzdCeytDTfiT9pIQZMxQ04LLU2RKk4vnikGT73btiqkyxHJZVhKB8pwfFzQ0TiBfmrI9TCA0eIeLa0hqvWhvuGe1eHAzCFOWtPk2Ay3Z/gOx/HZZFv3vzjriXi+u8iHEizqgCm8zijnTqKYIlih2lZUy3FsTqs3uNKlGfZ+efOFduFlEraKpb89NZFlWSHzhi2OeL4EWF8n8Os/z/wCVCKjJ sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the credentials identified by the given `credentialsId` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-data-link.ParamsDetails.json b/platform-api-docs/docs/describe-data-link.ParamsDetails.json new file mode 100644 index 000000000..0550ef31a --- /dev/null +++ b/platform-api-docs/docs/describe-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier. Required for accessing private data-links.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/describe-data-link.RequestSchema.json b/platform-api-docs/docs/describe-data-link.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-data-link.StatusCodes.json b/platform-api-docs/docs/describe-data-link.StatusCodes.json new file mode 100644 index 000000000..b7d0a865e --- /dev/null +++ b/platform-api-docs/docs/describe-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataLink":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto","description":"Data-link object containing metadata."}},"title":"DataLinkResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/describe-data-link.api.mdx b/platform-api-docs/docs/describe-data-link.api.mdx index 7ccda3df8..416f999b1 100644 --- a/platform-api-docs/docs/describe-data-link.api.mdx +++ b/platform-api-docs/docs/describe-data-link.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the data-link associated with the given ` sidebar_label: "Describe data-link" hide_title: true hide_table_of_contents: true -api: eJzNWFFv2zYQ/iuEnlpAVtqlGzA/LU3awliXBEnaPQTBTEtnmwktqiRl1zME7EfsF+6X7I6ULMpy43QosL4kpnjifXf33fFOm8jymYmGt1HGLR9IkT+Y6C6OMjCpFoUVKo+G0RVYLWAJhtk5sAwsF9IwNfXL5kXGjVGp4BYythJ27nZnYgk5G5PQe5QZZeOYiTyVZSbyGSu0WooMND6aKr3gpC9mqYYMciu4NDHjecZ4moIxzFhuS5NEcaQK0E54lCG8Mwd2Ame1EhQouOYLsKDJtk2U4wIFWxQoIsiygtt5tGvu2dYig3YjTOHgTAVoUq7hUykQYjS0uoQ4MukcFjwabiK7LkiNfyuqqnireaX0gyl4Cq3qTyXodU/3740gy8sFaJGGytmFE+OSYPTUitzCDDRueV/6Rz+96gAJfHsIymkruscR7Kp2A0NtdYR8SMUSKdDSwuwFu/XRHTnUFCo3YGj/hxcv6F8XysWveEaq0MDc0i4vCilSx4Cje0Mim74KNbmH1BIZNPHFCq+gIcFhSZH1AX8NV9g7yImn6KMJN/hX5VvGx4zOjZmGmeM80Rz9oEqNoSdWJlEV10E7hOEcpfrZ+AySWRKzSZk+gGV00nN3Zufdg+a1q56GhJ2XUrrwt8FmvLRqkAmTqiU4dmi1YFv6h7nt0DQ2X8H0MJqr0EFOcQdQWFlo48PViDlWQOOMsTkeHh0t1gPvFaxF45nZfcL/xCdIaFXmNiHScYFhHHvveYC7/GxZQPsJOy21RivlmpmyKJS2ho1rBZQNu1YC5jrVYC9C9ffzgJ4NllxT4Ex30worodZKTL6h4yrHXsetPr5TqcqsrbY9zyXseouTr4zzi1IzCd4fpW5//IF2ab5dDlI6mpYGPiHZU7UoSkvixGj096MGoy5ceVX4w53Y/PeKmpXXQ5UkVEPr430uuWxc4Sg2exLXvZO89BfTaVyaAXBjBy/JZiipYAxWYOxLJAj7ja/ZhEp3nRdGIfcat3vCBwkQQOJac6rAwsLCPW8vmVuqQ3UpCGJ8F3+D6vV4if9vFWg3wx9hZaA97TD0f+ZM1d8MsPaKaHRC0SP7A9vRF9yylOdN92LnwoQZ92ZR2LVjSVFO8Dbr3JjkN/f0xF+sExlGYaKUBJ73m4c5YAR2cpuhWn8WliO+Pc61aKq0vXjNRYbrJ2j7KPAgIQVa4TszNpV8lrDRlI2pM8IE6YDwB/sLIYMpL6VlUhjLlgJWXrc/Zx/fNPDsIpfrpuniUl5MXW93SLLhzceT96Mz3B+d+197GJBce/1VrwP2G3uuwFMMMGb82J05ZhjNca1gjEUVL16r2idsNUcHBG1yyBeuqbWW2LRmzhdY9g2fPSH53miNamtxRyiRL7kUWcio9q7ube3l+5lVj/Q6vuSw+nKksoHNNqcz9592VXd4uEnbr/b1eK95Ri0lltKv6fXCOtl47GBp/KJrQ+zOrT3gx3ua02YYYbmyDImpVojHSb/qS58r+xY7i4z989ffQV+EgQnJQCdNSSxmJ5cjhv0Ux5zNtjf39sWYhe1X+9736kNKckhLjVXDZe9rQN7rkxLHsOHtHSUeMmmuaKybgdNKE9owOmoJe7Rp57jKVXe9bAa9UksUnltbUFvHC5G4OyDxN0Ai+qS+djvsUnJLYxPzXQA63VWBBuu1ayOd4SHire2ksRlzXM10QvjE/3jbDGT3K+scRPOue712VI2C1B4CSOYKrOK1sMvB1EW5a3xoMgZaSDcPTtUv7QYCIc95PS+Tn39MXribRxm74I4k9dTYTNgt03Zhblq6fX+fC+ogWfhsjwqJFYusdN7a1PzqfP+Io2HwpQBZMEeHkMxmQ3PcBy2rih77sZlo1+RnNJwiCnjEN0+f7/eCfoB172sCFvSSJCMa85+O5FuO949g3f3g0KK9o4UW3PU2X+XEZw245+zAt5q9wJqeO1+HeBrAQeirO+qHsJ+g7hURegFqyQobvNqrrp0y9u7NDTWk3XqxUx/CRqYLCynnJG7UA+RVtUVpaU0Aq+pflaDhyA== +api: eJzNWFFv2zYQ/isEn1pAlpOm2IOfliZtYaxLgqTtHgJjoqWzzYYiVfJk1zUE7EfsF+6XDEdKlmy5cToUWJ9skkfed8fvjnfacBRzx0f3PBMoBkrqB8cnEc/ApVYWKI3mI34LaCUswTFcAMsAhVSOmVkYNhuZcM6kUiBkbCVx4VfncgmaJST0TuqHcZZETOpUlZnUc1ZYs5QZWCb1zNhckL6IpRYy0CiFchETOmMiTcE55lBg6WIecVOA9cLjjI/4pQc7hctaCY94IazIAcGSbRuuRQ58xFsUPOKSLCsELvi+uZdbixxagik9nJkES8otfC6lhYyP0JYQcZcuIBd8tOG4LkhN2MWrKtpqXhn74AqRQqv6cwl23dP9RyPIdJmDlWlXObv2YkIRjJ5aqRHmYHnEgy/D1C8vd4B0fHsMykUresAR7LZ2A5sZW99QuFK5FNihhTsIduujCTnUFUY7cLT+4uSEfnahXP/GI54ajaCRVkVRKJl6Bgw/ORLZ9FWY6SdIkchgiS8og4KGBMclZdYH/D1cYW9BE08hY1PhIGNGbxkfMTo3YhbmnvNEcwvOlDYFRqyMeRXVl3YMw5XIoR+NzyCexxGblukDIKOTnvszd/YeNa8d9TTE7KpUyl9/e9lMlGgGmXSpWYJnhzU529K/G9seTWPzLcyOo7ntOsgr3gHUzSy08OF2zDwroHFG4s5Gw2G+HgSvJBFL5m5/RnwdDYciTU2pMSbSCanBJsF7AeA+P1sW0HrMLkprQaNaM1cWhbHoWFIroGjYtxJ0mVMODiKUf78MaG6wFJYuzu0uokQFtVZi8ns6rvLs9dzq47tQpszabNvzXMzutjjFynm/GDNXEPxR2vbPn6DRiu1wkNLRNHTwGaxITV6USOLE6MSdPWqwWDke8aCKR9yf2PwGRc0o6KFM0lVD47NDLrlpXOEpNn8S14OTgvQ3wykp3QCEw8Ep2QwlJYzBChyeJs9j9rtYsyml7jounMlh6/ZA+E4AdCAJawVlYImQ+/n2kbmnPFSngs4dT6IfkL0eT/H/LQPtR/gjrOxoT3cY+j9zpuovdrD2kig/p9sj+zu2M1wIZKnQTfWCC+m6Efc6L3DtWVKUUyXTnReT/OZnz8PDOlXdW5gao0DofvGwAFzAXmwz6WoNat2801MFvkQzJfbuayGzDPQTtH2UTk6lkriuKzM2U2Ies/GMJVQZJdEuiHBweBAymIlSIVPSIVtKWAXd4ZxDfLMgsmut1k3RJZS6nvna7phkw5uP5+/Glzzi46vw7wAD4rugv+pVwGHhwBN4ITRFfOLPTJixLKkVJDG7A2Ro2hm2WoDulsldvghLpbUChMz7IgfnxPwJwffaWmNZLe4JJfVSKJl1GdW+1b2lg3y/RPNIrRNSDqsfR0obOaCgMw+fdltXeLyqaPnloRrvlciopASH31PrdfNk47GjqfGbru1i927tAT87UJw2zQjTBplQyqwg4176ZV/6yuAbU+qM/fPX3526yNgdMtBJMxKL2PnNmGXSiamqa21i4HZjxLrlV7vvZ/UhBTmkpZW49tH7CoQFe17igo/uJxR4OeDCUFs3B6+VOrQRH7aEHW7aPq7y2d0um0avtIqP+AKxoLJOFDL2b0AcXoBY9kl951fYjRJIbRMLVcD5zdhngQbrnS8jveFdxFvbSWPT5vic6YV4VP950zRkn1boHUT9rt9eO6pGQWqPASRzZQquFvYxmPpb3jW+azLkQirfD87Mr+1CFXHyXNBzGp+evIhP/NNjHObCs6RuG5sWu6XaPs5Ny7ef73tBfUsIX3BYKCE1WendtakJtvMBJOKjzqeCScQXxiHJbDbUyH2wqqpoOvTNxLsmQPloJpSDR3zz9Ab/IOgHWPc+JyyFKkmSU5//dCQ/sr9/BOv+F4cW7YQGVgpf3HyXE5814J6zIx9rDgJrim697uJpAHeuvppQQQTCl6/3m1qAarICO1t76XUnj719/Z4q0t2EsZcgupXMLqzNJki8Nw+gq2qLEmlMAKvqX7c84e0= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the data-link associated with the given `dataLinkId`, i id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-data-studio.ParamsDetails.json b/platform-api-docs/docs/describe-data-studio.ParamsDetails.json new file mode 100644 index 000000000..25c0202eb --- /dev/null +++ b/platform-api-docs/docs/describe-data-studio.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the Studio is described in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-data-studio.RequestSchema.json b/platform-api-docs/docs/describe-data-studio.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-data-studio.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-data-studio.StatusCodes.json b/platform-api-docs/docs/describe-data-studio.StatusCodes.json new file mode 100644 index 000000000..f1a26cd55 --- /dev/null +++ b/platform-api-docs/docs/describe-data-studio.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Studio session string identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier. Null if the Studio belongs to the user context."},"parentCheckpoint":{"description":"Information about the parent checkpoint if this Studio was created from an existing checkpoint.","type":"object","properties":{"checkpointId":{"type":"integer","format":"int64"},"checkpointName":{"type":"string"},"sessionId":{"type":"string"},"studioName":{"type":"string"}},"title":"DataStudioDto.ParentCheckpoint"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo","description":"Studio creator user information."},"name":{"type":"string","description":"Studio name."},"description":{"type":"string","description":"Studio description."},"studioUrl":{"type":"string","description":"URL to access the running Studio session."},"computeEnv":{"description":"Compute environment information where the Studio runs.","type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"},{"properties":{"credentialsId":{"type":"string"},"workDir":{"type":"string"}}}],"title":"DataStudioComputeEnvDto"},"template":{"description":"Container image template information for the Studio environment.","type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"configuration":{"description":"Studio resource allocation and environment configuration.","type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was last updated."},"lastStarted":{"type":"string","format":"date-time","description":"Timestamp when the Studio session was last started."},"effectiveLifespanHours":{"type":"integer","format":"int32","description":"Total accumulated lifespan hours for the Studio session, including any extensions."},"activeConnections":{"type":"array","items":{"required":["lastActive"],"type":"object","allOf":[{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},{"properties":{"lastActive":{"type":"string","format":"date-time"}}}],"title":"ActiveConnection"},"description":"Array of currently active user connections to the Studio session."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"},"waveBuildUrl":{"type":"string"},"baseImage":{"type":"string"},"customImage":{"type":"boolean"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session."},"mountedDataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}},"progress":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","in-progress","succeeded","errored"],"title":"DataStudioProgressStep.Status"},"message":{"type":"string","description":"Human-readable message describing the current progress step."},"warnings":{"type":"array","items":{"type":"string"}}},"title":"DataStudioProgressStep"},"description":"Studio session startup progress information, including build status and checkpoint mounting progress."},"labels":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"},"description":"Array of resource labels applied to the Studio."}},"title":"DataStudioDto"}}}},"202":{"description":"Accepted, when the Studio is fetching mounted data links in the background.","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Studio session string identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier. Null if the Studio belongs to the user context."},"parentCheckpoint":{"description":"Information about the parent checkpoint if this Studio was created from an existing checkpoint.","type":"object","properties":{"checkpointId":{"type":"integer","format":"int64"},"checkpointName":{"type":"string"},"sessionId":{"type":"string"},"studioName":{"type":"string"}},"title":"DataStudioDto.ParentCheckpoint"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo","description":"Studio creator user information."},"name":{"type":"string","description":"Studio name."},"description":{"type":"string","description":"Studio description."},"studioUrl":{"type":"string","description":"URL to access the running Studio session."},"computeEnv":{"description":"Compute environment information where the Studio runs.","type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"},{"properties":{"credentialsId":{"type":"string"},"workDir":{"type":"string"}}}],"title":"DataStudioComputeEnvDto"},"template":{"description":"Container image template information for the Studio environment.","type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"configuration":{"description":"Studio resource allocation and environment configuration.","type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was last updated."},"lastStarted":{"type":"string","format":"date-time","description":"Timestamp when the Studio session was last started."},"effectiveLifespanHours":{"type":"integer","format":"int32","description":"Total accumulated lifespan hours for the Studio session, including any extensions."},"activeConnections":{"type":"array","items":{"required":["lastActive"],"type":"object","allOf":[{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},{"properties":{"lastActive":{"type":"string","format":"date-time"}}}],"title":"ActiveConnection"},"description":"Array of currently active user connections to the Studio session."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"},"waveBuildUrl":{"type":"string"},"baseImage":{"type":"string"},"customImage":{"type":"boolean"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session."},"mountedDataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}},"progress":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","in-progress","succeeded","errored"],"title":"DataStudioProgressStep.Status"},"message":{"type":"string","description":"Human-readable message describing the current progress step."},"warnings":{"type":"array","items":{"type":"string"}}},"title":"DataStudioProgressStep"},"description":"Studio session startup progress information, including build status and checkpoint mounting progress."},"labels":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"},"description":"Array of resource labels applied to the Studio."}},"title":"DataStudioDto"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the Studio is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/describe-data-studio.api.mdx b/platform-api-docs/docs/describe-data-studio.api.mdx index 6fab25584..4c71a7266 100644 --- a/platform-api-docs/docs/describe-data-studio.api.mdx +++ b/platform-api-docs/docs/describe-data-studio.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the Studio associated with the given Stud sidebar_label: "Describe Studio" hide_title: true hide_table_of_contents: true -api: eJztHGlv2zj2rxD6MlPAdtJjF7sBFrtuknaMSRPDSdoFiqKmJdpmo6sk5dQb+L/ve6Qo0Tp8bFvMYqBPlsXjHXw3H/TkKbqQ3tlHT6os4In0PvW8gElf8FTxJPbOvAlTgrMVk0QtGQmYojyUJJnrv7d6FaFSJj6nigXkkaulHlrwFYvtBMmkhO3I6GJAhmnK4oBM//mYiAeZUp+Ngn9MiUqIATxjhNp1PIbnYh7xk1ixb2rg9bwkZYIiiqMAkLzIV15QRc1SmJJSQSOmmEACn7wY/sDUHBVY1vM4EphStfSqVFfwlsCDeEF4wGLF55wJREGwrxkXDOArkbGeJ/0li6h39uSpdapB6VXeZtMroDs0W/hfMybWNQQ+FETHWcQE913g5MMSeJtEXAHLe+5JcFlwMUDu4VAmmXBZV8OTw9CCCRiaJyKiyrz66yvA/BOSKdMkBk7gihenp/izjevN77BUA4gVjtI0DbmvT+fki8QpT3WgyewL8xUek8CzVNwAKI+nxsfjz2jT22L4ARQfdwzXWRgSvqUKMxYm8UKiONd5v9FCCevPl8x/SBNu+LUNchQbnJAmOksypTcy64hfLDRw4bxzwI9UEl8wrYRzkUSExoR941IhU8plKAC7T6CcexjLgKhyybUW85oG9HadK45qGloWw7jiKsRXpX5fqGQwrvISZiLDcY9SOT96dAXLEHOQQB6i3qHy4UwN8dM+jvBD+VBs2USjAd40kuO3k/J72Bolo00L9NEnwggcL0VIC13ciFPLTjhZr9oaPXCx83JQHuy9aCC8usP95Aq1hvo+iIqWeZHFMUrvtqLrff0kSjPFLuNVXYHOzRhh8YqLJI5QbxyOkMclE8zVWYAjm/SChuHNXPuOI+SjPNZmrqMNCKlCdBoHBVs0MtwVhvOC+osZKIKHDqaixCD6aKdoKFtUDg3jBW+UOrT6dY1zgGqQnmIRUsKaTiCGMCFGSYzoAnidz9w6BnhyD8E5rf02SrA0kRzkfb1frqrIlGsJipxFw+KoxYv7h8h8LrHuaoIrDaBc/qnKZNNWDBwKGifBQJaB6oAFGkAKL9CI45RvQDJHjlC0WiClWZomAgfhhL71cYv+igoUNPlde9VP+z2ETUDlrcEfTztJDlDiO5ilLQhBtsJUAge3Ap8ZkNna+KuCVb+ywWLQI798ydI1RGm/wKMw9gIfV9JPAvbLs0GLA7iz0qetQTzni8wEhHVxtGrOZJIJcOWg14mfO1iIRF07sbXTfjlcpBn+RDzmER7naW+3m3j5osax6yyagWxCQP12fC8tbsCvXLKajN+PhHp+KNSIRbm+fQ/gYZRkwGcAbPbDIPUdf30YBrgUJcCRQyoExeiZg1g16FnVjXlDnI/gA9inH/L4AZISSfTWZcjcANyRkqYolgYBRxA0HG9JSN0rQMxIZyjMJmtoQc8VSlBxjkvIA1uDvocZhoNcSMBP7cAYZDmgl9toR/TbFYsXkPGcvTh99bfeftsZUADmP6DllCnzIfL1S/vtZ1JBqJlPkIAMGLwwrDFyy7gDaiGfQ1ZB499AIeWPk+UlbtfADshKIVAHNw/hOWwGFiADtIEMH5BdQ+aQpCmQD7kpMeyFvaanUyAiQGqBsCwOOaRbQJhFvc0unW/ZIpQ/2ODcBOZN9rMgDuf1FZjoulGFl8DXKMXQZYuvTtBv+Eqluk+DnwYL9yeZAVAABB8hfgbA4vAsYGkAGXWcz0Hx+IpdVUXpWPG5S0BkMezMoiyk7hHn8lQJVHK0eiAdfghvIECl8RpyLUh/cUBq/KhGDoQhRjTh7S6b5SYrSOlQL25KTMqQ9E+b4NSDWYclh8nYdgg7rBzFDqfgZwJTSrAJ5vyK/N2e4g7vZEI9TcL+KkcRFlbsrYFf1QAzfUDGCfxHR6CtlDwjU226WDDt4SNoB7AEn/PMybw2xg2f53BAZvIs42GQv9XPb8yQE/LUIlULAEtfZn8sJuXb20cTbAqRCP1k4dhHA6YlfP2xAOqmuQxmAaAEh9UorKUNPVTaDGYTRmVz1mAZeD65vBjd3X6e3F9/vrm/g5Gr0ZvL2/Hw+vPlv8cjGIVXt+Obu8+Ty/Or4bvh3ejmuo2UAmCzG7otpRGTPbpir5E9jZk4TJhRyUZRG0uMm6+OzyDWZ1SrE5djwVfbLLPDVWUbzYmOfEgSh2tXmWwJwwfLm6ucVbdaFMgCJPUKwredhvX4vL2K7UURJtbri+Qti7EKjckN8C8Aimy6I3o6++kRk873dKJRJCBYcj6iMHOt8ylTZizD1jx9mmX+A4SBuNOz48s2F+W/GoS8vonur3gndejUDzhkZysmbK3RKdGXhYeBKWcYmidsvh+bicugwu8WwF2XiwP3kxHRdeUil5zKl2cnJ9G6b7iC1m0hq2/of+AN+HuUo4FvqwNTwz2DYNUul1KA4wNyXviJPI2WaEY1gF0W1ExpsX7loKvNKOJ3uN1GS6+WrQa/ESZZUMhenXMDclvgSR+l5kuSLEJm+JGJ8uEz0CVo8bfv49bakbCvIOx54W1qJBr4vZNggAX/DCiMXnBH+2sA2X8GDhp5Fwz+f9nEkrFlxY6KWS2Z0Uwys1vVaZrJPthV1X+ONLMMDUb/ESLU5yAg5B2ECTO8C8j1QiZRUeEQRuAdBTg05NPRmjYFzhkfF7S1kVwi03I/crwFqmr4Dql0oPtbEvoHy8ymPujguis+dChSS6q0ryoq1nj5VmrcZZSqtZaSNJuF3HeMqOGbfjvUi7kuCOx1nR+WDE6gott452f20mGr3U7fxOLtUfW8ljyA/wdAe89hIx5ytc4DUDIPKSTJ4MCn6MFBQbaQMBsbhxCwOc1CBakU5G0rzh7lnnIo+P7gBgICWxap1d5bZ1q5eT+8GmEANbo2Tw0SMLARYO2W2ww0uMBzikUDMtV7TrGqOc0BTMGoMh2hFG9MCuvchrvyQgVen4fMZrCtMWgVt0sMdkk+XQsUjyEB4IErUaWvrg01yruu4RvtXYCP/o4oan+JG+/7zRse9wuAIA0ZSCsLtiL6xmh3nK+5VSwdHBDFVzn4WxbRuI+Co8tolpX5TbkNJ/Lkj1gMQeoBnAmfBWYjhzCpvETZR0jdzNSzPqGytMTHuT1xQyGd91gVRa/sXBLrYBkn2U3yqs2MNbqnanHyfwmkd9UPWq/EdELbch9mYsK2xOPCWJrW4TXA5H7b8AiQFWkSVipmzpzjy3fu0V8hp+0lXZtXKfICcy5E909UK+Ft9UajyDj24vRF3Qejf0l1l0i1vAYWe86Uv0TpsOVvtBrExPl5AXdG/YeFgOEAfXbX5NE1eXRNHl2TR9fk0TV5dE0eXZNH1+TRNXl0TR5dk0fX5NE1eXRNHl2TR9fk0TV5dE0eXZNH1+TRNXl0TR5dk0fX5NE1efxRMtM1eXRNHl2TR9fk0TV5dE0ef54mj1enL+s++MZ+DIXEidJV9sfc/rw6fVWffp2oN9jR0dgTgjvMcRTNYDE+HI/0t0W4RMkJiuCzyAmO6g5x4yKr33tDofZ03mGZNqOT/IslmmW6LQG0Hjyc9jSvGdhoMcywOv7xEzqJCPxtgl+RWTANFb8Hc+ad5F/EOXkquho2OgoRK/tFmQzzbG+pVIrpB035QMcqAxOpDHjDPb4eIeP8bpiYaBWYq72VxfNWpzuaaBfbgm6E6OXfcdGCrCdhcUQ/vLHS+uVRaeZwW67KmZRjgWD3IYjkcog28sk6kfL1CW8T75Kclwg12H+VA2gAzH0jjD0f/P0vg1MdISVSgeHGLfNv5NiP+ZDiSz6VbLeQs//XjxPl54R/T9IQMk9dVjVVGSNe5QeXet5Z2TYDQrAEfuD40xOWG+5FuNnga/OVIJQ6q4Pe2Rwijurlksudn/gNoUYKHxhgWPnEUW7zPS3g9o7rSDp+neT24lm9ZtrwXaZG3KwPjNcuUhbn8gQ2nzB6hiACcx3A0oybLjpnZc2+bRmSt5dY96PbWlvRUjfs3cYKTl7PuEseWLzZFEgq/I8Ibjb/Bbtxf4Y= +api: eJztHGtv27r1rxD80ltAdtIHhgsDw+bGaa+xNDHyaAcUQU1LxzYbidQlKade4P8+HFKUZEl+ZG2xYdAny+LjPHjePNATNWyh6eAL1SaLuNT0PqAR6FDx1HAp6IBeg1EcVqCJWQKJwDAeayLn9u+NXUWY1jLkzEBEHrlZ2qEFX4HwEzRozaUg41GfDNMURESmf3uU6kGnLIRx9NcpMZI4wDMgzK/jgjBSzCOhFAa+mz4NqExBMURxHNEBHeUrR8wwt5QGNGWKJWBAIYFPVLAE6IDmqIwjGlCOBKbMLGmd6hre2iguFoRHIAyfc1CIgoI/M64gogOjMgioDpeQMDp4omadWlB2Fd1sggJ6hWYP/88M1LqBwOeCaJEloHhYBU4+L0EQmXBjIAqqJ8F1wcUIuYdDmQZVZV0DTy4MLEDRgM6lSphxr/7ylm4290imTqXQoHHF69NT/NnG9eofNKAWgDA4ytI05qE9nZNvGqc8NYHK2TcIDR6TwrM03AEoj6fBx+ef0SbYYvgRFD/vGC6zOCZ8SxVmEEux0CjOTd5vrFCCMGdLCB9SyR2/tkGOhcMJaWIzmRm7kVtHwmKhg8u1B/zINAkVWCWcK5kQJgh859ogU8plKAD7T6CcexzLNkFlyaUV84YGBPvOFUctDTsWbwJquInxVanfIyP7kzovNwFFhuMepXJ+oWzFDEPMIWE8Rr1D5cOZFuL9IY7wY/lQbNlGowPeNpLjt5fyOw0KJWOXFtijl8oJHC9FyAqdaMVpx0442a7aGj1yceVlvzzYO9VCeH2Hu+sL1BoWhqCds1GZECi924pu9w1lkmYGzsWqqUBnboyAWHElRYJ6U+EIeVyCgqrOqkzoNr1gcXw1t77jGfJRHms719EGxMwgOq2DChatDK8Kw1lB/Wg2MpKig6kpsQJrp1isd6gcGsYRb5U6tPpNjasAtSCpgQQpgbYTEIZxgZKYsAUQP3PrGOZSVQ+hclqHbZSCVGpupFoflqs6MuVagiLn0fA4WvHi4TEyn0tsdTXBlQ5QLv/MZLptKxBZgsZJQSiTBEQEkQWQKgjRiOOU7ykojhxhaLUyobM0lQoH7wP6vYdb9FZMoaDpH9qredqfQKGy3Tj88bSlPEKJb6WMrQUhyNZ1CiRVcsUjiMhs7fxVwarfoL/oB+TFtyxdG1AvAvJCOXuBjysdyghevOzvcAC3XvqsNRBzvshcQNgUR6/moGWmQiAsjmWYO1gRbdmJrZ0Oy+EizfAn4YIneJynwX438eZ1g2OXWTIDhQH1h8md9rhB5CWrzfj9TKhnx0JNIMn17UcADxOZCYOA3X4YpH7k747DAJeiBFTkkCnFMHrmBpIWPau7MTrE+Qg+Yob1Yi4eyHikid26DJlbgFekpC2KZVHEEQSLJ1sS0vQKWRyzGQqzyxp2oFcVyhVTHJeQB1j3VizOMBzkShMNZg/GoRQRO99GO2HfL0AszJIOXp++/T04bDsjRlIWPqDl1CmEfJ5H9tZwhpk2MvETNOFCGxbHDUZuGfdNQGM+B50y8YfMlP55srzE7VrYQR55HKObJzOYSwWEZUaiGwpZHK+JNjJNuVj0yZA49so5mZ5OCRcRUguaZCLmCUcJ8ajvsktnW7YI5Y8ZOHOBeZv9LIjDeT3DE2gaVZ6ANixJMXTZ4msl6Hd8ZdrcpdEvg4X7k8wBKADeGKZ+BcDi8Dxg7QA5dZzPITR8BRd1UXqu+NxKw2IMO7Mki1n1iHN5qgUqOVoB4SKMswgDVCbWBL4bEDigLX7MIncmhUA0pdD7bFY1WUFKh3ZxW2JShqT/twlOM5itsOQ4GdsOYYe1o9jjFMJMYUoZr4k7vyJ/96e4xzu5UM+ScLjKUYSFNXvr4Nc1wE3vk4nUmqMjsFZKD8jUmi6IpgE+MoXJPj7nmZN77YwbPs8Zj93kWcbjKH9rn9+7oUrI04hUPQAsfbn9sZiUb+8fXbCplFT2ycPxjw7MjvD15wJomuYymE1Aa7ZoF+PShh4rbQ6za2C6PWvwDDy7Ph+Nb2++Xt9dfr26u6UBvRi/P7+ZDC+/nv9zMr4+H9GA3kyubr9en59dDD8Ob8dXl7tIKQC2u6GbUhox2WMreIfsac3ENwGdMQ3jZBdLnJuvj8+kjIFZdeJ6ovhqm2V+uK5s4zmxkQ+RIl5XlcmXMEImvMp5dWtEgRAhqRdcPOw1rM/P2+vYjoowsVlfJB9AYBUakxumISJS+HRHBTb7CYhL5wObaBQJCJacn1GYubT5lCszlmFrnj7NsvABjM25Xj6/bDMq/zUg5PVNdH/FO21Dp17EdShXoHytsVKiLwsPfVfOcDRfw/wwNtdVBhV+twBedbk4cHc9JrauXOSSU/1mcHKSrHuOK2jdFrr+hv1rcHLCwhDlqB/66sDUcc8hWLfLpRTgeJ+cFX4iT6M1mlELYJ8FdVN2WL9ysKrNKOK3uN3GSq+VrRa/EcssKmSvybk+uSnwZI/a8kXKRQyOH5kqH76CMIoVf3shbm0dCfwJiuWFt6mT6Kl+s5dg9qhpQB0ojF5wR//rAPl/Dg4a+SoY/P+mjSUTz4o9FbNGMmOZ5GbvVKdppnvAtOm9QpohQ4PRewRtXk1f9slHtiYzvAvI9ULLpKhwKCfwFQU4NuSz0Zo1BZUzfl7QtovkEpkd9yPPt0B1Dd8jlRXo4ZaE/pdlZtMcrOC6Lz6sUGSWzFhfVVSs8fKt1LjzJDVrKyVpNot5WDGijm/27dAu5rYgcNB1fl6CWUJNt/HOz+1lw1a/nb2Jxduj+nkteRSBOALaJ675jMfcrPMAlMxjtuiT8ZxM0YNPg20k3MbOIUQwZ1lsSMy1ISsOj/pAOVQBi65EvPZlkUbtfedMLzefhhdjDKDGl+6pRQL6PgJs3HK7gRYXeMawaECmds8pVjWnOYBpn9yAjVCKNy6FrdyGV+WFKbw+j8FnsDtj0Dpu5xjskny6FSguVizmUVWiSl/dGGqVd1vDd9q7UKB/IIo6XOLG+373hoteATCgOgtDgGgrom+Ndif5mhsDaf+IKL7OwT+yhIkeCo4to3lW5jflPpzIkz/iMSQawbnwWWE2cgyTykuUQ4Q0zUwz61MmS0t8Krcn1VDI5j1eRdErVy6JbbCMk/wmedVmBq3uqV6c/E8C6X31g51XYjah3XEf5mLCXYnHyFmancNrwRIe7hoeCwMqlXGtYlaZ8/zyXfXoL5DT/pJul1cp8gJ3LsT2T9Qr4bvqjU6Rcez16eumD0b/ktoukXp5jWsyBxMuUTp8+RutBnFxfl7AnbHwYaFkJqJ+1+TRNXl0TR5dk0fX5NE1eXRNHl2TR9fk0TV5dE0eXZNH1+TRNXl0TR5dk0fX5NE1eXRNHl2TR9fk0TV5dE0eXZNH1+TRNXl0TR5dk0fX5NE1eXRNHl2TR9fk8ROaPN6evmn64Cv/MRQipLFV9sfc/rw9fducfinNe+zoaO0JwR3mOIpmsBgfTsb22yJco+RERfBZ5ATP6g6pxkVevw+GQrvT+QrLrBm9zr9YYllm2xLCTHGztp7mHTAFaphhdfzLPTqJBMxS4ldkFmCh4vdgBvQk/yLOyVPR1bCxUYha+S/KZJhn06UxKaYfLOV9G6v0XaTS5y33+HaETPK7YeKi1eFkbL2Vx/PGpjuW6Cq2Bd0I0X/HxQqynYTFEfvw3kvrt0djmcN9uSpnUo4Fgj2EIJLLQ9D5ZJtIhfaEt4mvkpyXCC3Yv5cDaADcfSMd0Ff9V6ev+6c2RJLaJMxKSP6RHP81H1J8yqeW7haC9r/6daL8oPDvSRozbo1M5soyTr7KLy4FdFD2zdwHdCm1wfGnJ6w33Kl4s8HX7jNBKHZeCelgzmJdv12qcucXfkSolcIHWDe+cZQbfWol3F9yPZOO365zg/GyWTRt+TBTK27eCYp1FSmPc3kCm3sMn4HZZOfLUz7u2ugqKxsGbsuSfDjHwh/bVtuamlbj3m2snp7cjFv5AGKzKZA0+B8R3Gz+DZPHf6s= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the Studio associated with the given Studio session ID. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-dataset-v-2.ParamsDetails.json b/platform-api-docs/docs/describe-dataset-v-2.ParamsDetails.json new file mode 100644 index 000000000..3bbd1a82a --- /dev/null +++ b/platform-api-docs/docs/describe-dataset-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier.","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/describe-dataset-v-2.RequestSchema.json b/platform-api-docs/docs/describe-dataset-v-2.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-dataset-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-dataset-v-2.StatusCodes.json b/platform-api-docs/docs/describe-dataset-v-2.StatusCodes.json new file mode 100644 index 000000000..6655a5d34 --- /dev/null +++ b/platform-api-docs/docs/describe-dataset-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"workspaceId":{"type":"integer","format":"int64"},"organizationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"lastUpdatedBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"description":{"type":"string"},"mediaType":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"version":{"type":"integer","format":"int64"}},"title":"DatasetDto"}},"title":"DescribeDatasetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-dataset-v-2.api.mdx b/platform-api-docs/docs/describe-dataset-v-2.api.mdx index 84b6e3ecf..39fa5c29c 100644 --- a/platform-api-docs/docs/describe-dataset-v-2.api.mdx +++ b/platform-api-docs/docs/describe-dataset-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the metadata of the dataset identified by the given `dat sidebar_label: "Describe dataset" hide_title: true hide_table_of_contents: true -api: eJzdVt9v2zYQ/lcIPm2Aa2ddO6AGii2pu8LosBVp0j4EAXKSzjYTWmRIypkr+H/vHSXZUiznR5+GPdnifeR99/F4d6UMMPdyfCEzCOAxeHk5kBn61CkblMnlWJ5icApX6EVYoFhiAMYKM4vf9T6hMsyDminMRLKOlrlaYS6uasA0uxqKY2sxz8TV7xDozKQI6N9qSFD7KxGMUHmqiwxFXKKvmXFLYBb0Xzj01uQeh3IgjUUXDdOMCE4i3QQnlacvLwlhwQFRRcfBlTKnD0LeGXfjLaRI+wZScXS3Bbq1vB/z1wYo8mKJTqW7+BwT8OkClyDHpQxryyerPOAcHZkq0tXSb6/kZjPYut9K0Ti3EBZ7vuswhCeJ8vk9xw5vC+WQwg6uwB4i1S5ye8ngSjLP9pdHR/zT9fXPRzozNUQ+D2wFa7VKo7Sja8+Qct+FSa4xDSyy44sIqnJQR/c4UGU9fAey8KQfGXYhXkhY0aGsKjFQmmVj7Rj5N0tKMT7D1eE7ah3Zx6xy3mep+fXIT8xU0Lx0TkdPKZcZ307ApxEzbg65+rbN9idtyg9FosGHc0s3hdnJ+v8udifVe85bYqbgLK72WFmkdw5Zqn17KyrGvQiKounq+/RNGWrsbkiM0Qh5dSKXx5YNnAMuWCrg0j/zsf1QzqxAF/0Wqi+mcCn2M1d+gjModDhoXpNPlR4yT4mss0bDQW1+4IpaqfIXKztJJsHE5RX1im6mPFTTt6fU1bo5Zbvc7UmndSUmDKNe9dXiE8gEP0f04TlFuf2Cl+g9zJ/wVBvgg2/pvXPG7TH/taeLNO1Y5CYI0NrcER+Ge0wLp8I6NuETBIfuuKCeN7645AZFHXphuIXPMXLkdjiWo2YWGZXbjrkZNYMHd190q6azF46KhVyEYP14NAKrhqk2RTb0eEukhsrs9dfP0SI+UWLxvYp3jBfHn6aSKTWMP7PAlVht3lu92GMzCMS0jCBaqf782WTM9V2ISvA0E7fX4tYs2O1jBDlcldL8VYE5MyCNmdENvh1yXUWj2z92hnaey1+Gb14Pj3jNGh+WEBOrHlWa/G3mu/sky12C/hcHxPqSAv4bRlaDiuUiqlXWWdaaeAdy3J7MtolG2bAgYRhblgnZz53ebHi5Gho5/TLlIdH8+magPT6g0mMjZS/lG1zvja11PZYxXVfgFBN4JpmfTuuq8bN4cNzsJdU0onzdZtOQ3Um5uSTwAiHjuY7oVfbjNEUbWjv3ylunMnx4f0ZY6D6+e48tnt7Liu4tIs7MDeZ0dw3JwN9McLP5DgH2ejA= +api: eJzdVt9v4zYM/lcEPm2Al/S6wx4MDFt7vQ3Bhu3Qa7eHIkAZm0nUypIr0ellhv/3gbKdOo37656GPSUWKfHjp08ka2BcBUivIEfGQBxgnkBOIfO6ZO0spHBO7DVtKChekyqIUXyVW8bvbp/SOVnWS025WmyjZaU3ZNV15zDLryfqpCzJ5ur6J2T2elExhR8NLsiEa8VOaZuZKicVl5S2S+cLFBRKW+UplM4GmkACriQfDbMcUjiLcBd01kb66xgSKNFjQUxekqvBYkGQwr3zt6HEjGY5JKAlu7uK/BYe5/x376hsVZDX2UN+XgCEbE0FQloDb0s5WVumFXlIoAXdLv3wHpom2YXfUdEHL5HXB7G7NFRgr+3qUWBPd5X2lEPKvqIRIO0uaJq5OLeUBbEfHx3Jz36sP3+DBDJnmSyLFcvS6CxSO70J4lIfhnCLG8pYSPZyEazbAF12LzvqfARvAlUgL4aHFK8AN8gorFKB2ghtwp14/iGUzpO3hHr6jgZHjiFrg49ZOnwj9CfAmo0sXQbyM7t04j8U4OuAOb9Cq//Zqf1Vm+xTmRgMfFnmyJSfbv/vZO9JfeS8gnKNF3F1xCokffAkVB3aB1mJ33esC3rE7+s35WRof8PCOUNo2xOlPA5s6D1KwdJMRXjjY/sqzWzQVOMWT8FVPqNx5Dqc0RIrw0+atxYLnT1lnlkmXzqDT3LzFVc0kMrvwuzZ4oxdXN6QD/tKea6m707pqnV/ym55vyedd5UYmka83o/V4lPMlTxHCvyWojx8wQWFgKtXPNXe8dm39NF75w+Qfz/SRfp2rKxjhca4e8rjUYGyymvexiZ8SujJn1S8hvRqLg2qIF47aeErihilHaYw7WeRab3rmM20Hzyk+5Lf9J298gZSWDOXIZ1OsdSTzLgqnwS6I48T7Q766+doUZ8Mstyr+iD+6uTTDARSj/izENySNcS940si9oNAlGV0gqT780uvmJt7jkzINBO3d+R2KCTsSwAlXZ1R6JxFGZhFZewnP0y5q6Ix7M8PhqHO4d3k3dHx5EgWSxe4wKisblbpBdwPeI9R1g8K/S9OiN0tMX3haWlQx3oR6ao7mQ1G3gTS4Wi2U9o8gbULLL51vcBAl940jSy3U6PoL9cBF0ae3xJNoGdYemmmHIV8S9uDubUryBD1ukGvBcAbwXxz3pWNb9Wz8+YoqL4T2e0QTQ/2gcpm3iSwJsxlsLuqO/tJllHJg50H9W2vNPz68QISwP3X9+i1xdNHUdV163Hhbsk2zQ4ky7cAbJp/AeD4elU= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the metadata of the dataset identified by the given `datasetId`. Appen id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-dataset.ParamsDetails.json b/platform-api-docs/docs/describe-dataset.ParamsDetails.json new file mode 100644 index 000000000..cba1d0d1d --- /dev/null +++ b/platform-api-docs/docs/describe-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/describe-dataset.RequestSchema.json b/platform-api-docs/docs/describe-dataset.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-dataset.StatusCodes.json b/platform-api-docs/docs/describe-dataset.StatusCodes.json new file mode 100644 index 000000000..6655a5d34 --- /dev/null +++ b/platform-api-docs/docs/describe-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataset":{"type":"object","properties":{"id":{"type":"string"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"workspaceId":{"type":"integer","format":"int64"},"organizationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"lastUpdatedBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"description":{"type":"string"},"mediaType":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"version":{"type":"integer","format":"int64"}},"title":"DatasetDto"}},"title":"DescribeDatasetResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-dataset.api.mdx b/platform-api-docs/docs/describe-dataset.api.mdx index 76f1a3047..54683ae47 100644 --- a/platform-api-docs/docs/describe-dataset.api.mdx +++ b/platform-api-docs/docs/describe-dataset.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [Describe dataset](https://docs sidebar_label: "(Deprecated) Describe dataset" hide_title: true hide_table_of_contents: true -api: eJzdVkuP4zYM/iuCTjODJJ5utwU2p85stkXQol3MA3vIBljFYhLNOJZXkjNNDf/3kors2ImTeRz3FEckxY8fKZIFd2Jh+XDCpXDCgrN82uMSbGxU5pRO+ZBfXNwtlWWQykyr1DH8lpAZiIUDOWC3AGwy8hYzYOGa6dnSucwOo0jq2A4sfAcjBkpHWSLcXJtVX2QqksGqH6z66/67c4Zi5pbA4twYQH+V48HFxdf0a3oDzihYg/VKK3CCrJme+//hJqYkmqq5AslmGy9ZqDWk7FtQGMtvA97jOkNcFOdYYqRVFKOtDsozYQS6AEMcFTzFP6j3pM2jzUQMaNXjikjKhFvyfea+VHoszVdgVLyDZVDZwPdcGUDPzuTQ4zZewkrwYcHdJiM/GDQsvCpRJtz26Nf3vCx7NZg6oJNQQkjMInnp4pU4tkbodUrKNtOpBUvyd5eX9NN29c+feGesEXvqSCqyLFGxZzl6sKRSHLrQsweIPeOGcuLU1kEI7nlFJTvw9nhuMUIU7EKccLHGSyluRKASYo2oI82/iVGM8RWujqeocWUXsq3zLknA10E/IlMuoaN7vHqczjXpN6vxZcC0WYhU/VcX/ouM0mORJMK6+0xSN7je/Ohkt0q9474VSCXu/GmHlEj6aICoOpQ3oiK9vlMYTZvflxtJSKBtMNM6AZFub5xBYhsyYYzYUHIcrOwrH9ubamYtkrxbgv1F5yaGbuTKjmAu8sQdFW/Qp4qPiccI1mQ6EUe5eUOKGqXyFzE7mo2c9sdrHBztSjnV0utbQrOubqmP2+PpJnRi1CGt9129+FpIRs8RrHtNU26+4BVYKxYveKqV4sm39MkYbQ6Q/9wxRarJzFLtmEgS/YR4Sl/a1fJRDyzAXUG5jZ/R1yAMmKsch+BwMqWRhQN8qWm+L8JMJxGP6r5po6LRQ8uoWoWiop6tZVQtGpzcmXW1EeQG+wqvlh1cagZxonO523gOJvGtl7DPYRFiH0mfXX0ec8JahXJLudjy2gyoppY88jCqfQV7JTzZfvxeFdfDk/OkKepfZB7yEFCQ2+cAUrgKWQrKVEQi9kXUDr4Zcmi43u1vO0HzSfCfBh9+GVzSWaatWwlfg2GpORvVST5n+8vlPuJiV9g/9LIaUu/gX0fQlO9XPgdFKOrJbhmwaDBsL6r1io+S5tZYlzbW3xJTQfcUxQzl9yYpSzrGDmLoeU2pdRslZlREWP5SWfrGxzUXiYUTiTm7CT3lnD2zFneGWQ2qlMZUmB4cPx9hs7eQ02r8JlinVuQ3YNoxXE5ReQlC0i6KpG3lV3EMmWtYHrTkVu/649Md6op2F9h79f72TlSYTq9xpx8hxZRWIB39J4Bl+T97LNdz +api: eJzdVktv4zgM/isCT23hJp3uYA8+bTuZHQSz2B30gT1kAoxiMYlaW3IlOt2M4f++oCM7Tuqmj+Oc4ogU+fEjRbIEkgsP8QSUJOmRPEwjUOgTp3PS1kAMJyc3S+0FGpVbbUhoLxTmDhNJqAbiGlFMRvWNGYpgZnq0JMp9PBwqm/iBxwd0cqDtME8lza3LTmWuhyrcOg23Tlen58dibp2gJYqkcA4NtY4HJyffzXdzheQ0rtDXShmS5NvCzuv/wZLQCg3puUYlZutastArNOJHUBirHwOIwOboJMc5VhBDE8VoowMR5NLJDAkdc1SCkRlCDI/W3ftcJjhWEIFmknJJS9hn7t9GT5giQ6eTLSwHETh8KLRDBTG5AiPwyRIzCXEJtM7ZjzaEi1qVKZO0Ofr9I1RV1IJpAzoIJYQkPDltFm/EsbkEVTVlZZ9b49Gz/PzsjH92Xf3zFSJIrCE0xFKZ56lOapaHd55Vyqcu7OwOk5pxxzkhvXEQgntZUasevBEUHh0LtiFOQK4kSY4bM6lTZo2pY82/mdFp9BZXz6eoY7IP2cZ5nyTg66E/AtKU8tGtRzc2c8v63Wp8HTDrFtLon23hv+qSeS6SVHq6zRV3g8v1r072Tqn32MtQaXlTn/ZImaRPDpmqp/JOVKx3SjrDPX5ff0lhirsXZtamKM3G4gxT35FJ5+Sak0OY+Tc+tnfVzEqmRb/EobeFS7AfufYjnMsipWfFayMznTwnHhtCl9tUPsvNO1LUKZW/mNnRbES2Pl6h87uVcqilt1ZCs26stMe74+kqdGKoKtb62NeLL6US/BzR01uacvcFZ+i9XLziqTaKB9/SZ+ese4L8t54p0kxmYSwJmab2EVVtart8tAMLk8JpWtcz+hKlQ3dR0BLiyZRHVoa0tDzfF2GmswiGbd/0w7LTQ6thswoNy3a2VsNm0QB251bNRlC4FGJolh2Z60GS2kJtN54nk/i6lohvYRESn1hfXHwbA2NtQrnmXGx47QbUUsseIYzquoJrJYjCx59Ncd09Uk2a5v7F10MeAgp2+xJADlcn6IMyF5FM6iLaDb4bcmi4tds/toLuk4APgw9n54MzPsytp0zWRRi2mqNRm+Vjsb9d7kMut5X9S2+rIfeE/xFD03XDqpNQhqqebLcBDxHEu5tqu+NHEHfXxra2pxEsrSe2U5Yz6fHWpVXFxw8FOn5fU+7dTssZV9GkBKU9fyuI5zL1eCAxR1ehqRyLF/bi3jCbSWV4ToXxARDBPa73NnLejd8F69CO/A5MW4araRXBEqXiZXRSBvlFkmBOnZtPevJO8/ry+QYikLttYO/Z19Z7UZXlRuPG3qOpqhYk8X8GWFX/A5xI15g= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Retrieves the metadata of the dataset identified by the given `datasetId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-launch.ParamsDetails.json b/platform-api-docs/docs/describe-launch.ParamsDetails.json new file mode 100644 index 000000000..6b8ce80d3 --- /dev/null +++ b/platform-api-docs/docs/describe-launch.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"launchId","in":"path","description":"Launch string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-launch.RequestSchema.json b/platform-api-docs/docs/describe-launch.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-launch.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-launch.StatusCodes.json b/platform-api-docs/docs/describe-launch.StatusCodes.json new file mode 100644 index 000000000..7c4350430 --- /dev/null +++ b/platform-api-docs/docs/describe-launch.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"launch":{"required":["dateCreated","pipeline"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"computeEnv":{"nullable":true,"allOf":[{"type":"object","properties":{"credentialsId":{"type":"string","description":"Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)."},"orgId":{"type":"integer","format":"int64","readOnly":true,"description":"Organization numeric identifier (read-only, set by system)."},"workspaceId":{"type":"integer","format":"int64","readOnly":true,"description":"Workspace numeric identifier (read-only, set by system)."},"id":{"maxLength":22,"type":"string","readOnly":true,"description":"Compute environment alphanumeric identifier (read-only, generated by system)."},"name":{"maxLength":100,"type":"string","description":"Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters."},"description":{"maxLength":2000,"type":"string","description":"Description of the compute environment. Maximum length: 2000 characters."},"platform":{"maxLength":25,"type":"string","description":"Compute platform provider.","enum":["aws-batch","aws-cloud","google-batch","google-cloud","azure-batch","azure-cloud","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform","moab-platform","local-platform","seqeracompute-platform"]},"config":{"description":"Platform-specific configuration. Structure depends on the selected platform.","type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp (read-only, set by system)."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp (read-only, updated by system)."},"lastUsed":{"type":"string","format":"date-time","readOnly":true,"description":"Last usage timestamp (read-only, updated by system)."},"deleted":{"type":"boolean","readOnly":true,"description":"Deletion status flag (read-only, updated by system)."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"}],"description":"Current status of the compute environment (read-only).","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]},"message":{"maxLength":4096,"type":"string"},"primary":{"type":"boolean","readOnly":true}},"required":["config","name","platform"],"title":"ComputeEnv_ComputeConfig_"}]},"pipeline":{"maxLength":200,"type":"string"},"workDir":{"type":"string"},"revision":{"maxLength":100,"type":"string"},"configText":{"type":"string"},"towerConfig":{"type":"string"},"paramsText":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"mainScript":{"maxLength":200,"type":"string"},"entryName":{"maxLength":80,"type":"string"},"schemaName":{"maxLength":100,"pattern":"[\\p{Graph}&&[^/]]\\p{Graph}+","type":"string"},"resume":{"type":"boolean"},"resumeLaunchId":{"maxLength":22,"type":"string"},"pullLatest":{"type":"boolean"},"stubRun":{"type":"boolean"},"sessionId":{"maxLength":36,"type":"string"},"runName":{"maxLength":80,"type":"string"},"configProfiles":{"type":"array","items":{"type":"string"}},"userSecrets":{"type":"array","items":{"type":"string"}},"workspaceSecrets":{"type":"array","items":{"type":"string"}},"optimizationId":{"maxLength":32,"type":"string"},"optimizationTargets":{"type":"string"},"headJobCpus":{"type":"integer","format":"int32"},"headJobMemoryMb":{"type":"integer","format":"int32"},"launchContainer":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier associated with this launch."}},"title":"Launch"}},"title":"DescribeLaunchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-launch.api.mdx b/platform-api-docs/docs/describe-launch.api.mdx index ccc054a7a..9b585a24c 100644 --- a/platform-api-docs/docs/describe-launch.api.mdx +++ b/platform-api-docs/docs/describe-launch.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the launch identified by the given `launc sidebar_label: "Describe Launch record" hide_title: true hide_table_of_contents: true -api: eJztfXtzGkmy71ep0MSeleIIkGXvxB7/dRGSvZwRNlfIcuzx8RUNFKhH/WC6uiUxDn33m5lV1V39ABokj21cG7FjAfXIemX+Misz68te7MzE3utPe56TBOObvc+HexMuxpE7j90w2Hu9d8HjyOV3XLD4hrMJjx3XEyyc0kdZibkTHsTu1OUTNlrQDzP3jgdsKH/vTobNvcO9cM4jB1vtTqDdU+plxM9lv4d7cydyfB7zCMn5shfAByimW4ACLpIzd2IsnKdRtsEEUBrMMmoiKBjxPxI34tBjHCX8cE+Mb7jv7L3+shcv5tiBrLT3+HiY9nkfRrdi7ox51u0fCY8WpX4/6oIsSHweueN836W+3CDmM/ppGka+E8uvfn0FvX9GUsU8DAQXWOP46Aj/yff3/jeoOg6hlSDGX5353HPHNKet3wUW+VLuNBz9zscxTnCEKxC7sgO13vBXNkWf9iZOzDsRh//i0OfunHtuwHFXrG7NneB/fefhnAczWKHXx8eHxRlG0v15EvOz4A5LB4nnOSOP66VxPO/9lNbepAiGO3Vn0CEtDvTrOTHOXuU3Kwqrn9aOZAz94ho6nuhOyvukuAU6WXFj8Rl0ytRoGQ/u3CgMfPiROQmcDigkF63JLuRIBeMProhx9469MJkwoOkOmota/+p3mEFSkw04Z5/kEpk/fN6/ieO5eN1qTcKxaAr+Bxy2phu29BQ0nLnbGlO9hlHvoIkLE0az3GCXblTcpc7kfeAt9KoVdmg0cwL3TxpdxaFg+1i9EUL9QyZ4jOxCLETMfUmHefKegZpV53MdKTV29LruO1UbwJvfOGuomfEAOaXkpiZNkj/lqHpxdFQmK0/Gh8AF9sWwMu1L5M8Ve7PJeomI4ZdAwFZEDv+iAa3nKD5kE0fcHDJoJQlge4pxGEFjN8C6x8i5icpc7/kpPFpP7Wn2SUuZamKdB9dPfOZR268Ztl2kJD3+BTL+USaCwwiR3Tj3ojFyYpJI+DcdR/h7FoYzjzc8dwr0uTwYA7dIv9UV1Eddx/kzibIf5Sf92+0/RcPgTvw293F2y82PySz3UXgJnGfjC09MzY+OB0I6Mr/xQ2eUqxCOHS/XJPELNdG5tlbPR62RbzTWdYMrzEVxZOWx/7VjfcIqf7ORlzCfZly6RCqOmlKKkyQtoZO+ljRizsfA1cZMlkwiJewGwCTHMcwPwMg5DyYAIwM64IJ7IIqB3+kOES6uFtMoKU7daL2ARhnAJiBjx3EYLRjiR+KCAj4SWgThEvl84qJAxVanXnjPpq7HFQ+J+EUSDKjF9b21JxPmMPkNDM2JQbDzMcwloAM51mDaUKhZlZpHLjLlEArchbdI0jv+EBMVMGTgM4AIldjvw9Q5AUxTKOJGlASqiRrCnzZkS3bcciZ3DjCwyS8wtga019DtNVR7Utrgt88zdGcKcwyCxKsYGrtx7iSL9wD8T77JSA3BYozTiSIHMb8L8lesB9RaOK+epTMDC9w5kYsAmEQzEXLneMm2jVBdauUGoITRyCgMPe4E5QUD7QG1NVdkjcA2xE2aLhM2xX4PR00Dvj9T01qqQ+t40h4Pc7BfAXg5IYf5j4jh3RgVB+BUyGFgPq5UNyUAUjlZAqlB0KcOZRXCIMCliO2kLG/tGXDxT8czx2kwQewXtbaF2ueFUsR3tt3jmtiGbKuBbcn9PXGRSN8NHGB660ehGTnDYixXuYyaHQF8GwaWygrJzKGlg2YJIT9WEaOO0eKd1L7zv4Ocg/lCKhHD5UQejkNtgx78kJ/oCgGS6ZfPJFrSxbvPyxgl1cYe4Gke/V0wAbAUZgkXROF5BbZHyOWYMxKhR/IWhROyPUNBYz4WJCZJU38fAT9izhi5pxVQP4mA2hE+JEvWOlun6Wm6v+GRITZgbsQznR7WnbLQd2NYVVBs+dRJvJgkw1CxgCFRnQgevasl3D9AyVTNHgz+hbMZSGaIzaIthwRqEE6UpIbVrtf0v6AkNQ0td/vMmUwiGAJqyOVW52EUrzWfvDwu9YEUY90mO5WT8ZoNj4+HKab4vwmvg04ub5SxQanvf2C1AlNkCYoNmBPFanLIQB5LVBkM1LFF55UdQ5/3Ny50qY2bBEAYMGgmkpHcDU3WgY0F2yu841HkTmA3acN2Wiuv2yChvvNARA7cP/k204+k+8qqEST+CIiFQRB12fEEuiSZGk/JQQqoBfpfwMNE4KHOFvDF0VG2gv8djt5Td2IjHqJ6DGXV1IhUjRJRmDoz0Kb+tazDZagRjiOZ0dgwT+uQVgdOs+RZrtw5JgWNdOkqYKUGCe0RjNQZx29hRRUjRaN/XvhvCJU0dpF4EoFPDk8qbmqo4AU8ZHWPndI94H+fH01DkoFR2x8H7AS/XAtU82uLhgpnxi+pUNXqAHQY04WN3lLI6SK+7PaiVPwOxKfPRY3dl93kFPbEyYCpVnCq/TCBzbEv2R2woBaKuRaK59ctvL1ygH9G9Hm4lX7y9EMX8ZmyTq/hgbBmsqyCISB0wyQC9MDuXUCLI7qDIVP9Pm/OmsC6EtHgDmC4F2psm4kvc5PI0Uj+jiwXkE+A6FttWqiK+yLYuOWsxdOL9tuzd6nVS6P4rgdLCYuhfq+LA0UyR/TAJ9cinMb3wLNbksIWitE7l98fGGR3AxEjXly+r3M7rHMM6oesIdXSKvrTRZi+aB4/eE404/lVAJlyEXo1+sNSrH3xDrfYLHJgO09h0zbgT/hnwrrtHoMt6LtCkESEUst4C3B4DWfqdY1tR7p7HOVZZ8BiR9wWcNEGiKxq7ZezWiV8v9ZEreDxntvH6/31BgpE+qopHFvnvCt3h+dJ7SY16yhmk14uVuoeVon+KZRota8780RsA8/fpZC80/8gcJwhydHVe1p12uM+6LK90TYdy7q6Q9zeS8/vIe4/n8+c0SJW9xcWX+4SvgQuBgfpLMCPdeZBlmSfPsrjp9jh8gOGrR+Y6uMU1C4uFchpgjz8ePPO31BF0/y5tH/Zx4HhGFOgfAltwR3smIFEyhsT+O6qxzN0ofC2QUKZfmnNCmdvozCZ13ASQm71kQTweTgTICihmvIRUgNj0JrYJVufXMlB4MzFTRjXUf8L2yWtumaztGaJO+EtoYsfrF85GNCMly+wJUR6gz8WZlBZPprsk1Gm7pzp+3bgxKKVqoa/0H8bRErDKKKZ3wH6ioUgF5TnZVkzyLkVBcTKFL7LE69ZD2040P+8cJHHH8qkJdbfusdLwLr2nhn031/CR0DrZaeCrgnfm2wIhYaKHMGSgO7howRK4yYIg8aE+zgqE/nDAgyxi6xevtZgHsZZYbYPo+N4xkQs9yQoNdtK/54bkGGOZD+5Q+DOgkldc4PoOw9bd6lsgZt2OZsnG7PAt/0PxiwTbhiJNmzAwdjxlknFvCVhqTUvJV2guR5tBbizG/xhDutLvYP+f7tqVOxdGNMPjlznexfw/5Kz7Rp65VNsGp3Q952G4OiWjCjPU05xCMPueX5f0paW00YobRBjndli1VE5ORtcXr/p4nHRf173L96/vTgbDLpXZ/A17vTrTrvf7nQv/339vn/Z7XX/5+xU/9K/6HbOqn4vnbxT9Kr28YSzGzjvkotIw4nIny8UFWOYqQULk5gYSqpz5iRvFcVD4i/Zwc0axU/DlTTLuvnjK1fTB1Fcyw83Abnts3avy7qnOIxESD1XSixkeAVOYlwhIW89d4PkoXGM2nYD2b3v/olHDfuXeo7PeSxyW1Qbg/4uqF/t9qS8nczLJekrD6w8RkkM5wGavgM0Yzg5tn3nT/iU7x6bNV2JM/MToE+8QpHIej6uM0VX/Q7ODbYX8Bi1YShFDYhkBN885bScq9OBfajWSNkVIQ6bpj6jfRrBSnEHNmEII4/InRSngJg5VJU0wb6L3HhBEOs5SNMNKvTVPSUKJxztFajScio1BUl5jzpslJCbCK48grQo9GgUeiXwsg34mzOFBZeYQjz00O65fh3eDB5oEc7JTKuspfPQVewbGqp3JVhox2CEmdIFjW17HbWieQFNIr9+e6LNt6Bx8/fBKfAU7fZb965ngnUkvDGMqzc8qMQ5sO1lBbnz+fj4N77oO3VulHH1bjl6ALpRekFr+FEQYz9JxrfPcxKcDJYPXrKRbFf15yqdcZkEB9l7AmLkdtuly+zxxaWSkHk1PFgt1hVgKEtftn/3QsKskTvpc1hHUG1mW9GvkY+WtfPIHdONrpOXEYfMgSlFA6PqTDPTTArJqtJg4sR5id0sAkay6QchiQUpN6BzOJ2uJ/l+EkW4CQXWkg3DfhxxBNHkxioFAF1CwibIyCrcx/5N6qx8KmQcxybHRV43CODg9+zszaAEf6DROrLgTIebFNoAtqibqcnNig0Y7Az3naG5Z7b/zU0Iz34TwVQZg6q279aZOgUxcEt9BbJKIPwkDONt+QDWleCa2ACSnLZ/aHAFPhZ1rQ0KZ+U1TG2PxJsKHA+sfxrMJz09RotMgW2y9hzdvzPT6bDF43ELqMD/N2XbQ7mrgEhCCtp9g5xcWNuDv3H7khmOCvrOAgUIHDKs48BnbwonGOnDgnndvkLFINNINoDcAAsLDDp80yG4BrT6LYncoGpLQrzWhN8BT4DjLy0TMKYGNaqMJM2b2PeUkcSJtKdE/TNxkQRlIya6ubyRrRlGJYHbarzalkXwPMcIM40NZ86HGfeaaeMw30GFNoZsABsi1JA1rkRr5P/6auND377o/fqK7b+NnDs3DgPzbBjjkWQdFu2Eh5Kaah1xmxvI7trbx7y3CW211M1EmpwmFxrhbGKKz5BE3zDGqJvsYrCuRlD6WhoOnrn1M/fdg7JdWt2KZzdlh+Wv0L0hFwBjeDi8pe8ZWTs3dHL4yz0A7IXf7l/4rbrw3REru73ds7d7u3+7B9sVN24ddJ6TQaqeVmrqen3l2lDuX4Z7Fyp1keNpBy/AfjU2fq5NrEKwSQmP5X00HOhlqZ861p26Eeia1KJqjQK2RxyTDHhktlb2NIKC7fEYFbQz33G99VQPZCU0W5Bax7EagR907JHGDCnjckbbjYBVz0HzrMJVegqCFw1sY+JEE/Kky02Boyeh4BJm2kRrG45BlVNGA2nrJYOgVC04UylL4JOBlVHoKG8jAFhalUuVoKtek336MILpStj55SA7DMTbmxI8keKg+Aidkhb1LlqhaKgcK78k1MY1rPUBU9tnnow8zBtAZZXPutIpm4jw8B6nweURNlU9B1RVzufsnDsRDe6qt4KuCRRteKpo4843CfwFA76ule0aCMOPauZID+h8OG0XZgiWRV1l4o4E7qrDfZvsvbZ0H4LQRC7RCO/xhmsstUw1Tu1q6dzBvBDTIQ1vmlAscQStARFPVjTye/h5LtGgQnwK+jcq8G+3cv7BmnqDjlJ1Xu81Hah9FszcIPNhaLLhfJIeoGF6MPAUYd4GNHnnztE/jtjbE20yNI/RN1RbJKt8RrXFDM03/bLx6x9Dadneg3E97rdg0oLJnwJMrtP8NgYwkoFc9aSRVSOYgeK+16fH4vrupQKLyyAo/SSZYE2fMtmrrmS4lF31tB8Z3fHWuhl2ozgBsKiqZK0q4CySUVq8lomcaDNr6ZZ8JwCRPulSfGa8qNMYBlU2HCHcGSID1YBKnRQvSrQWeuh4LvxRp59eseUxVdW2/kLmLuUA+LEyYdWSHs7DGWuDPFxAK4Klua50D34YuDIpiW79Eg9FvctgZZePU0aKGCnXobR8OrHTCT0VoX8WTOiiZn3zp1APjpauyLiqKV0stOtivvWLxKs1LcW28eZdzwk0zWBnx3pSnoBH8mLqlld45ywXPaZlt+fMm2egni2uB/RjU/5zXb4Lfhqu0e7eOWRT8SWZZM1UQmWT7NvfztIblA3SJKhGfktG5JeB48iBlR0EStbyuwuWXzR28Bo7LbezpZMP9Aua1IeL81SSawIXcJYbmNELwxlRUVYyXQivw6MaEzoYnLMxngpyEiMoaEgVrkOWdMYA0qfxO5NKeYjTbIAkQDYaZ1qL+Gua8CqLLTNQk1IPhybsHeTsSBt1LQrWJMNLryKQOxefv5QqRObPS5JaAQ3UNdvEzavOeXnS0rycqjDsTvIbLd8d1/MSh132i+q4YbSl9psMUOh4juvXAwd9NNcIzBp7RSo+VZUogW7nHYHHUbqFysaXbI5Dps5EjJ7VDVVpqJwpyV2HDS9gST5ing1AVIuhthL6OjuF6oHcS+qF+/WkSwkG/SlLyDwdkDZajGlIS0Zj7p5WSrRkiZMOKiQScRdmLZxAs/QjsC3PHS8U38PrdsXfCApmTr1hcC0SGi8J0ntngX8E/I5MPat+/VxOSfnQwGYboDnSmV3XvqEO9tNR9YlufVDg+8Gcj5/o5QFzlsYiL4lC01ZcWPMBCfAwGko3YHSYBJgL+wITjcYYJhqbzriov7sTpihl/273zjGvs8obCGpZROZY4o1DdLh6PTTN288zwirPQ80pYPTfYnzWNrNbtpmvFYxaK7T7L4pGLQej7sSte2EbKKyZ4UBTXVvx4+fvIPmMNShbprUB06phOq17x47JrkyrhLoCb2AsSIOus2VGCPq1HsotNkljq2OMXmsqf1TvM1TcOZkUVt5AVRcw3OhKiYKUzUaHaUnY8Z0bXFKz1GaOEKkM2ZfzdUDCRI6cEp8td7tYxbrQQb/GafogiiGjz3RpW/C7JkfrXBxXvsPxPOmbtrv68ydnCiCAkTmbbODkUrGF/0UlkZVeGa/UOjyTb44QN6cOQIs6sUPqsgjjdyZUR0U2j5LZLA1pEzddPx9+skwTSL2lpRuDDg2STUu7NjbdA7C/zWY4xcrMQ59wtn/UeCn3eByFCSYivoGtomkeh/PFE4jG6qg7ZLnLQR3uR+4dAMO2zBdZ81DMZSUj0STHXO0gevaDkIEQwDSXHvwsdF7PEfc2cAJYG0S1LPhWdpSCPvxDHoE0dKxpTbw/h4nXKlA/rAIFw5iKS8zOVmOLvnszYFKLYjFVka83yIza2r6n2qwZsoZN+plNsRylZvWW3dJbrCNMFW1iw2uTAYW3LihWvsotOM1JjUH9KE2CKh9F7XIYh1rWmPkbIw7bwJfBgXjO4UhNEu1ykG7yNCs6uavU8G/pd1LflvRsyTQF9RoYpGXlrYnhuw1tm5IhDSrjPnLHGodXT2ucZq6O2DTxvEXjj8TxZDxxxKc8wkenZBD0p6ue4fqseqrtaKwqNnRFcXBIA8KUHxSNqX+ApoZ4lTV1Hw7Ny7q1HAHmQfwME1GTd23iyJG9O2W6qGKOyx/BQfWZcigsg/9LEymsSoe0Ra5fmXX1uEIDLmb33cxTsJzFVrcbv2ziG1SJ/1VjHdBCVjdDTjmBjSbkk3LV9/FuS6Z5hUa3zoZGX/+i3PYaMq66oSwYDRoafOkeZE7sZLah5rFfmY5+xGXCBcLeSP06E5FVEXdfRdwRZclqI1Yb2X1t5CtlU31KRJgTgRCKuXTNMPJQlFLmIScrpX1/cgTZ0pa3znqVe5toWfTmE3PO5DDOKHcRolPOFACODD4bzuYvh4UQNHSXVqgjh7b6UYhbsR3VvGgcdvMVh5SxXvcgM9eYyAy4vBBIhyMz8d/f4MZXPk8qii5N9qRDF2WYYpo6hfIKQi/kycODMJndFDPhQ4OGJloHwEk9VDvHZ/laPGfMid/uC6jmcZWDTzvDPlMmvUFFBj0zP55WkY2karsUP1h4n9fQzwb4i31/0CJpi6S/ayRt3x+07w/a9wft+4P2/UH7/uBuWhfk+4MYpFaFU20gpwWePxbwtIGcNpBzW5JsIKcN5LSBnDaQ0wZyWrxtAzmtH/JXDOQEFh47blSpdLXpJ9Y/GdgbAquo7aqithMMwd4Q2BsCe0NgbwjsDYG9IdhVjUXeEHhiWglWuyc9dj54Y5GqRaoWqVqkapGqRaoWqVqk+oMg1SRw4zdhdA59xtUOzdCBNJtSmYp5lGUuHXF7wcnmV13GYuLdw8TyfZhSOi75mAF9bb1lLLT9nqFt7VBn9XZI7tU5jGtOxDDLrtOHo7q+LZl/aQ5l18gyfAMMmyzk0Vr+8rwOHylf6OcfczahODonsOwUNnOP3+ZfIdMvqcvJKKSRYpMER1t5gUwVlb/AagZw518u6sSFpy/IYLFcXFI2u+WrZ5NwVdcEK9kDNK/oARopLvxOwbVmi5vKq17KBUz6Pt4AtMM5FjDBOHnAy9VbdIeSs0e4wgITeFDlMkDDllNQKV0UYF8hUJtF4b1807nwlhz8I0PljlC7CVgSpHHxWHKAv9cPwMMqDU2/3s/GICkoyhVw/Pj74JRLx5EazVNR3ZLeVDQ4InqZrwLM2YRLfiLFqYpvvOCz7uRpGRZ0pCRyASiVe0inCPb+JLoLL1rH4S0PTrUsXK+E6iOqNJlBe8CoCTNmS3OOHOg+Vi4+ciYwt8j7oJN67ZS5Qzu3QSbmzEv1ZCqfQfmO/X7QoaDo9yMHghy0NP512Gr5hOAWrJiR6hBdC3p3CfTaQPTt3of7QeyDG7yDFiQePasqYVeVKUU+kuuwT6Xn1+Qjadslf8n0rTT9i273gDlx7IxvMvOEiXaQCR6mOCmdz5IbdpirheBhkCYM3DYImIamx1EZDCyjwTvhDxFgUTtft8y9mJoTlfYgt3T6CDHLkigJ9gmfmo0YHNI5e8XQ8rzVNpGlGuq7XyRaaGB6KPP7hiGc1ieIfobc9srGjY/XXXB0YIYxK2G9gXUO0XeEmZ8cQGCUuJfscwr0KcF8/E82AaCAiyzPSercPQYyW4lIU2Cuz89uZfguyfAtmRi/rY4Pa1PyLXb228C+FmjNZj+N2cwGmdkgs21JskFmNsjMBpnZIDMbZGZRvg0yKzNjG2RmXwu0rwX+lEzrGV8LzMyKNAObvgqI1U2jhn4ZcM2rf3WeDtz0ZUDj4T/PnQKlLr5mIEwrjHomDX9m+vfv3YSybCHhJ3zLcZOr6sdVrwmu50Lch1GNKu/8H7d52+9x5RN3j6tfrntc9RAdGZE3eFjuceULcY/1nnt7fIbX2p6H3W+IabbDI/XY0IrnqB5XPSxlhdaOCS1sKplV3+t9COBoMXR41k8Z2SApaxLfUZP4TqheNkjKBknZICkbJGWDpGw4/+4i1s+EWkHJLvhhoNHjZIuoJXULdrlYFrlQitJARhctfYCuVFzewT3Fe/3sZKBu8qRTFN347Utuh5d2KOVaKJ1ft1J3T/qs7uC/G/PIcjuXQiFZQAq9LgMSQnvLL3uRcDPpZW4SORrJ3pHj6lu79N2hCe6LYOOWsxZPL9pvz95l770qLNj1YClhMdTvdWFg6nV4LcJpfA8suyUpbKEUvXP5/YFBdveJLzVW0Z8uwvRF8/jBQxNCfhVApFyEXo3+sBQ9FwRbbBY5sJ2n+PzhLJLvK3bbveLjQctYCzB4jWbqdY1tR7p7+fLlgMWOuC3Aog0AWdXar71m+loTtYLFe249lwIslfoh41us5125OzxPKjeuDuFRzOaJDqhWh94FHfprXdqu3NN/7Z3tYfnS1sLLXYKXNkhoSZDQHewYFUyyMYHvrno8Qxep11lKQpl+acz6Oi9k7oipT67kIHDm4iaM62j/he2SVl2zWVqzxJ3wltDFD9av3MZh7Mrw0WSfjDJbv7AtQ6zovw0ipTJoRgdWc5HinLxmYPq3oRRFnx2J7/LEa9ZDGw70Py9c5PGHsmiJ9QH08RKwrj0oB/33l/AR0DoysgKuNeF7kw2h0FCRI1gSUORNlMjLYhYGjQn3cVS5x12hGnaR1cvXGszD7F120AY89HOloBwVg+cG20r/nhuQXY5kf/qoKEbeLY0W1zbBrbtUpsBNu3zyQ7cSN4xEe028ft6SsNSYl5Iu0FqPtgKK6ucPc0yIgL3Ti7QrRsXehTH94Mh1Jv/KJWfbNfTKp0Xk+z4GtZH3Nky654qYgi7RTZpPWEkjVe8bI0obxFhntlh1VE7OBpfXb7p4XPSf1/2L928vzgaD7tUZfI07/brT7rc73ct/X7/vX3Z73f85O9W/9C+6nbOq30sn75RjUBuecHYD511yEWk4EeXHk8cwUwsWJjExFNNJPpO8VRQPib9kBzdrlFxrV9Is6+aPr1xNdK6o8xKv8ghu97oYHGvEJkiJhQyvwEmMGyTkredukDw0jlHbbiC7990/8ahh/1LP8TlXeTL0FtXGoL8L6le9QCwxev5uCWt5yMpjlMRwHqDpO/SCz/Iv6FivXPfYrIQJ+R6FfpFZIuv5uM4UXfU7+qVi9TIwlJLu1/Q68VNOy7k6HdiHao2UXRHisGnqM9qnEawUd2AThjDy6JApdYaYOVRVLuHP9EqyJk1UvJYc4q0fXuaASsup1BQk5T3qsFFCeUzM95RxFHol8K4N+Bs6jI8lphAPS7xSigS9GTzQIpyTmVZZS+ehq9g3NFTvRrDQjsEIM6ULGtv2NmpF8/h4uHo7fNsELKl0UOkvpKU1Na5iEpYaCVi2fnk9/+h6yrnvT5Lx7fOchMx3iw1espFsV/XnKp1xmQTHJ99BjNxu/eZ7ao8vLpWEzKvhwWqxrgBDWfqy/bsXEmaN3EmfwzqCajPbin6NfLSsnUcYu0EZD3Iy4hCjhRw0MKrONDPNpJCsKg0mTpyX2M0iYCSbfhCSWJByAzqH0+l6ku8nUUTBJFhLNgz7ccQp1wH8nj5BT5DTIKtwHfs3FRQyFR26PNjkuOgsWQG/Z2dvBiX4A43WkQVnD7BNSSjm2wC2qJupyc2KDRjsDPedoblntv/NTQjPfhOhcyQYVLV9t87UKYiBW+orkFUC4SdhGG/LB7CuBNfEBpDktP1DgyvwsahrbVgZeYU3FTgeDPeLQASBOBdpWpBUgW2y9nzOg0lmOh22eDxuARX4/6Zseyh3FRBJSCF1FUcfF9b24G8ZwQYnkAr6DqXMgkOGdRz47E3hBCN9WDCv21eoGGQayQaQG2BhgUGHbzoE1zCOuCWRG1RtSYjXmvA74Alw/KVlAsbUoEaVkaR5E/ueMpI4kXaUqH8mLpKgIloHluGNbM0wKqmwt5UWEZmHxWSEmcaGM4ehn14zbRzmO6jQxpANYEOEGrLGlWiN/F9fbXzo2xe9X1+x/beRc+fGYWCeDWM8kqzDop1Q5qZboiNucwPZXXv7mHc2KWRnIzvP5EIjnE1M8dVe4Oomu7A1UgRlJHEzt/4+OcGFgbeoiIWqma4i79JAts3vPRzimbDdMpvAUoC3ykyzhQ+CvA029fVlXgfuE2/XdbvxyyZmw0kwW0JOo3W0v2ShoqmX1lbeKSaopuZeVqw1IZ9kpqeGj1G78voZGt3aSktfp4mwJL+HtpEi3qChwZfuQTpi9gHoVsmmoF/pJTfiEgiSoEbq7UW0vYjekRsee7Nsb5Z3/2b5K93yPgUSOxEIoZjLpBMGPi6Z8pGTldzRnnw9tLTlra1xuZAJlXGGJNQz6sI5jDPKKcZaFS4AnH8cwZdsOJu/HGprmpupswp15NAW4HPciu2oBqxDzDPs5isOyZPOzDeeR2bA5YVAOhzpIXh/gxtf+YUS+UmQGqEONRghq1aq0tF9B/RCWhsPwmR2U/TQgwaNa4E6AG5AJbVZJNMjPWfMid/uC6jmcXU3oNN8PZOFf1Bh2Tft9uq2wzT2fkN1TCpMX0Mds5lObabT2oZkm+nUwsW/PNPpF5tUwybVWEeJTaphk2pY1v1Vk2qU+LD2CZNZEr9zPryccxb7UqOTkDsNn9iXjPyAlBXjIRrDmI4X95HjaXP6KnaM3gA1lpysw2UHt8159ZpLXlJlc05j+Q7H86RvZlOpP39ypjr9D+niKA9XMonXu2noycLZJVqJyHQVghcNoZ7MarxS67BCSK0kXdXT3g2rpNkSCwhaJiZUR7lRg0ybpf5zS8Vf+QZJW4KkZ6E2esimmxuLy7KrJ1RmHl5As/2jxku5x0ELTmAQ4ga2iqZ5hZStQzRWx8sD0hyadQVz1aGYy0pGUgvYBKgSs/0gBLUPfQIdD34WOofIEyV73Vs92VFqW8c/Cq/S2fQ7P8mNjc33+gPfU60AvqWFejNgMukri6XZCadLZe8S6VtFq+ByVZN+lgK97BJnwfUugWt7jVZNm9jwlYcBXWMsyDE//8gD9x3Xy/JfYQQBShMpPLXtW2UE1K4hcahljZksIuKwDXzpiYjnHI7UJJHJuoxDmV7a0yXCesoxBELfOKRnS9571GtgkJaVF2N4U6OwAbRtSobUg437yB1rHF49rXGaJSti08TzFo0/EseTzssRn/IIDXLqjbmrnnEFpXrK9gdx46ZMoUvukOpo0cZp6YoNXVEcHNKAML6IXD/1D9DUEF/emLoPh6YX0FqOgA+Q/gwTUZN3pcqxaYut+DLvyGffVLdQ/MeA4vZNdfumun1T3b6pXseuY99U/46fubJvqltt3Grj30Yb3xHLnn1T/Wu8qZ6phd2THjsfvLEPK1h1clfVyR3hhPZhBfuwgn1YwT6sYB9WyCzFSeDGoM+fQ59xtb0AOpD361Sm2pEUylw64vaC071wdRmrNO6S0ohPOJhRNV4S+RYCWwhsIbCFwBYCWwhsIbCFwD8IBLbAdIeB6W/JiNLlUuDkDxHybX13fm6kKV2r1w8xt7NlDgfoF+Tih4vz1JdHE7gIk6hx+0/RQLyDjnfKvUcIr8OjOq6mg3M2xlMxTa9U8lcs8iUpjbUocQZ+Z1Ip5b+E03gPPnfGNdid0UJaiwSgdlI10IohdRWaHJq8a7Chf63RddHBtsLn0BCBOWSzlCpkr89LklqBNKueQly4edU5L0+aPs8dVRh2JwX5uKWUnvVu82CX/aI6bhhtqf0mr906nuP69WB3HzPAC8zgcEXpZaiqBJiEYB2Bx1FGZqq0C9Wb45DpdH344EVDVRoqTYaSH7LhBSzJR9RQek6wGOo0O77G9aoHimqo9wpbL4tqUGB8ng5IJ8wZ05CWjMbcPa2UaMkSJ8o3pOz60g8Bh8kfgW2h54jiexjD8l17vPTTUWUeL9IJcYLuyDUC8VYl34U5S5+IXPI4mI6shDUfkAAPo6F8nQHz2AduDPsCGkckC1qEKLvjKUrZv9u9c1jFKJE5qETsRJRNmnjjEFMQvc65/T/PCKu8xzSngNF/i/FZgL1LANsG+v3AFsDCNlBYM8OBptvLih/zcRHqUZbfBing2OAiwOppVk+zeprV06yeZvU0q6dZPc3qaVZPs3qa1dOsnvZcetoPqyetVycs09o5plUjSefmjwLRDEisWw/NXqrHxE2jBo1jbbRcnaA2vKReEnVkUrk6K/Db386svcXaW6y9xdpbrL3F2lusvcXaW6y9xdpbrOpi7S3W3mLtLdbeYpnWX2xvQaOJaZVQeQUbGDHVYPj6z1Z2GLNJbYNZb2JZa6fZ1AZzuJGR5kPg3jkMA110ml0bHGtNMztqmtkJCGCDY21wrA2OtcGxNjjWBsfuKtwvBMe24Uy6EeufDCw6tejUolOLTi06tejUolOLTi06tej0W6PTXuiMLC61uNTiUotLLS61uNTiUotLLS61uPSb4NJcEeonewBtAueiI98uq5rqlENguUbsUsf5LVPyZFQvCzIsLWLHn+NDvCDqQqhyCJsyRtYlUaeWwiL+MJ88Iw3n0CJLqMklZMgfJ5WkiGemQ6AD80ZkqPfyKjfX6h71c37ouhknwBo9Z1anR1m8atjF/kpay9KS2gu5c3HWvuy+ewtF2lft7nn75PwM/j49Oz9TX59dXLy/ODuFv7rvrtrn3dO98p6Ffd0cSCpxRxfdZ6OIvGLlqJWgr/KbzebiwPSUXkJjmbDD+kU/owwGUOTI5z9BlJ7zYIYe5q+O/uvXooM1SSrXd6JFjWU3xUg2P9e54329hzrpngYIBRKOj44qKFjlgBfxO1coZyqjoReVDUlBcwn8rbIt8tdf4baFEQa+WFr9GXwBfcc1fl47MbB1ooVGxkbpf1YVFuMb7jsVpWmuQC0A3Ie79tP//u/8y9vImd88/sd/fPp/rc+fsy/+c6+iYYDYiV8lc9Lfzgm+yifSzEEdV223xPPO8fnYJS9jiDgZwSQu+RE2NmyGUk8vqzY26Eh1505unH4Uopa2yeugSjEacNC24g0r4ranIKStaiMM9d0/SeqV56Nq5s0al04040veL9nQK3s7j+pUD07fU62kZXOksJVoN1cj99JfNf2/virhrY+6OiotPHLH6qG/qYsmFSHCsUsSUMWzASyTw8+Dc3mQcl+dUjcjdcYuuJiDLiBB1uHeq6Mjgus5Uk4cfGQeNCKBEBlD+hSqJrVB+qu3fheSp0qugX+Z2E8LkM/rgloNSVPeonoIZ1EURiXKX5Ypfw8tSxgXhCqSCuh5pIM/TiI3XhAEOOGgCUXtBHf6J0KaPo9vQqB8Dzb1HjE7+GlP22S+eIo/Pe5pZ3RBDSWRB8W0fceZu02y5WRGnrJxgH5hfaXKsA6WZ+1+l+CBpnKAkyonyKQ1nSPscU9xbOJwVAi+kX+80Vvt9/uYRu8G05Cq68djJBXY7ToCVcSOUIXpDc8x7Yb84M0hw4ZwPdrp0/D/ZD+gdoQhZ9TPi+Z//aN5pKWe7wSZApZuWSb3LGzGcRhNiqR+ybbm3gWHXcPvuHzdesKBI3gpoFLGkfQ8pU98z9w7HrChXt2h8ax4DEIcLXQuiQ0a6he1LT4pxgOFX+uquNHRCoW/fvkycgT/EHmPj/g1nKNIbjtQipVvNL15umI4q5jBMhpvOfSS40KpMrpHm0urcRvSsq8ecZ0c6OWQJ7QGSVoYBQuTFk1qOncE+FAEIA8H2uTP7fGYz2OjYon75A7u27PLPXp33DwnhXNh4v88UbBmVOISn8V+fExppGeykcDHx/8PgxeshQ== +api: eJztfetz2ziy77+C0tQ5J66rh+Nkp+b605VlJaMdK9G1HKf2+My1IBKSMCYJDgDKVlL53281HnyJkijZ2Rk7+LA7sUgADRDo/nWjH18bEs9F4/SmEeAk8haN35sNnwiP01hSFjVOG5dEckqWRCC5IMgnEtNAIDZTf+pGiPokknRGiY+mK/VgTpckQhP9fOBP2o1mg8WEY+h14DdOG+dqlCm50OM2GzHmOCSScCDnayPCIWmcNmwPjWaDAjkxlvBykUbdBxKS02ieUcMbzQYnfyaUE79xKnlCmg3hLUiIG6dfG3IVwwC6UePbt2Y65j3jdyLGHsmG/TMhfLU27mf7IoqSkHDqFcdeG4tGkszVoxnjIZb6p5/fNr59+x1IFTGLBBHQ4uT4GP5THO/jb41mw2ORJJGEpziOA+qpNe38IeCVr+uDsukfxJOwwBy+gKR6APO9T7/mluim4WNJepxgSWDqMY1JQCMCu2J7b9SH/w/xwwWJ5nLROD05aZZXGEgP40SSfrSEt6MkCPA0IPbT4CD4OFPffvtYHidqlXEgBv76lyx/pF72eu7zoBnjyNCDSLSknEUhiSTCiVzAS3pZ2+hSr45A5IEKCfvLC1jio5izJfUJ7/w66qEcSW00JgTd6EXMP/j91ULKWJx2Oj7zRFuQPwnHbco6cYAl7IcWjmnHU+1auXZHbVg6xueFyW7cSrCPsP8xClZ2XUt7iM9xRL+o2VVsW/QKmrdYFKyaSBAJB1qshCShpiN/Np6Amm0naBcpNfbcruF7VRsgiBd4BzVzEgEv0/wuT5PmIAWqXh8fr5NVJONTRP9MCILGal8CB63Ym200TIREHosEFRJ48OvW6+PjAsVN5GOxaCLGURL5hAuPcYK8BebYA96qqCyMXlzC493Unmd/WTlQTSx+oGESokD1fYqg7zIldu+XyfjHLiLsl7MdpOcRJA2JkhC4Gb4XrSmWSrzAv9XJbTQbc8bmAUkfmT/tU/wl4dlD/Zd9dveLaKU0NxvkrvDn/I7k/0zmhT9FkPAw/0MgZvk/cSAx5flfQoanhQbMw0GhS8VEzOpnD35XvDaa0fm6DBlZbiNi4tEZ9ZB+M+GG4Y0lTzyZcBD2MYl8gVikPrIgAfFgz9txYKm3s2rgFueU72bSwAeQTznxJOMrBFJenQQhmZbpkSQ8JD4Fpgq9zgJ2j2Y0IGYfcXKZRGPV4+7Rur6PMNK/ILnAEpEH4iWSCET1XKNZy2Ab81bMKRxMhmi0ZHdA0gfyIBUVMWceEYJY1j/iBOHIRzETssWTyHRRQwCoXdbRA3ewv8SRR/yfYk5aOPJbtr+W6U9zHPj1aaaOZ5JwhIOgYmpogZf6mAdEEv8vmWmOueTmiTnHgMyoJKHYDXssg96+Sv2cPFhiTgGmKPasCFniIDm0E9VW9bIgOC9Cp4wFBEfrHyyOA8DUVGSdSKY2afqZoCv0B5u2cyDribq2nP0PNoWT9q1ZgItqNe2CAEikEvBco6dYSj9aXpt+16RO5eoIGB4kvTmFVWJFSVlDXS/lcTs3PYV/4iA/sRzXg3EBTK/Mxi69pRjNoZvaEtvSfbWgL72hfQpEhjTCktXgkZZzI3gNFRqvQyUsiA+MO5WPmntTFh2112DRtypizLlZfdBKUfF5sxHiOAYqQXAXxBTMw2yDIcPT4kJXSIy6sL+2LKkCddAYmHYqYg6QGuMfUV5UTvrvLimenj8YpVv1rmmptRWNYSIDNoBp0iH0egLogm4TQfiHWtLpkyA81RXG419LOqvl4UoxDRIhARSDwGFC1hvgVyakGoBxNBgh7PuciNTok+tXS56I+cTsLS53aoVvTtY32fhXBG2NUh5FwKmiedVE0DmZ4SSQp2hycjJJBen/TUgdkaxey/QskUxDKvVQu+Tpo0fYJFKBlT6oZmP6hRyyfFbRipJwSjh8Juhan1kPR2hK0J/Qv4+wRCwiSNIwwyD/ZNOPqiex10Fhuk2qr9o101MWwm5rYOJ4jiX5ddNYm+DJYIaUzp51bcfEnKC0Xx+2SWFNc3tkhgNBJhq4WKnUnQoJOuh7Tn3DIcD4V5Q2e8pmKyw1gAFJWwAwBkbkNLeSAHbo9nmj22/fvoHSnRkcciio+3mMzuDHnVCo+DFB98VzcqVeqvocMSeestTaPQQ8kpNNRtG115csSEIiamy3zIRb2gRnY2R6gbUNWRJJ9Eqzq1M06YDI6YAyf9oBCYppRLj6e3IQAn78KeNkboxeOxjd5zHS76L7BeEEcSJYwj0i0D0NAmCp2lLro1ekPW830SQRLYKFbL02c9tPbuQ3iZ6NYtmKvfIkikCCpALDh30R7d1z1uP5Zfd9/0NqSLFIdBAECXwM87wuOBNJDNKb+LeCzeQ95qSjKeywJeFLSu6PcmQPIiEBxG3e14Ud1jtB1LTQik8V/elHmL1unzwEmM9J8Sv8k00vWVBjPHgLdS8/wBabcxxJNKMRac057F0fDbpDFBNuBJza9Jvleorv6g0NfXM7PMyy3xsjicVdCSjugXeqvv1m3mrQwPdaqC1MPaAjuNfbrQKDXdB0BXPrXQz07ggCDX1Tw4FhNumdRSVcd4bDH8JwaPZ1L07EIfD6Qwqre6NPAubJPIs7dx6mIQkZXw2nB+F61dYOCNt74/ltwv4LyRxPV9KYxB2gfNaAstm4x0vSj+DPOhPXb6Kbz/q8Gf63+URB70eVqlKzMUuAaZ/sP/g71VCZS8216Mbx9RhHuQv2EuUbaIuWUUjGGhrvTeCH6yHJ4IQB2DkS1unXFh82f89ZEtewPQJ7+qwk7gWbCzSHZtasoSeGAjYXL8mMrb/kOMKxWDBZR7MvbZe06Y7N0pkn1CcdYV8/2v3lZozPyfolqMZE7+BhaQWNiaGNbnLv1F0zexFLoqXopLrgTziRLMSSeq3CWC020y+0UuXiCJl3jbvVulZQ8FSItFlEY7viPCzbUXvPJ3HAVkXsYVx7xO5LXLkBqNtb9vHo41WjCUh93XtskIfubTTp904mhhyBkkhd6/IklhT2A4taPglhVnnUL9poAkNk7YqtxjGT2cvoVcDuCRw3IfX2DGl0qOQf0kgZ1pTcVw4GsMmIv+t+KsQPBw9pbHn7DjmPk7254fvRp9wqK8wwFd1EsrGHg00SsWhF2GizS0kXCEcI7ASws1vkIcaRr0b3qbjbNiv0gUn1AOvvfE/lYtMxpzmd8jH2jB4LQ9wSBHwRAeEFxs8GINg9Ke5LtaX1simENpbQZr7adlTO+uOr23cDOC72n7ejy4/vL/vj8eC632iqw3Tb6466vcHVv24/jq4Gw8F/98/tk9HloNever528s7BlTKEE44W7N5wEW00EcXzpeynmPMVYolUDCXVNwtCuIriieIv2cHNOoW/Jltp1m2Lx1d/zRDPN1qxCp8rEZKFqDscoME5TCMRWsfVwgsYXomTKAeqKSgfirde0Ch5aJ2Apt0Czh/SL3DUYHyt44SESFHYopZX/5dQ41ovGuM8M5ghBgZ/4jeNg6wkQoJQ5mxJfLQkXOT8proh/sKi0vDQbd47MTM9UQEz9DWqjr06S3Q96sHaQH8RkeYaVHUgkmlE5GNOy4U5HTCG6U0puoLBtNXSZ7TPOAsRwd4CMbkgXHmowRIoZh4RzcUE8RJO5UqhracgzXZogNjgXFHoE7BVgDpL1Fszysk96K88UU4I6uKERZKzQM3Cfgm46EKS49mMehpeiIch2Dx3f4d34wf1ES6UidZYSmNGDfueiYd6V3OlfnKMMFO4ZuLh0KukLd0L+gW+Fnp/Zk23MRPkY3ROAmI9Ceve6PjQRsObnGF1QaJKnEOFaaB3PvFOfiOrEa5zAQtf746AQxnl2XWpB7aJlHPfnyXe3dOcBJwh9PEbNNX9mvGo0Rc3SXAyFWcB8+4O/XSZLb78qTR63g4Ptot1AxjWpS96tXytYdaU+iPCPRJJPH/ULaaVtTGnHlGLWpQRTYQFwmBcNINZZppJId1UG0uwLErsdhkwKnt+xJRY0HKD+CiJJA003084h00ooJXumAo0JQCilVekFgDEV5AzR1ZedL4+Pv4Prb6SmdCu4fscF33VIFBE7lH/3XgN/pBZLU/4vvVgL/WBBue2m5rcrNxBjp3Bvssp8Zndf39rwpPfQiDzTo6qbkjrLJ2BGLClvgNZayD8jDF5KB+AthpcKzYAJKf9N3NcgXiiruHB4KyihmltkXBLAfORKIvgUTAFfONTBbaNujF4E2dm00mHSK9DPAH/a+u+J3pX0UgjBetlohxMUDeQhGtfDSr0iyFegQBJArXtMApxMEsi5eYGLxbV/AoVQ1lJsgkUJlj6wPhetLGCa22PhR2N3Pq9cUdDvI5PliQAtVkbKYgnWqpTo/O3FzIMjL0Ec+sPUf9MXCbRugETHPze6d5y9iUB28rbbtZS8LzACDONDVYuZD4J2mnnVCgOWdbGgA1ARwo1ZJ0b0crDn9/ufei7l8Of36JX7zleUsmi/NnIzUeT1SybDJuammod8ZDbx8HOm8eia4naaqlPibY++ZcW4exjhs+QxChnjDG32OUIPYug7JX0dFXY+plz6NG6TdrciGe3ZODHUIiIyLkyvFe/I2Xl3NOb4d9+1e9u9l7+zd62m90XYl1313juGu8FXuPFnMFOrYO9C0LHtLMqS11/rkIfxrEr57gFKhvHgXXd+sKiGju90Cc0UaDISIvNY7Tw5KhoKPT1AqVOMjPKhdQ9mt5UhOeUgId3oIzSxlqmgF7X80D96oeYBjUc+nUjMEoopY1AMwVtwGVHmyq0UCuYZPeCTUMMxleDmuwSRK9b0IePua985ApLgO0ilJy98hbP2mbhwbk1CWhLrjL3WSdvk4UgmueRMEgZ40dEfGQVtVTFuR620c2naRLJBF1cjbPDoJh5W6MlpRYYxqFOSUeNLjpMtEzahJ8S1cdtIMURMtsnTqYBBBqrd5Vnc6oxtgG/wS1Ni+gjnFfkMLo5JyRGFwRzNbnr4Ra6fELiVmBebS3DPIE/QbDQrbFMiyMVO2RWTqH83qfzbmmFqEDppSYOglUaG9pGH60du4nGiku02D3cX3lahzTztE6UeImpSgKg9bdZogJPOQkIFuTRakRxDz/NFdmUMXlOhTLTvT/IrQda2g06TZV1u9ds9FI/mtMoc1Zoo0nspwdokh4MOEUQ6A0G7cI5+scxen9mDYL5Y/QXKiWaVR6qlOQjsfPu1fDz81BJDndE3I3qHVR0UPFlQsVditze8ERzjOuhNpBafDI2vPX2/ETcLt8YKLgJYKpHmsXVdA3To9pGOc+w66F1B1P3s7VudSmXCQ7slW7Wq4HFIpmmr9cybyva8q1sTyGO8Jz4A5UHRa7qdAbhiS0sBJ2D3DcdmEwqcrVGa2mEXkBJVEsvGJZ79lRTa6cvJfIxfnyfK/PXbArfZHPUjXCwktQTKE19Y0cIWUR1fgrb+xUcinoXucamLlPOCQioMKC2WmKJeywwsdv9yFeXLLu7P8cSIy9tiIhpqd0jrAdisffLJKi1LOW+4dbcrknA5oizRNpFeQTaKMqlO1LhWbNZ1uStskMct/uR5KvbsXrY1v+5Xb/HfRxqsW7aZWNqPivMujH1/W/99KJjj1h508lvyVS5TwDJBSDyAkGQs9m+BJstWC1IjZ1W2NnaFycOcETQp8uLVGhbAlcs4S1IzgQRh6DxGvEtRNAjvE6eg/EF8uBUKF8uBfNyAoTYqKLIsDylGMNveSpzsfbA0JWs2GueaSvFStM0R1n4Vw4gGT1vkoe044JBaK+hRckslHOms9uoZYLZwTfDeA+vxVsXqALU/bQkmS9gQbhlm7B5zTlfX7Q0I595OebavXP9ireeX/fdL+InM3Ar15fZbzqkoBdgGtbDASOwuwhILnGtdHXVVAMCdYmOBRxH7b2pO9+wOZrInAkJDtAt02hifB6VVw2aXBLsf+ZUkiGOVhNr7gttAgczgvICqReRN9SeHxCXZ0wacToha33w1JQ2zCa/ezop0Zol+j3QPTS4Lq0a85GnH6KYBdRbGb4Ht+KGvynUl/nesuhWJGq+SpDe4xX8IyLAjH5fTzf30IKGrSVWqTZEnR6MSB6ldI8UZfYojJg/jon3SHeLmPlpQPCGUDBrcGU+GSsRzfhE++OC52JE5WqikghKiNWUea9Y0L6pjwyl6F/d4QVkVTX54ITEXFlOFfebgOfT6SRviX6aGVa5AFpeEDP/r5ifs6w8c8vK9woBrRVQ/W+KAV0PAX0RV+Cl727gYwbtCsrWX57GxZl4HSPaxohqGDPr3mlfLYrGA3Pl3ILIipa6Pta5FdTTemC03KWaWx3z8E7j9TeT4rzijidPYaUb2lpGHWM5sTFNGhr8zc0eqXFoP7+ClO2/0ut1pPi/nrnK8rXZi2EbKwJv9hqn45Mox1c+0R1oyUlZeSUXgp6KA3pxMspb0Oqvn16p3uhTLmuxMjorD4UD3Bkqiax0cnhrvsMTuboIsTjHJKwVaGNuZyDYxVdtTBjwNJnP0/gvsRiExViNjQk1rWux9gqwcTS6a21Ihq6HzD/IY/0cGqMAHKjRq+PWG73HJWcJ5IRdMJZakz0Wrx5BNDQHfJ/ljU4EGXG6xJJ0dZLDmoci1o1y2REJ5MkOVuhVxBB5gJg2HKDByBi9AjwlwR536jsjjjZFquqBUpwG/9BHII2zajtD649haHU6z7PVeZqNaCauII1ZjS364d0Yaa0ISdVEZx5dYEj/YK1sps+a8V3QZZhZ9tZDupwe8sz1EOdqUkWb2PO2YqyCP1cqkrzKrTbNnAwh7yA+oiofP+uyJ5kVLvnMhpx4LAx16Bwc7JgzP7GX+umuTjNfK4eQGh4ko17qPZIeJh3EX6+DcfquvqzI+T5fj3p5UZCGXJEQ2GGN02qXVSELk4d6lgTBqvVnggMdbcvJjHAS2RDhm+thznXYjFTbUdc0bNmG4qipJgQJMVSson1w2ulM4AZpRh+a+TuynSzgn2wqfoSFqMmsNrhKZEV6Tov5c5+Fe+cTJRPYBO03ZhTYlhfogIS3OvXoSYV2W05xu5/b3XoqV9uvfNOG2j5J+F3DAsC4VTdVzHomF0vIjfFqD+FuSec67Q4HB2cIUz//ZHzgWjrAuGWsEy01tRYO6VHm761MMqp7GFfnX58SnXlA4Wqgfpf5x6l/L1/9eyGKkNM0nKbxAjWN75RS9DHRUph7CyqJ9oXIZWBYSxYHrGst2fmjo6s29nxwvqdijZwNkY2PzLZSADXTwq2GTbZSQjQ6MGsyj99MSuFZ4GxsYEYBXo04g63Y5TUvBSeDYsOJytNuR9A5W/JQjCEsBNCBdf75+wVsfONkZCLM0jRHNqxPh/ClSUNURr3LD9p1hkQsmS/K+d95EuW0zDqITeuY1rU8y1QSYI8oBvtK0AguTHSX1r/0iXLIjStyx+Uzw1n1N5dO7NnG1pVqk+a0rzE8cUXcnjWKdUXcpCvi5oq4uSJu5YPiirg9rQXQKavPWlnVRdwKNd5PXaidMwE+VxOgC7VzoXYu1M6F2rlQOxdq50LtHIR2oXbO7fTJQu0aOJCY8kpVqaseodHZ2FmOn7Xy4yzHznLsLMfOcuwsx85y7GDvLstxIGaVcGhwNkQX43cOCzks5LCQw0IOCzks5LDQZiyURFS+Y/yChlRWO+rFhGtjj3qnYgH1O1dY3F0SZcaofsehrheAunRdgLUkMTqntfrZ3dP/APDsGd/T1w7SMynk5/nSQhCRl4hJlvNhxFiNOkA6K0jMWLDDsg6FXqDLUnaXzcWDrR/0+lVisR5nHlTCtSjKTmG7UL+wWGrGFsPVi1FKboL8BGZbebGlGpqbyu0MYBnuWUhABSXmHeyz1V2/EssTbtrm5XRWh+CtqkOg5UPYK13qH3Chcj1MuUCevs9QdxvWWHg4gMWjApmCQ03Nyjl8YQFR5qpxuAayoGfJIHDAW5irUxYowDXn7F6X5SwVDPJwoGM+jnXh7yRKIzrhzTE8rx9JAk1aln67n3OTbBxYsfxcFyo/M1JEbyo1OUX0pjvUUsXyNFDnkswH/uNig23ID3ABIXmhnkKpGmn3i6K7VJRUsjsSnVtZuHOP2zetyjPujpHqIh98YDlHoeb1iXEu0CsBAfAfo17qL7DOHbqFDeLnV16BeM3F/2KPA7jZLHscaFKBR67NcBdc2jxl2GQVc66OJnM49lnjWBckeVjln2dxqb5XhZsoCVQ5PI2kqoL7dHFDjG7WCuvo8jeHZSLIVKg0F4Ht9whhKbG3yCq35wEMcL1mCn3S9Vzz6WSFVqr6eJqZqlaAmpqHJboyUE2HJfaeh2t27SSvOqNXah816F/v37RSJMrSdwh0A/UAORKSxOgtWhBee0sX9oR+q2V++0lL+xYkJsn/3sqJnt1pR58gA7Jxe4UaRJcEDNGURUYU72FHA/TMIecIBks0pINUljQD2ozYPfkF+XilQKo+FKlbqMeE7CQiTay2O6mvk9DPWkLXYVHkrjpupKuSuqD+b2NX58kZtX4Yo5YLPnHBJy74xAWfuOATF3zigk8cSnfBJy74xNV5cnWefgxG9IR1njLbXuOQek7QPG97sDWddtRrqlP06ZCaTsm82nz7KaJLjMARzaZFd97Sz9ly4bylnbe085Z23tLOW/o7I1EHFZ81VAQfZmjPIlK68gHgdnaA+7IxuG12YVxz1wQWyTfWUFh7XZv7HuPG1j8bG6Ohvl1VxsVXmluBfRAkTgeMjaed1ElE/W3M/X/b6/pcGY17uHnPeaaqfMlTkrrNbSqqsZ/YyG8SPRvFsRV3tebDVF74sC+ivXvOejy/7L7vf8iqExmQNgiCBD6GeV4Xm6XuC7eCzeQ95qSjKeywJdgByf1RjuzBI4uNVNGffoTZ6/bJQwC+FsWv8E82vWRBjfHgLZUAWzI05ziSaAYVPOZclwgZdIfldNibxXoK7+oNDX1zO7wu3jJGEou7Ek7cA+5Uffud5q/vtVBbeHpA691ewFup9xKUE7oY6N0RBBr5UuvLa5jNIz1Z3A32S7jB/l7G5K17+t9rS26uG5MdnnzWeNL5Em/wJV5GITE+p3sT+OF6mFX7zm60UxLW6dcGn+9T5OVFXPfY3TKOcCwWTNZR7EvbJW26Y7N05gn1SUfY1492f7m9A9iMhaGNbnLvHFwVTntipxFTrcJYLTbTL7RS5eLIRlcRkWKcolaQt2mDBAWriMZ2xXlYtmMKxscBWxWxh/EIEruj6OQGoG4dNcajj1eNJiB14GklTJuH7m006fdOJoYcgZJIue/yJJaqBCKLWj4JYVaFUkVtNIEhsnbFVuOYyXyNwwDcaZRnr/Hap9Ghkn9II2VXU3I/LZEDvvobQ8asPe/gIY0pb98hH122SWOGqejuCNorWhE2muxS0gVUFAI7gQrtIw8xREXC6Kq+0pZZoQ9MqgdYf2fl5LHhmOcLWH6Pkp3KG4v4aE0bNdW6AKGNJbSZr7YdlbP++Or23QCOi/3n7ejy4/vL/ng8uO43muow3fa6o25vcPWv24+jq8Fw8N/9c/tkdDno9auer528cwKe8XDC0YLdGy6ijSZivRSYhzlfIagOCwwl74uXCeEqiieKv2QHN+tU+fdspVm3LR5f/TXrVgI1bkl1i4HmPYsixVsvaJQ8tE5A024B5w/pFzhqML7WcUJCTLCs3aKWV/+XUOOaeloan69XG1W1dyUIZc6WxEdLcLbLgjCtS3lheOhWI4biiKJQLnUZe3WWCOpDm7pbps4V1AJrpOW7HnNaLszpgDFMb0rRFQymrZY+o33GWYgI9ha6iHYTGVVGMfOISOOX9kQ1vyxpoqL2F4PibHAxDdW+1Vszysk96K88UcHM+epgMAv7JeCeC0kOXmuehhfiYVjPT/bd+EF9hAtlojWW0phRw75n4qHezVypnxwjzBSumXg49CZpS/dQCs9Uwjs0CjuVDiZCVltZU8MqRGLXiMI+uI5gsYRgyrmfoNSz3W5Z8bfNVZ43SXAoYBgw7+7gCoapLb78qTR63g4Ptot1AxjWpS96tXytYdaU+iPCPRJJPH/UJaaVtTGnthZ6QUY0wSkZg3HRDGaZaSaFdFNtLMGlmtPtMmBU9vyIKbGg5QbxURJJGmi+n3CuPFqhle6YCjQlKjpyQVBaUFFBzhxZhRj64+P/MJ6pM9FTFwf7HBebKiMi96j/brwGf8hM1JEF/Qcq1E10qQ80OLfd1ORm5Q5y7Az2XU6Jz+z++1sTnvwWwgZa5qjqhrTO0hmIAVvqO5D1pJVMzwrFSwsVN0UzxxWIJ+oaHra6f8MtBcwHogo4DgF2ZmVQUwW2jbpxTCI/M5tOOkR6HeIJ+F9b9z3Ru4pGGimkrm7gX4K6gSRcu2pQoV8MscqboQvLI4xCHMySSIX8wItFNb9CxVBWkmwChQmWPjC+F21d1h3ClToaufV7446GeB2fLEkAarM2UhBPtFSnRudvL2QYGHsJ5tYdov6ZuEyiCg9iFqF3urecfcn43m81jujI7TwjzDQ2WDmIMAnaaedUKA5Z1saADUBHCjVknT++hHGuanEOvGfz0WQ1yyZDnaBmg454yO3jYOfNY9GzpJSi5S8sI5vf+nuXkS36LuiKtH/zKNUnAnKbDAAb0dw2m8wBzgb62jevnG9yL6CPvEa3/co3bYifTyACs1Th2gQHlhrmldDamrpyYK6ppq9r0ZaQG50bohVCnJC+Z+4OBwdbZ9XPaZ4MzdxbIQaKSEtNrYVDepTOGH0SxFbN7g4H2vVtSjTqU1IZqHc3zu7G+YXc7LgrZHeF/AKvkL/Tde5jAC/m3oJKouNac+h3zVAPrGvN0ezRlz8bez7Y1lYMT9Bh60okPaGmWwA104LaaxXdEqL5xzF6f4Ym8/jNxNrKaKasGphRgFcjzmArdnmdHE+g1Q6KDSfKRy6fUrQIxRjCQgAdWPv+3S9g4xuPT0V+EqUmpqZFH8pmlSps6jbj8oPWyUjEkvmi7HvHkyhn9K+D2MbqTWv0yLTEAHtEMdhXgkZzOKTqRZsr5Ins9+MKu33eKm/uMvKm3L9Q2dIa0qOVLZf5zGU+q20TdpnPHBh84sxnGSd6zxiwdus0oHN5/M35kXWS3T2WmZ3m2qlv7Su9JEdK3uXSFecMMHCzw3FgTTDb+ARcF9XYA8qisO4BAWDmnAp1F/j+IN/h0i2AQkMFr4LigF6cjPLB3PXXT69Ub/Qp/TjGBUqZUepZp4b65czKukZk+hWi1y1hEqu33prvEHMGW7AOqimQbtrZ6y8hFueYhLVusg2IBnDrqzbGz26azOepg4VYDMLiZejGgHWrTGjXE4ubddfaeg1dl1L3194M59AYBXBDgV4dt97oPS45S6YBEQvGpKXZY/HqEURDc5W5HeSRDWoecbrEknR1EHHNQxHrRrnoYyIQoCr0KmKIPIDTCA7QYGQsLgGekmAPcHewJVgPlNpj4B+l2gUHZBZwVr7naOVzSYqesW0zmgmtmeyewYd3Y6TTGCGplRkV2b/A4F8t0vTXqs+aDhTQZZil4lv3mXBo+1mjbWd6raZN7JledKxMXyvlqlnMLkpCTIMsMwn4lIL40NLSmlBMBiJ7fyiZFS750GFOPBaG2jcFDnbMmZ/otLG5U5je7CjDUz3HW2ulSg+TtpXV62CcvquNqWDdM2DgetTLi4LUp4GEwA5rnFa7rApZmDwvsyQIVq0/ExxodzZOZoSTyPrg3VwPc2ZLM1K2PxT7bc8VvFYOMuYsqY3TsQ1btqE4aqoJgce5cgayD047nQmkfJ3Rh2b+qngnC4C6ND/CQtRkVqk2vF3Dfxa+HQ5Lv3wsvc2W8kIQp4N0DtK9QEj3RNa3utdJhT5KJTTXTbRfWFRjpxf6hCZ5sLV5jBYu+8wZoJmmO5lRLqTu0fSGg3iBp0SVilM2pQpY3AdoWwO7VCJiwAiQfGXTnft+foMFy2yVDfb1d3Ub1EWyVJiYsjGqwC2brQ/YIlbxDDmfZpAyJiMMKOfG5T6FkNfDNrr5NE0imaCLq3Ft2Aajiw4TLZ9ITAPxU6L6uA2kOEJm+8TJNKCeplRfxqW3m224HAaXi5YpyJl3ycfo5pyQGF0QzNXkrodb6PIJiVuBebW1DPME/jTFgtyaGENxhOBPs3LKN6D36bxbWiEqygU9FUQDkj/aiETrdtBi9+By6eloADNPmw4LLzFVJc+0J/4skbrGbUCwII/2jynu4acJdn78JQu0tBs08z+xe62khGburZPYTw/QJPMuVb4eOjSxcI6000rRXeWFeDy42t5OQXkmCoqr7e1qe7va3q62d52bY1fb29X2drW9nfnnRzD/vBDjrKvt/eja3mW17lncLbn6T47pO6b/1Ex/bztzqqUpb2WrNmdq1olSs7Zr4uqRxtk1w/usrm7AeRbddz20vm7KAaNWojXKZYKzyKQc5LeuH+nrtTLOKNryrWxPJVFVpzMoGNTCQtA5GHDXpFKZ1j2EYfm6oFLe2SiyYpkiG4v5mfE7VUW5zggXbI66EQ5WknpCefHoAsxmhJBFVDJu3ZkDNr+CQ1Evt5pJcyNTzgmaeGFArSthiXssCHRp6X7kq7xHNbQ0LDHy0oaImJY6FYKNIi32fpkEtZal3DcksrNrErA54ixJfbwfYTYuyqU7UpHscrOsyau9Qxy3+5Hkq9uxetjW/7ld16YfZ37e5QYzOBuii/E7V6PuWZuVXY066WrUuRp1rkZd+aC4GnVPqy0nEZXvGL+gIZXVpvCYcB2cot6pWED9zhUWd5dEBVVUv+MU52etOEM1vHxmgyDhoQNZDmQ5kOVAlgNZDmQ5kOUKAf8Y0Oe3ZKrqW4AB63kkdnKejj+2p6MOdd89xcLO1mnZ4gBHBH26vEivcCyBK5bw1t0vogXYAxzZzWWOEEGP8Drwc3yBPDgVs/S2unh7rcu+RsYArvzd4bc8lTkIpHyK4OZgr3mmrZSwszHEOfiWEzjGfXuSZ1bjPcOfc0OX458rQkJbBmNA8QxT3m1NDBaoAn76tCSZL5BmxjbgEDavOefri2bPc8+8HHOddGU9B389R4m7X8RPZuBWri+z37RHQy/ANKwHgUcQTiEA818rF3zVVOM65VKBBRxHnSnLJFer3hxNZFNuQ4W6lmk0Mc6nKoE5mlwS7H/mVJIhjlYTG8UTWlxtRlBZJuqVTB5mWSYMao/TCdmgAk9NacNs8runkxKtWaJv/OzWHQVHzEeefohi5YVn+B6gt7/YP3CU0p35B2qnbB/iwWtfFFbXw4iZn1Zs31Cr18ZRMZ+MlYhmfKILpkFpqYjK1QQ6B3BKIynW3ZMNpehf3eEFEpInOnGskJgrDUNxvwnkDT0t5F14mhlWedNaXhAz/6+Yn8PMzxozu1xKz9h5svTdDXzMoN0mJ0FT+/C3cQoT9jAQO+3KaVdOu3LaldOunHbltCunXTntymlXTrty2tWPrl09W+3GhVP9CIyoRuDQ/lUz1ZQ1JK0HOlU1ys/jgu1BzWNnwFeduCy4Ad4QLZmncntizve/9Z1ZxJlFnFnEmUWcWcSZRZxZxJlFnFnEmUWcNuLMIs4s4swizizyohjRE5pFwLaRNx6YTKQtiOBpqVTkB5lL8l1aU8luS8hOc8qjTCWfIrrECII3bI5lF2H4nM0XLsJQughDF2HoIgxdhKGLMHR4sW6EYTeQmHI0Ohs7/OPwj8M/Dv84/OPwj8M/Dv/8GPhnyPDUIR+HfBzyccjHIR+HfBzyccjnhSOf0uexTS4YVBVOGf4aKHJQx0Gdg+a4nW2UTgT8CuKBVJxdsc2fq+1Y0N+fBX1v3LunSBztJRLblc45h5T4KdXJsaW+zemsW/+ndCjTeuG3tnC5qRBUy9tiA6WmHNDyBC1NiRofilLSaaJc1bIqQYb2PcoH7SbfFhgynh7ZxlKfJyt46WNJerq+R9U3T6EpvNcCYLn2IdeElqkkq2CokDiMc5VCmkgQCYVE9ASPjMYl5KfYf0IaLrCQKFFdbiBDP/QrSRFPTIcAL/G9yDD1USv32vYRbflW8J6ViUCzAM/rjKhfr5p2ebw1g87GN62rd++y370afHjfaDa6193BRffsot9oNs77F33zc//y8uNl/7zRbAw+XHcvBueN9T3bj5btsaYSdnTZg5lz5ZisZ21U2SrX5ULVmp00VhAGGh0R8E1htUL8cEGiOfjmvz3+3z+XHdcVNKMh5qsa37IsHTQPbTStmEj1i8rFuS2c7dsGINaGjQwpkXpyfFxB6TZnSU6WVBg/uFxHrys70oRfkYdqr0kVEbHF4w5iOEKxsfkT+G2GmOYe71wYAgWTrG0l9/YvVS8Lb0FCXPG2WqsYS0k4bNmb//mf+Ot7juPFt//8z5v/1/n99+yH/9Wo6JgTkYRVuCR9pu1RumxVflInVdsyCYILqBW+oVaEkMn0Mqmq06sCDJQFYG2kN1UHgCdR3bXTG2fEGQjBfUpBGwPbmHicyD0bprXMDmoNRouQflEib309qlY+3+IK8znZUNFjTyf5wxzcU4NnWjy7kpb9YcJBcj3/NQrV16rp//ntGvZKa9qBuYxw6pmSeDMKep4QzKNK/JmIQSpMpFrRhqQPUuGnczXM1JyxSyJiFgltGmg23h4fN9aCos6wj4CdwxHTZc6NFgcu+8aY2/lDaJ6quQb8Ky8BrKD5fVfYcE4irW9RO4U+54yvUf5mnfKPMTEKQsRMrBrxVVeCeAmncqXk/xnBnPBuAjv95ncQyiGRC+Y3ThtzomhUMWsNq/N+DQx/+tawcadCdZTwoHHasFgXx7StcG0GeNeVefUEjYxENHXpuqOBwgaWyjEsql6gPK3pGsGIDcOxFYdTLzWa5h/v7Fb7416q2dNoxlRzW11FUwHD7iLQREwJ87JSUTy1G4qTz0+ZhJgGaqfP2P/JHoAGDUF9apzX7dfHJ+1jK/ZCHGVaerpnkbmo4MRj3C/T+jXbm41LIjklSyIUfvKJxDRI4ZSxC6UHSoFIeDCnSxKhif28k3YmviR5kKCuUCU31Fy/mn1xYzhPo9k4tU1hp8NFBjz9+nWKBfnEg2/f4Oc/E8L1vvOpMKqYsv9umc42brCJRlVcscCGUotFQ+0uq+vvScsrU+rVP7KfQx/RGiRZaRSt8rRYUtO1U4gPZAAw8RtTJrLR9TwSy1zDNfZTOLnv+1dwa1s8KKWDkUf/RaK+ftVvXLE7En37ltIo4W8g8Nu3/w+AcMk3 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the launch identified by the given `launchId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-managed-identity.ParamsDetails.json b/platform-api-docs/docs/describe-managed-identity.ParamsDetails.json new file mode 100644 index 000000000..8ac81542a --- /dev/null +++ b/platform-api-docs/docs/describe-managed-identity.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-managed-identity.RequestSchema.json b/platform-api-docs/docs/describe-managed-identity.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-managed-identity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-managed-identity.StatusCodes.json b/platform-api-docs/docs/describe-managed-identity.StatusCodes.json new file mode 100644 index 000000000..5356e263e --- /dev/null +++ b/platform-api-docs/docs/describe-managed-identity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Managed identity numeric identifier."},"name":{"type":"string","description":"Name of the created managed identity."},"platform":{"type":"string","description":"HPC platform type."},"config":{"type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig","description":"Platform-specific configuration."}},"title":"CreateManagedIdentityResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-managed-identity.api.mdx b/platform-api-docs/docs/describe-managed-identity.api.mdx index 8b7438473..82a969667 100644 --- a/platform-api-docs/docs/describe-managed-identity.api.mdx +++ b/platform-api-docs/docs/describe-managed-identity.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the managed identity associated with the sidebar_label: "Describe managed identity" hide_title: true hide_table_of_contents: true -api: eJztfWtvG7mS9l8hPFgcG9AltzM4m08ry06OdqxEr+VkcDYYRJREyT3ui6bZbVsT+L+/VUWym92tS0t2ZhKFC5ydWM1LkSwWnypWFb8cJXwuj15/OvKmIky8xBPy6LfG0VTISewtEi8Kj14fXYok9sStkCy5FmwqEu75kkUz+jPgIZ+LKdMNLBmXMpp4PIHf7rzkmgrNvVsRspEu29NFe9NR66hxFC1EzLGr3hQ6O6Oux6JfLAvlFjzmgUhEjAR/OQrhDyhfaRNKekj1gifXR+Wh9MvUhmkgYm+if5h5IkaSYvFH6sUC6EniVDSO5ORaBPzo9ZejZLnAXr0wEXMRQ9FZFAc8UT/9/Oro4aGRkRbF85ycP1IRLyv0vI/nPPT+pOGvoWWXvn9D0uUiCiWsI9R48ewZ/qfU5y9QdRJBK2GCX/li4XsTIqH9u8QiX6qdRuPfxSTBVYhxvYhR4Ks3rUPYXqvw0NDzmLUvgQ3DeaW1d1DKcOMkFsR5Za6k5hY+T5Cy7U3+e9BlpjTDolQf5mzmzbdPyl0U35x58fZufoWCbAqMNkmieMmQYxl0yST8CeUZTmgciCnuJoatzvzojs08X0g1oFhcpuGQWtzeW2c6ZZypX2CyeMLEvZikCexrL6TZC2dNn6fh5NqUWsQekJNEUOA2ukGS3on7hKiAIU+EBD5rsaEQ7NMgFoyHU7aIZNKM01A3IX87vk6ShXzdbk+jiWxJ8Qfs9pYXtc38Nid+lE7bquM2n97ycCKmP8HYmtBe07TX1O2dqJHDr08zdD6DOWbc91cMjV3zW+CpKFj4IHemf8tIRXjrxVEY6M2qx8njmKM08RIRyO0cWW8jneddsVsee3zsA09AVSLklvvpvo1QXWrlWnBbZIyjyBc8rC4YyKQlrJQn80aADZFJs2XCptjv0VjvzWAB6/lETevWsHXcaQ/2ifBJzaaZkEbxT5DAIG98JKBL4gLm46PuBuncPlkSqZEiMZvS0GIxghKOmthuWSqt3wMe/pP79jixbqqOX+wXz4Kl5vNSKZI7+/K4Ibap2mpiW4q/px4SGXghB6G3fRQDWyqzQmV2DMJ/2oxCf9mgCRxzCUcADCwT5VL4sD2gpRN1yvPpeyitTvmHVcTobbR8p0704vcGgI/FAqmEkkHEx83CCaPZoA8fihMNFcvbFeTP+xnBmic6WrLFuyueMZFmKj+VIPf+IZm85sDWtLhMLuHHoMX68JGNUcoxPpaRj+xHhxOKPThi6VDlgAEDLEhCkqb+LgZ5xPgEpac7oH6QA+pA5JAqWWtvnWW76e5axNaxAXMjn2j3sN6MRYGXwKo2QOWa8dRP6GQYaREwIqpTKeJ3tQ73D1ASTyoCmMPhv3E2QyUMsVlEvHSghtFUn9Sw2vWa/jeUpKah5d6A8ekUlBBSEKutLqI42aoyvHxR6QMpxrotdqYm4zUbvXgxyjDF/0tFHXRyda0QjdEX/sBqJaHIUjw2YE60qCkgA7UtoTEbdezR+cqOoc+7aw+6XHgL4XuhAiAMBDST6VhxQ4t1gbGAvaJbEcfeFLiJjZfUTFarsJ2I0IDfE5FD70+xz/RfkaZ/7wVpgMraGIiFQRB1+fYEuhSZBk+pQUqo5Sc8FFEqcVPnC/j82bN8Bf83Gr+n7uROMkT3GKmqxN3rUSIepnwO2tS/13W4DjXCdiRTABsVaR3R6sBuVjLLU5xjU9DMlm4FrDQgoTOGkfJJ8hZWVAtSNCQUD/8doZLBLgpPIvAp4EktTTPIUsFDTvc4KN0D/u83aIzfyeaYJ5NrG6N2fh2yU/xxK1Atri0aKvhcXFGhVasD0GGCBpmMpVDSxaI3rVn8Fo7PQMga3KdbqapYp0OmW8GpDqIUmONYiTsQQW085tp4PL9uo02Mg/yM6e/RXvrJ4zddLOaeMsJtkYGwZqqshiFw6EZpDOiB3XmAFse5NexYtOYtEF2pbAoOGO65Httux5fNJGo0Sr6jyAXkEyL61kwLVZEvwp1bzls8u+y8PX+XWb0Miu/5sJSwGPp7XRwo0wWiBzH9LKNZcgcyu60obOMxeuuJuxOL7F4oE8SL6/m6wGHdF6B+qBpKLV1Ff7YIs+etF/c+j+eiuApwplxGfo3+sBTrXL5DFpvHHNh5BkzbhH/Cf6as1+kzYMHAk5JORCi1TraAhDdwpl7X2HZsusdRnneHLOHypoSLdkBkq9Z+vajVh+/XmqgNMt73BnihsN1AgUhfN4Vj6170FHf4vtJuMrOOFjbU/Fq93inRP4QSrfm6u0jlPvD8XQbJu4MPEscZ0Tm6mad1p30RgC7bH+/TsaprOkT2Xrt/G8h/gZjz8TLR9xcOXx4SvgQpBhvpPMQ/68yDKsk+/aq2nxaH6zcYtn5iq48zULuEUiBnKcrwF7t3/oYq2ubPtf2rPoCCSzVfkpUoX0NbeAscM1RIeWcC333sixxdaLxtkVClX1mzovnbOEoX23m6i9LqVzqAL6K5hIMSqtEuzgbGoDV5SLY+tZLDkC/kdZTUUf9L7JJV3cIs7XnqTUVbmuIn21cOBjQX1Ut7BZHe4MfSDGrLR4t9ssrUnTMtDJogiWU7Uw1/ov/fJFKaVhEj/E4YT5MIzgXtElLVDKzCdIqCsNH4rki8ET3EcKD/+dGyiD+0SUu2tuqiyRqwLsI0QMk2HLy/gj8BrVc9XHo2fG+xERQaaXIkS0O6h49TKI1MEIXNqQhwVDbyhwUYYRd5vWKt4SJK8sLsGEYncI/JRPEkKDX7nv59LyTDHJ39MCm3HnIWej9svkEM+P3eXWpb4K5dzhfpziLw7eCDNcuEG8ayAww4nHB/3alYtCSsteZlpEs016OtADm7Ke4XsL7UO+j/N5tGxd7BuuIHrtaZfJ7W7G3P0isfY9PoRkHAm1KgRxSiPN+TCYI/hGF3osiXxNJq2gilDROsM19u2iqn58Orz296uF3MPz8PLt+/vTwfDnsfz+Fn5PTP3c6g0+1d/efz+8FVr9/7v/Mz82Vw2euer/pe2Xln6NAV4A5n17DflRRRhhNZ3F94VExgppYsShMSKJnOWTh5V1E8IvmSb9y8UfxrtJFmVbe4fdVqBnAUr7NkFZYrhXM7YJ1+j/XOcBipVHquOrFQ4JUkiXWFhLL1wgvT++YL1LabKO4D70/cati/0nMCIRJZYFFjDPqHpH7lQky8mfbyKl4uYS0fRXmCJzHsB2j6FtAMnS3qlqQT8D/hr2L32KyCCcUeQfBJukJRyHoxqTNFHwddnBtsLxQJasNQihqQ6Rh+ecxuudC7A/vQrZGyKyMcNk19TvsshpUSHJgwgpHHDabVGRLmUFXRBHwXe8mSINZTkGYa1Oird0YUTgXaK1ClFVRqBiflHeqwcUpuIrjyCNLiyKdRmJXAyzaQb3wGC64whbzvo91z+zq8Gd7TIlyQmVZbSxeRp8U3NFTvSrDUjiUIc6ULGtv3OmpD8xKaRHn99tSYb0HjFu/DM5ApSdGwuvWuZ4p1FLyxjKvXIlyJc4DtVQXF+WLy4hexHPA6N8q4ejcCPQC9OLugtfwoSLCfppObp9kJPIflw5dsrNrV/XlaZ1x3gsPZewrHyM2+S5fb48tLpSDzZniw+VjXgKF6+rLj2+cKZo296UDAOoJqM9+LfoN8zFm7iL0J3ejy4hnRYBymFA2MujMjTPNTSFVVBhOeFE/sVhkwkk0/jOhYUOcGdA670/OV3E/jGJlQYi3VMPDjWCCIxu/6AKBLSGCCnKzSfex/KZ1VzGSXLg922S7qukGCBL9j52+GFfgDjdY5C87vgU3pUCy2AWLRNFNTmpUbsMQZ8p2luee2/91NCE9+E8F0GYuqTuDVmToNMZClvgJZFRB+GkXJvnIA6ypwTWIASc7ab1hSQUxkXWuDxllFDdPYI/GmAscD65/FEShPj/EyV2BbrLNYiHCam05HbZFM2kAF/q+l2h4prgIiCSkY9w1ycmEdH/6N7EtmOCoY8CUeILDJsA6Hv/0Z7GCkDwsWdfsVKgaZRvIBFAZYWmDQ4Vuc4BrQGrQVcoOqbQXx2lNxCzIBtr+yTMCYmtSoNpK0rpPA10YSHhtPifp74jINq0ZMdHN5o1qzjEoS2Wqy2ZZF8LwgCHONDWcugBn3W1njMN/hCm0MxQA2RKghb1wfrXHw86udN33nsv/zK3b8Nua3XhKF9t6wxqPIapTthA1FzWodcZ8byN7W28eitwmxWuZmokxO00uDcHYxxedIYmAZY/RNdjmKyCAocy0NG89m/dx996Rql9a34vlNWaP6E7o3zKNo7gsl1GwPh7f0OyNr545ODn+5B4C78Dv8C79NF74HYmV3t3vudu/wb/eAXZFx66Dzwhmk6xmlpq7XV6EN7f5luXehUhdz3zh4AfarwfiFNrEKwSZ9eKzvo8mhl7V+6lh35sWga1KLujXuL675WCTeBIQVmq21PY2gYGcyQQXtPOCev53qoaqEZgtS6wRWI/CDjj3KmKHOuILRdidg1edontW4ykxB+LyJbUx5PCVPusIUcDMJJZcw2yZa23AMqpw2GihbLxkElWohmA6bhr8srIyHjvY2AoBlVLlMCfrYb7FPH8YwXSm7uBrmm4Fke0uBJ1IctByhXdKm3mU7kk0d/P1TSm18hrU+YZp9FunYxxBeKqt91rVO2UKEh/c4TaG2sK3qcVBVhViwC8FjGtzH/ga6plC06euizdvAJvAnDPj6rG3XQBj+qWeO9IDuh7NOaYZgWfRVJnIkSFeF2JDk98bS3YBDE6VEM7rDG66J0jL1OI2rJb+FeSGhQxreLE1ScskEUqV4tKJR5OGnuUSDCskZ6N+owL/dy/kHaxoGHWfqvOG1rj6JzsO5F+Y+DC02WkyzDTTKNgbuojRUJu/CPvrnM/b21JgM7W30N6otSlQ+odrC/wR2qWotHfz5+1Ba9vdg3I77HZh0YPKHAJPbNL+dAYwSIB/7yshqEMxQS9/PZy/k59uXGiyug6D0SQnBmj5lqldTyXIp+9g3fmR0x1vrZtiLkxTAoq6St6qBs0zHWfFaJnKiza5lWqpmktnaGAZVNrmU3jxckXSkQmuph67vwT/q9FNJmDKhqsbWDxDmGj9M8oA/P5pjdhG54JNaUPMimrMOnIdLaEWS3ZCqmh6CKPRUUhLT+hVuinqXwdoun2SCFDFSoUNl+eQJ70a+jtA/D6d0UbO9+TOoB1vLVGRC11QuFsZ1sdj6ZerXmpZy23jzbuYEmmbA2YmZlEfgkeIxdSNWeOesP3psy26fL1rnoJ4tPw/pY0v953P1LvhxuMa4exeQzYofySR7I1YmRtB6w9tfzrMblB3SJOhGfknH5JeB4yiAlQMESs7yewiWXzR2iBqcVuBs5eQD/YIm9eHyIjvJDYFL2MvNm3/JJoYzoqKsz3Qp/a6Ia0zocHjBJrgryEmMoKB1qggTsmQyBmSZ3Wwq1SbOMnfRAbLTOLNaJF+zhFd5bJmFmrR6OLJh77BgR9qpa1myJlleeisCuQvx+WupQmT+tCTpFTBA3YhNZF69z6uTZvZzVxcG7iS/0erdcT0vceCyn3THTastzW8qQKHrcy+oBw4GaK6RmIvuI6n4VFWhBLqd5xK3o3ILVY2vYY4G03siQc/qpq400s6U5K7DRpewJL9ing1AVMuRsRIGJjuF7oHcS+qF+/WVSwkG/WlLyCIbkDFaTGhIa0Zjc087I1qJxGkXFRKFuEuzFk2hWfoIYsv3Jkst9/C6Xcs3goK5U28UfpYpjZcO0ju+xH+E4pZMPZu+/taoTMJ9E5ttguZIe3Zb+5Y6OMhGNSC6zUaB34cLMXmklwfMWRaLvCYKzVhxYc2HdIBH8Ui5AaPDJMBc4AtoHPMxAIi0nXFRf/emTFPK/tPpX8AqxumEbH2glsVkjiXZOEKHq9cj27z9NCNc5XloJAWM/u8Yn7PNHJZt5msFo9YK7f6LolGrwagHceteYgONNXMcaKtrGz7+9g0kn3EGZSe0dhBaNUynde/YMdmVbZXQV+BNjAVp0nW2yghBX+uh3HKTNLY6xuitpvIHnfV5xZ2TTeHKG6jVBSw3ukqiIG2zMWFaCnZ84waXzCy1myNEdoYcq/k6ocNEjZwSn613u9gkutBBv8Zu+iDLIaNPdGlb8rsmR+tCHFexw8kiHdi2u/rzp2YKIEC2ONoGTi4Ve/hfrCRypVfGK70OT+SbI+X1GQdoUSd2SF8WYfzOlOroyOZxOp9nIW3yuhcUw0/WaQKZt7RyYzChQappZdfGpvsA9vdhhjOszHz0CWfHz5ovFY8ncZRiIuJrYBVD8yRaLB9BNFZH3SHPXQ7q8CD2bgEYdlS+yJqbYqEqWYkmgQnQSs2Ow4jBIYBpLn34LE1ez7Hwd3AC2BpEtS74VnWUgT78h9oCWehYy5l4fwwTr1OgvlsFCoYxk1eYna0Gi757M2RKi2IJVVGvN6iM2sa+p9usGbKGTQa5TbEapeb0lsPSW5wjzCra5I7XJkMKb11SrPwqt+AsJzUG9eNpEq7yUTQuh0lkzho7f2MsgA0CFRyI+xy21DQ1LgcZk2dZ0cldpYZ/y6Cb+bZke0ulKajXwDArq25NLN9taNs+GbKgMhGgdKyxec20Jlnm6pjNUt9fNv9Iua/iiWMxE7EITRD0p499y/VZ91Tb0VhXbJqK8qRBA8KUHxSNaT5AUyO8ypp59w37sm6rRIB5kD/CRNSUXbs4cmB+qKqLKua4/B4cVJ8oh8I6+L82kcKmdEh75PpVWVdfrNCAy9l9d/MUrGaxNe0mL1v4BlUafNVYB7SQ1c2QU01gYwj5pF31A7zbUmleodG9s6HRzz9pt72miqtuagtGk4YGP3onuRM7mW2oeexXpaMfC5VwgbA3Ur/NRORUxMNXEQ9EWXLaiNNGDl8b+UrZVB8TEcZjOIQSoVwzrDwUlZR5KMkqad8fHUG2tuW9s14V3iZaF735yJwzBYwzLlyEmJQzJYCjgs9G88XLUSkEDd2lNeoooK1BHCErduKaF42jXrHiiDLWmx5U5hobmUX4wC7SwVUm/rtrZHzt86Sj6LJkTyZ0UYUpZqlTKK8g9EKePCKM0vl1ORM+NGhponUAnNJDjXN8nq/F5xNB8vZYQjVf6Bx8xhn2iTLpDVdk0LPz4xkV2Uqqdkjxg9JP4fRe5WU/xC/u/UGHpB2S/qaRtHt/0L0/6N4fdO8PuvcH3fuDh2ldUO8PYpDaKpzqAjkd8Py+gKcL5HSBnPuS5AI5XSCnC+R0gZwukNPhbRfI6fyQv2IgJ4jwhHvxSqWrQ5/Y4HTobgiconaoitpBCAR3Q+BuCNwNgbshcDcE7obgUDUWdUPgy9lKsNo77bOL4RuHVB1SdUjVIVWHVB1SdUjVIdXvBKmmoZe8ieIL6DNZ7dAMHSizKZVZMY+qzBWXN5eCbH6ryzhMfHiYWL0PU0nHpR4zoJ+dt4yDtt8ytK0d6qzfDim8Oodxzakc5dl1BrBVt7el8i8toOyWswzfAMMmS3m01r88b8JHqhf6xcecbSiOzgks34WtwuO3xVfIzEvqajJKaaTYNMXRrrxAporaX2CzALgNrpZ14sKzF2SwWCEuKZ/d6tWzTbiua4OV/AGaV/QAjTougm7JtWaPm8qP/UwK2PT9eg3QDudYwgTj5IEs12/RNZRkj3GFJSbwoMpVgIYtZ6BSuSgAXyFQm8fRnXrTufSWHPxHhco9Q+0mZGmYxcVjySF+rx+Ah1Wahn7Dz9YgKSjKk7D9xPvwTCjHkRrNU1HTkmEqGhwRvc5XAeZsKpQ8Ucepjm+8FPPe9HEZFkykJEoBKFV4SKcM9v4kuksvWifRjQjPzFm4XQk1W1RrMsPOkFETdsyWkRwF0P1Cu/iomcDcIu/Dbua1U5UOnQKDTO2ZV+rJTD2D8g37/aBDQdnvRw0EJWhl/Nuw1foJQRZcMSOrQ3Qd6D0k0OsC0fd7H+47sQ/u8A5amPr0rKqCXatMKeqRXM4+VZ5fU4+k7Zf8Jde3svQvpt0TxpOET65z84SNdlAINjKclM1nxQ07KtRC8DDMEgbuGwRMQzPjWBkMrKLBu9F3EWBRO1+3yr2YmRO19qBYOnuEmOVJlCT7hE/Nxgw26YK9Ymh53otNVKmm/u0nhRaamB7K/r1pHU7bE0Q/QW57bePGx+suBToww5j1Yb2DdQ7Rd4yZnzggMErcS/Y5Dfr0wfziX2wKQAEXWe2TzLl7AmS2U5mlwNyen92d4Yd0hu8pxMTN6viwDiXfYue/DN1rgc5s9sOYzVyQmQsy25ckF2TmgsxckJkLMnNBZg7luyCzqjB2QWbutUD3WuAPKbSe8LXA3KxIM7Drq4BY3TZqmJcBt7z6V+fpwF1fBrQe/vO9GVDq4WsG0rbC6GfS8DMz3791E8q6hYRP+JbjLlfVD5teE9wuhUQAoxqvvPN/2Odtv4eNT9w9bH657mHTQ3RkRN7hYbmHjS/EPdR77u3hCV5rexpxvyOm2Q+P1BNDG56jetj0sJQ7tA7s0MKm0vnqe70PIWwthg7P5ikjFyTlTOIHahI/CNXLBUm5ICkXJOWCpFyQlAvnP1zE+huhVlCyS34YaPQ43SNqSd+CXS3XRS5UojRQ0MVrH6CrFFd3cI/xXj8/HeqbPOUURTd+x0ra4aUdnnJtPJ1ftzN3T/pb38F/M+aR9XYujULygBR6XQZOCOMtv+5Fwt1OL5tJ1GiUeEeJa27tsneHpsgX4c4t5y2eXXbenr/L33vVWLDnw1LCYujvdWFg5nX4WUaz5A5EdltR2MZT9NYTdycW2b1HvtS4iv5sEWbPWy/ufTQhFFcBjpTLyK/RH5ai54KAxeYxB3ae4fOH81i9r9jr9MuPB60TLSDgDZqp1zW2HZvu1cuXQ5ZweVOCRTsAslVrv/Wa6WtN1AYR73v1XAqwVOaHjG+xXvQUd/i+Um48E8Kjhc0jHVCdDn0IOvTXurTdyNN/7Z1to3pp6+DlIcFLFyS0JkjoFjhGB5PsTOC7j32Ro4vM6ywjoUq/MmZ9nRcyD8TUp1ZyGPKFvI6SOtp/iV2yqluYpT1PvaloS1P8ZPvK7RzGrg0fLfbJKrP3C9sqxIr+f5NIWRk0YwKrhcxwTlEzsP3b8BRFnx2F74rEG9FDDAf6nx8ti/hDW7Tk9gD6ZA1YNx6Uw8H7K/gT0DoKshKuteF7i42g0EiTI1kaUuRNnKrLYhaFzakIcFSFx12hGnaR1yvWGi6i/F120AZ89HOloBwdg+eF+57+fS8kuxyd/dmjohh5tzZa3NgE9+5SmwJ37fLRD90q3DCWnS3x+kVLwlpjXka6RGs92gooql/cLzAhAvZOL9JuGBV7FyX0gat1Jv/KNXvbs/TKx0XkBwEGtZH3Nky678mEgi7RTVpMWUUj1e8bI0obJlhnvty0VU7Ph1ef3/Rwu5h/fh5cvn97eT4c9j6ew8/I6Z+7nUGn27v6z+f3g6tev/d/52fmy+Cy1z1f9b2y884EBrXhDmfXsN+VFFGGE1l9PHkCM7VkUZqQQLGd5POTdxXFI5Iv+cbNGyXX2o00q7rF7atWE50r6rzEqz2CO/0eBsdasQnqxEKBV5Ik1g0SytYLL0zvmy9Q226iuA+8P3GrYf9KzwmE0HkyDIsaY9A/JPWrXyBWGL14t4S1fBTlCZ7EsB+g6Vv0gs/zL5hYr0L32KyCCcUepXmRWSHrxaTOFH0cdM1LxfplYCil3K/pdeLH7JYLvTuwD90aKbsywmHT1Oe0z2JYKcGBCSMYedxgWp0hYQ5VtUv4E72SbEiTK15LjvDWDy9zQKUVVGoGJ+Ud6rBxSnlM7PeUcRRmJfCuDeQbOoxPFKaQ92u8UsoEvRne0yJckJlWW0sXkafFNzRU70aw1I4lCHOlCxrb9zZqQ/P4eLh+O3zfBCzZ6aDTXyhLa2ZcxSQsNRKw7P3yevHR9Uxy352mk5un2Qm57xYbvmRj1a7uz9M647oTHJ98h2PkZu833zN7fHmpFGTeDA82H+saMFRPX3Z8+1zBrLE3HQhYR1Bt5nvRb5CPOWsXMcZuUMaDwhnRwGghjgZG3ZkRpvkppKoqgwlPiid2qwwYyaYfRnQsqHMDOofd6flK7qdxTMEkWEs1DPw4FpTrAL5nT9AT5LTIKl3H/pcOCpnJLl0e7LJdTJasUNyx8zfDCvyBRuucBef3wKZ0KBbbALFomqkpzcoNWOIM+c7S3HPb/+4mhCe/iTA5EiyqOoFXZ+o0xECW+gpkVUD4aRQl+8oBrKvANYkBJDlrv2FJBTGRda0NGyOv8KYCx4PhfjEcQXCcyywtSKbAtlhnsRDhNDedjtoimbSBCvxfS7U9UlwFRBJSyFzF0ceFdXz4t4pggx1IBQNOKbNgk2EdDn/7M9jBSB8WLOr2K1QMMo3kAygMsLTAoMO3OME1jCNuK+QGVdsK4rWn4hZkAmx/ZZmAMTWpUW0kaV0nga+NJDw2jhL198RlGq6I1oFleKNas4xKOuxto0VE5WGxBWGuseHMYein38oah/kOV2hjKAawIUINeeP6aI2Dn1/tvOk7l/2fX7HjtzG/9ZIotPeGNR5FVqNsJ1S56dboiPvcQPa23j4WnU1K2dnIzjO9NAhnF1P8ai9wfZNdYo0MQVlJ3GzWPyYnuCj0lytioWqmqyi6NJBt81sPh3gibLfOJrAW4G0y0+zhg6Bug219fZ3XgffI23XTbvKyhdlwUsyWUNBoufGXLFW09dLayjvFBNXU3KuKtSHkk8r01AwwalddP0Oje1tp6ecsEZaS99A2UiSaNDT40TvJRsw+AN062RT0q7zkxkIBQTqokXp3Ee0uog/khsfdLLub5cO/Wf5Kt7yPgcQ8hkMoESrphIWPK6Z8lGQVd7RHXw+tbXlva1whZEJnnKET6gl14QLGGRcUY6MKlwDOP5/Bj2w0X7wcGWual6uzGnUU0Bbgc2TFTlwD1iHmGfWKFUfkSWfnGy8iM5DyUiIdXHkI3l0j42u/UCI/DTMjVMOAEbJqZSod3XdAL6S1iTBK59dlDz1o0LoWqAPghlTSmEVyPdLnE0Hy9lhCNV/ouwGT5uuJLPzDFZZ9226vbztsY+/fqI4phelrqGMu06nLdFrbkOwynTq4+JdnOv3ikmq4pBrbKHFJNVxSDSe6v2pSjYocNj5hKkviNy6H10vOcl96dApyZ+ETx0qQn5CyYj1EYxnT8eI+5r4xp28Sx+gNUGPJyTpcdXDbXVZvueQlVbbgNFbscLJIB3Y2lfrzp2aqO/iQLY72cCWTeL2bhr4qnF+iVYjMViF83pT6yazmK70OGw6pjaTresa7YdNptsYCgpaJKdXRbtRwps0z/7m1x1/1BslYgpRnoTF6qKZbOx+XVVdPqMx8vIBmx8+aLxWPgxacwiDkNbCKoXnDKVuHaKyOlwekObTqHsyrNsVCVbKSWgAToErMjsMI1D70CeQ+fJYmh8gjT/a6t3qqo8y2jv8ovUrn0u/8IDc2Lt/rd3xPtQH4VhbqzZCppK8sUWYnnC6dvUtmbxVtgsurmgzyFOhVlzgHrg8JXLtrtNW0yR1feRjSNcaSHPOLjzyIgHt+nv8KIwjwNFGHp7F964yAxjUkicxZYyeLiAWwQaA8EXGfw5aapipZl7Ups0t7ukTYTjmGQJgbh2xvqXuPeg0Ms7LqYgxvajQ2gLbtkyHzYBMBSscam9dMa5JlyYrZLPX9ZfOPlPvKeTkWMxGjQU6/Mfexb11B6Z5y/iBp3FIpdMkdUm8tYpy2qdg0FeVJgwaE8UXk+mk+QFMjfHlj5t03bC+grRIBHyD9ESaipuzKlGPbFrvix6Ijn3tT3UHx7wOKuzfV3Zvq7k1196Z6HbuOe1P9G37myr2p7rRxp43/Pdr4gVj23JvqX+NN9Vwt7J322cXwjXtYwamTh6pOHogkdA8ruIcV3MMK7mEF97BCbilOQy8Bff4C+kxW2wugA3W/TmVWO5JCmSsuby4F3QuvLuOUxkNSGvEJBzuqxk/jwEFgB4EdBHYQ2EFgB4EdBHYQ+DuBwA6YHjAw/SUdU7pcCpz8LkK+ne/Oj400lWv19iEWOFvlcIB+4Vz8cHmR+fIYApdRGjdv/iWbiHfQ8U6790jpd0Vcx9V0eMEmuCtm2ZVK8YpFvSRlsBYlzsDfbCrV+a/gNN6DL/ikhrizWshq0QFonFQttGKduhpNjmzZNdzRv9bquuxgu8Ln0DoCC8hmLVUoXp+WJL0CWVY9jbiQefU+r06a2c9dXRi4k4J8vEpKz3q3ecBlP+mOm1Zbmt/UtVvX515QD3YPMAO8xAwOHym9DFVVAJMQLJe4HVVkpk67sJo5Gsyk68MHL5q60khrMpT8kI0uYUl+RQ2lz8PlyKTZCQyu1z1QVEO9V9j6eVSDBuOLbEAmYc6EhrRmNDb3tDOilUicat+QquvLIAIcpj6C2ELPES33MIblm/Z4GWSjyj1elBPiFN2RawTibUq+C3OWPRG55nEwE1kJaz6kAzyKR+p1BsxjH3oJ8AU0jkgWtAhZdcfTlLL/dPoXsIpxqnJQyYTHlE2aZOMIUxC9Lrj9P80IV3mPGUkBo/87xucA9iEBbBfo9x1bAEtsoLFmjgNtt5cNH4txEfpRll+GGeDY4SLA6WlOT3N6mtPTnJ7m9DSnpzk9zelpTk9zeprT05ye9lR62nerJ21XJ5zQOjihVSNJ5+6PAtEMKKxbD81e6cfEbaMGjWNrtFydoDa8pF4TdWRTuTkr8Ntfzp29xdlbnL3F2VucvcXZW5y9xdlbnL3F2Vuc6uLsLc7e4uwtzt7ihNZfbG9Bo4ltldB5BZsYMdVk+PrPXnYYu0ljg9luYtlqp9nVBtPYyUjzIfRuOcNAF5Nm1wXHOtPMgZpmDgICuOBYFxzrgmNdcKwLjnXBsYcK90vBsR3Yk17MBqdDh04dOnXo1KFTh04dOnXo1KFTh04dOv270Wk/4mOHSx0udbjU4VKHSx0udbjU4VKHSx0u/VtwaaEI9aO5reKXa85RSY+nepOKULG4t0svnvWLL/RcCrmADaJ6bhy9evas6sd6yvHlVRATEvkG/dw1q9FeUk5c7d+l8tqQk2sRcPyXPSEBHDXQreWluoYPTcGqa4g1kvM4juIK5S+rlL+HlhVaCSPtXgz0PJC75ySFk3xJaP5UgHiIOyn6En+i6Q9Ech0B5Uf4SDnQSG7GR239UBDQ2v5SeuqoN33I3LUktZrGPtQxCIgvvJZ6kDaDQdXjk74ws6qsi+VZZ9A7QpoMyUOcYTVbNuHZhGGPSAoVQzanQvCL+scbc4b8fpfQVHjhLKLqJr26ogK73Uag9mmVujC9cjUh1igO3h4yvRZNR9gs+p/8A8oPdMqmfp63/vufrWcGocNM5yLq6IwoGuNJV3wVqkztl5xVjy4FcJG4FeoJyKlIgAZp4EXleSkuZTTxyB0yi6GYe7dwho8qqz6yHuRMQDogtvXIJYim4IvmnU9HOe9AhdeVdnBrIJjDol++jLkUH2L/4QF/hp0XK0aFs0W7GNHTYRsG/D6e89D7UzN/GogYhIMiYeZh/Mcaom/EEjdnPAeKMol+RPxnZOGOlBzrl9CmJ6xfnugdCDPHWri06TIEV6cT1Xs6SzCMBwhW5TqA2xeJ1UJFhBV2/9vzqyN60dPeX6X9ZNsDitTBMlKJK3xw8uEhI5YeoEQCHx7+P6C8JkA= +api: eJztfWtvGzmy9l8hNDg4MaBLkpmzGPjTq8hORjtWomPlgj3BwKK6KYnr7mYPyZatBPnvL6pI9k2S1ZKdnbHDD4vNWM1bN1l8quqpqq8tTReqdfq5xUOWaK45U60/2q2QqUDyVHORtE5bl0xLzlZMEb1kJGSa8kgRMcf/jGlCFywktoM1oUqJgFPNQnLD9RIfWvAVS8jUPju0jw7DabfVbomUSQpDDcPWaesMh56xUfXZVruVUkljppmECX9tJTRmrdPWRp+tdovDrFOql636Ukb12SZZzCQP7B/mnEmYkmR/ZlyysHWqZcbaLRUsWUxbp19bep3CqDzRbMFkq92aCxlTbf70j19a376186kJuSim82fG5HpjPu/kgib8Cy5/x1wOGfsPmLpKRaKYghYvnz+H/6uN+Xur3QpEolmi4VeaphEPcAq9fyt45OvmoGL2bxZo+AoSvhdulNOvLR42mdhRX+Fb277HvH+lJU8WG729pTFzuzGQDHdefVdid2lENcxsf5e/jQfEPU3gUWwfiGTOF/tfyo2Q12dc7h/mk5DXJOSSBVrINYEdS+ZCEqUFPE/ghcqYhXCaCPQ6j8QNmfOIKbMgyS6zZII97h+tH4aEEvMXopdUE3bLgkwzRXiCby+ZdyKaJcHSPZVKLiTRgvBkJa5hSm/ZrcZZpFIETCmmumTCGPk8lozQJCSpULojs8R2of54ttQ6Vae9XigC1VXsTyZpl4uee7+dIBJZ2DMD92i4oknAwp9SyTo0CTuuv47t78SsXCj9MEunc80koVG0ZWlkSVeMBCJOI6ZZ+JeslCUrLkUS28Nq10mlpCBNuGax2r8jmx2k82IosqKS01nECDTFiaxolB3bCbbFXpaMlkXGTIiI0WTzg6VptCZ6yVXRiRa4SfPPBF2Rf4uZPZtxmmn2QF3b3qB3OGnfyjfCZ/M23Qv5o93SXEcw4gDlw3my+mj7hYntfzsKhldMu1PoBi99eSMN7ewGdTG0e9Nz+CeNyguDtpm5b2FcEP5ru7FrT6GgOXZTu8l2TF8d6Mts6JDDJGOeUC0ayMhxWQyTSmPyTDIadkQSrdv4AmdUsZCIpJDdikUsgJ5OzLVOw3dJtDbX+rdtk7HnZv3WXOHV39utmKYpzPL0aysWdNapXCl2G4wEnVVfdKu9cT5pFL2bI455oLtksLlr8MoAoZ1fMUfcGpMf8b7Yuui/+03x8PLBgkTs3cyl0Va8MHuiADaAafIhzPvkIsFuM8Xk20a30wfFJEhe7G0y+Y3QTC8B3QW5MIM9CdAtiDKlLYZcCqWbDfCbUBoHEJIMx4SGoWQq13NK/ZqbJxEhs3tL6r0o+OeXm5ts8huBtrigQCQJSKpksW0h5IzNaRbpUzJ9+XKaX6T/m7EmVzI+RvJ3p7JZzLUZat99eu8Rdl2pIEpvsdmEf2HHvL4RveVxFoPuMGMSPhN0bc5sQBMyY+RP6D8kVBORMKJ5XGCQf4rZO+xJHXRQhGmDq4SX596ZWbJSbluDEKcLqtlvu8baBU+Gc4I6Z9G1G5NKRvJ+Q9gmlXda2iNzGik2NcDF3Ur9mdKSBvqN5KGVEKCqVm+bA+9md1kaAAM3bQXAWBiR35EbF7BHt48b3X779u2Pb+0WvVGdGdXBsoyC+p8m5BX8cS8Uqn5M0H3pgr3Hh7Z9jlSyAA5AvodARko2DBs+vhJRFjPVYLvZXjZB/KsJsb3Au41FlmjyzIirUzLtwZXTA2X+tAc3KOUJk/jf06MQ8P1PmWQLbuw6ewTdpwkxz5KbJZOMSKZEJgOmyA2PIhCpzsDyjHUX3TaZZqrDqNKdF3Zth90b5U1iVoMiG8WrzJIEbpD8wghhXyQH91z0eHbZf3P+NjekOCQ6jKIMPob9vSk4U1kKtzcLr5SY6xsqWc/MsCdWTK44uzkpTXuYKA0gbve+ruywwUvCbQuj+Gybf/4R5i+6L28jKhes+hX+KWaXImowHjxF+pdvYYstJE00mfOEdRYS9m5Ihv0RSZm0Fxxu+t33eo7vmg0NfUs3PKzyfDAhmqrrGlA8AO9s+/a7ZatFA9/rRd0h1CM+Bhv1fhUY7IK2K1jb4GJodkcUGeibGw6ssMHud2qO3nD4QxgO7b4epJk6Bl6/zWH1YPxBwTpF4HDn3sM0YrGQ69HsKFyPbd2AsL13nt827L+YLehsra1J3APKRw0o260bumLnCfxnk4WbJ8nnT+a8Wfm3+0RB7ydbVaV2a56B0H55+OCvsSGaS4laK83ineObMU665NK8IEVqM98xt2SVxGxioPHBE3z7ccQKOGEBdmkKm/M3Fh+xeCNFljawPYJ4+oQ37oVYKLKAZs6sYRZGIrFQT8mMbb7kJKGpWgrdRLOvbZe86Z7N0ltkPGQ95R4/2f/l5kIu2Kbj12Ci1/Bj7Q1aE0OXfC490/Sd2dPfYclK9XJd8CeaaRFTzYNOZayOmJsHOrlycULss5ZhsKkVlI3acIOCWcRgu+o6nNjBvReyNBLrKvbgKYt4AnfFPj1U7wDqLMlikGqT8bv3rTYg9U3CxLAM3btkej54ObXTUSRL0K0rs1Rz2A8i6YQshlWVUb/qkikMUbSrtpqkQhcPk2eRuGFw3JQ22zPmybE3/4gnaFjDez+VYsVhk4Ez/W7/VExvjx7S2vIOHXKRZgdLwzfjD6W3jJhhpvqZFpOARrtuxKoVYafNLp+6IjQhYCeAnd1htylNQhw95Or6rlWRt0LjD9R8Z6TQ7DjmvKRT3seeMRBxTDuKAcEGEF7ElQbgBxDshlX3JW5p89oQoU00tFms7zoqr84n769eD+G4uH9ejS/fvbk8n0yGH89bbTxMV4P+uD8Yvv/X1bvx++Fo+H/nZ+6X8eVwcL7t942Tdwb8oBhOOFmKGytFjNFEVc8X2k+plGsiMo0CJdc3K5fwthlPUb4UB7foFP5reuecTdvq8TVfM6aLnVasyufKlBYx6Y+GZHgGy8iU0XHN5QUCryZJRpnSYLyhCcrWC55kt52XoGl3QPLH/AscNRjf6DgxY1pVtqiT1f+tcFyVsoDPreelS4ZzIsDgz8I2topAlGu4lKVYsZCsmMQNbF0p/Zh+EUlteOjWIIbqiIpwBSsMDapOgyav6ON4AO8G+kuYtm5Q7EBls4Tp+5yWC3s6YAzbGyq6SsCy8dUXc59LERNGgyUReslkm1hVBoV5wowUUyzIJNdrRFsPMTXXoQViwzOcYcjAVgHqLMOn5lyyG9BfZYYkBHSciERLEeEq3JcARxfRks7nPDDwQt2OwOa5/zu8ntziR7hAE621lKaCW/E9V7fNXHO1fkqCsFC45ur2WFfSHd0r/gW+FnnzypluU6HYu+SMRUxXjap7PTohtDHwpmRYXbJkK87hyjYwO58FL39n6zFt4oCFr3fNgFDGZeEuDcA2kUvum1dZcP0wJ4EWCH3yM5mZfu143OqLu25wNlOvIhFcH/vpClt8/VMZ9Hw3PLj7WreAYfP2Jc9WLwzMmvFwzGTAEk0X9/Jiurs2lTxANiOt3hFtQhWhYFy0gzlhWtxCpqkxllBdvbG7dcCI9vxE4LVg7g0WkizRPDJyP5MSNqGCVqZjrsiMAYiG3+0FwEKEnKVpla/OF8+f/5dRX9lcDdBxcMhxMa4GRRJ2Q85fTzbgD5urJnfB+S1X6Iqu9UGGZ66bhtKs3kFJnMG+Kynxhd3/cGvCg3shiH2mNKt+zJu8OgsxYEt9h2ltgPBXQuhj5QC0NeAaxQBMOe+/XZIKLFBNDQ8WZ1U1TGeLBC8FrEeTgpaOMIXM1oUC2yX9NGVJWJhNpz2mgx4LFPyva/qeml3FE4MUHMsECSakH2kmDVeDK/NgTNdwgWQRbjtKYhrNswRpbvBgVc3fomKglaRYQGWBtQ9Mb1SXIlzrBiLuGeR2Ppj0DMTrhWzFIlCbjZGCBaqDnVqdv7vUcWTtJVQ6PkTzM3GZJZsGTCD4vTa9lexLCrZVcLdZC+F5RRAWGhu8uViELOrmnXOFErKujYEYgI4QNRSd26tVxv/45eBD378c/eMX8uyNpCuuRVI+G6X1mGm16ybDtpnNdh3xGO/jcK/nsUotwa2Wc0qM9Sm8dAjnEDN8gSTGJWOM9WLXg1IcgnIu6dm6svULcujJpk3aesQLLxnwGBZCLCJmJFiZyvAG/07Qynkgm+E/7ur3nr2n79m7y7P7RKzr3o3n3XhP0I2XSgE7tQn2rlw6tp1TWZryuSp9WGJXibgFKpukkaNufRFJg51e6ROaICiyt8XuMTp0elI1FIbmBeUkmTmXSpsebW80Spd0xoDhHaFR2lrLEOj1gwDUr/OY8qgBod80AqMEKm0MmiG0AcqOMVWYS61ikj0INo0oGF8tanKvIHnRgT5CKkPkyFVeAXUvoUb2Kls8G5uFh2fOJGAsuWjucyRvG2ObLMpIGG4ZyyNiIXGKWq7ifBx1yecPsyzRGbl4PykOAwrzrkFLqBZYwYGnpIejq55QHRsp/FOGfVxFWp0Qu33SbBZBvCc+i8zmXGPsAn4DL02HmSNcVuQo+XzGWEouGJW4uI+jO+YVMpZ2IvtoZxWXJ/gTBAtdWcu0OsHYIfvmEOUPPpz1a2+IK5I7NWkUrS1Egym/c3bsNpmglOiIG/BfBUaHtOt0JEq6ojxCoYP62zzTGZItI0YVu7caUd3DD+Mimwmhz7hCM92bo2g90NJt0FmurLu95qKXzpMFTwqyQpdM0zA/QNP8YMApyhJj0K6co/95Tt68cgbB8jH6C5USIyqPVUrol0xu0Un68OfHoZIcT0Tcj+o9VPRQ8WlCxX2K3MHwxEiMjyNjIHX4ZGJl69XZS3W1+tlCwV0AE38yIq4hNcyM6hqVmGEfR44Ohv7ZRl5dLnVGI+fSLXq1sFhls/zxRuZtnFu5letpM6lIo/DEDlWKL5It+Sc25lobYRBxljTSCzZyZwTY1Nnpq0GRjscHiSZUSoNGQPJCLEg/odFa80ChzQ+buhFikXCTn8L1/h4ORTNHrrWp61xyAgKqDGisllTTgYhs7PZ5EqKTZX/3Z1RTEuQNCbMtDT3CMRCrvV9mUaPXUu8bvObunURiQaTItHsp90Ab1Xvpmm1h1uy+a8pW2RFNu+eJluurCf7YNf93tenHvR9qcTTtujH1mm2NjrcKwJvfz3NHxwGx8raT37MZ0idgyhUg8gRBkLfZPgWbLVgtWIOdVtnZhouTRjRh5MPlRX5puwmuRSY717+qDkQcgsZrr2+logGTTfIcTC5IAKcCuVwI80oXCHNRRYkVeXk+r/IsS7H2INDxrjhonXkrFKV5mqMi/KsEkKyeNy1D2knFIHTQ0KpmFiqR6dw26thgduBmWPbwRrx1ZVaAuh92SvYLOBDuxCZsXnvON1+aO88D+3AqDb1z08XbjNd9/av6yQ7cKfVl95sJKRhElMfNcMAY7C4Kkkt8RF0dmxpAgE50quA4Gvam6XzH5mgTeyY0EKA7ttHUch6RVUOml4yGnyTXkFRuPXXmvtglcLAjIAukWUTeyDA/IC7PmjTSfEHO+hDgknasprx7evmkjUgMB6B7GHBde2siJIH5kaQi4sHayj3wilv5hqiv4N6K5EpluF68SG/oGv6RMBBGf7Q3lnnbgYadFcVUG6pJD/ZKHufzHuPM3FEYi3CSsuCedItUhHlA8I5QMGdwFSGb4BUt5NTwcYG5mHC9nkLnkAWBJ7rMigXtm4fEzpT8qz+6IErLLECznNJUouUUpd8UmE+n07Il+mFWuI0C6GRBKsK/Yn3esvLILSvfKwS0UUD1fygGdDME9Em4wGvf3cLHAtpVlK2/PI2LN/F6QXSXIGpgzGzq036/rBoPrMu5A5EVHXQfm9wK+GszMFrvEtfWxDy813j9zabk3eLjKc9wKw1tI6OOtZy4mCYDDf7mZo/cOHQYryAX+8/M+zpB+W9Wjlm+drMY7hJFwGZvcDo+qHp85QP5QGskZWQlV4KeqgMGaTZunLK48v7MmxqMP+QfxxqdkaFwBJ1h6yS3khx+sd/hgaguSi3PKIsbBdpY7wwEu4TYxoYBz7LFIo//UsthXI3V2JlQ01GLDSvAxdGYro0hGboeifAoxvoZNCYREKjJs+edn80e11JkkBN2KURuTQ5Eur7HpKE54Psib3Sm2FjyFdWsb5IcNjwUqWlUyo7IFAGzMHmWCMJuIaaNRmQ4tkaviM5YdIBPfW/E0a5IVTNQjtPgH+YI5HFWXW9o/TEMrV7nebQ6T7uVzNV7SGPWYIu+fT0hRisiGpuYzKNLCukfnJXN9tkwvgu6jAvL3mZIl9dDHrke4qkm2+amDvRWTDD4c42R5NtotXnmZAh5h+sj2cbxc5Q9LdzlUs5sKFkg4tiEzsHBTqUIM+fUz3d1nvkaCSENGCTjQc4eyQ+TCeJv1sEkf9Y4K0rc54/jQfkqyEOuWAzisMFpda8VkYXNQz3Pomjd+TOjkYm2lWzOJEtciPDnj6MSddiO1Jioaxt2XEN10sYFQUIMjFV0P5z2elPwIM35bbvsI9srAv4pZupHeBENhdUOqgTkTNokeEKix8dA73ygZAK7oP3OjAJ35QU6IuGtST36cot2W09xexjtbjOVq+tX/9yF2j5Z/F3DAsC41TRVzGYmFzeRz5bVHoNvyeQ67Y+GR2cIwz//ZDlwHRNg3LHWiQ4urUNjflLwvdEkg93DuCb/+oyZzAOIq2H2+8w/Xv17+urfE1GEvKbhNY0nqGl8p5Si94mWojJYcs0MF6KUgWEjWRyIro1k5/eOrtrZ89H5nqo1cnZENt4z20oF1MwqXg2XbKWGaExg1nSR/jythWcB2djCjAq8GksBW7EvGzoFp8NqwynmaXcjmJwtZSgmoFIpzIOa/PM3S9j4lmRkI8zyNEcurM+E8OVJQzCj3uVbQ51hicgWy3r+d5klJS2zCWIzOqajlheZSiIaMBSwzxRPwGFiunT80gfKITfZkjuunBnOqb+ldGKPNrZORZmMt7LUJ/CLL+L2qFGsL+KmfRE3X8TNF3GrHxRfxO1hLYBeWX3Uyqop4gZhRNuQkA+18ybAxwWhfKidD7XzoXY+1M6H2vlQOx9q5yG0D7XztNMHC7Vr0UhTLreqSn38iYxfTbzl+FErP95y7C3H3nLsLcfecuwtxx727rMcR2q+FQ4NX43IxeS1x0IeC3ks5LGQx0IeC3kstBsLZQnXr4W84DHX24l6KZPG2IPPbHmB5pn3VF1fMjRjbH/Go64ngLpMXYCNJDEmpzX+2fvpfwB49oj99I2D9GwK+UW5tBBE5GVqWuR8GAvRoA6QyQqSChHtsaxDoRfospbdZXfxYMeD3nQlVutxlkEluEVJcQq7lfqF1VIzrhiueRm15CYkzGC1Wx1b2NB6Ku8WAKv4wEICGJRYJtgXb3fTJVaeuG1bvqeLOgS/YB0Ccz/Eg5pT/wiHysdRLgXK8/sEdbfhHauARvDyuCK24FDbiHIJX1hBlDk2jjdAFvSsBQQOBEvrOhURAq6FFDemLGetYFBAIxPz8dwU/s6SPKITnpzA780jSaBJx83f7efSIltHViw/M4XKX9lbxGwqXBxOepcPtVaxPA/UuWSLYXi/2GAX8gNSQGlZqadQq0ba/4LzrhUl1eKaJWfuLty7x92TTuWZ9CcEuygHHzjJUal5/dKSC8ybgAD4d8kg5wtsSod+ZYOE5TePIN5I8b+YcQCezTrjwEwVZOTGCvfBpd1Lhk22Zc3bo8k8jn3UONYHSR5X+edRONUPqnCTZBGWwzNIaltwnyluSMnnjcI6pvzNcZkIChUqz0Xg+j0hVGsaLIvK7WUAA1KvnUOf/H1ucDpFpRVWH88zUzUKUMN1uElvDVQzYYmDx0HNbpzk1WT0yu2jFv2b/ZtXiiRF+g5FPkM9QEmUZin5hSyZbLylK3vCPNWxf/vJ3PYdSExS/nundPXsTzv6ABmQLe0VahBdMjBEc5HYq/gAOxqgZwk5RyhYoiEdJFrSLGiz1+7LX0lI1whSzaHIaaGBULqXqTyx2v6kvv6GftQ3dBMRxa63x430MakLOf994us8eaPWD2PU8sEnPvjEB5/44BMffOKDT3zwiUfpPvjEB5/4Ok++ztOPIYgesM5TYdtrHVPPCZqXbQ+uptOeek1Nij4dU9MpW2w3335I+IoSIKK5tOieLf2YLReeLe3Z0p4t7dnSni39nZGoh4qPGioChxnai4TVXD4A3F4dQV+2BrfdFMYNuiaISLmzhsLG48bcdx8a2/mriTUaGu8qGhefGWkF9kG4cXpgbDzt5SQR/G9r7v/buutLZTRuwPNeYqZivuQZy2lzu4pqHHZtlDeJWQ1KbJSuznyY3xch7Ivk4J6LHs8u+2/O3xbViSxIG0ZRBh/D/t4Um+X0hSsl5vqGStYzM+yJFdgB2c1JadrDexYb2Tb//CPMX3Rf3kbAtah+hX+K2aWIGowHT2ECbC3IQtJEkzlU8FhIUyJk2B/V02HvvtZzeNdsaOhbuuFN8ZYJ0VRd13DiAXBn27ffa/76Xi/qDpke8WbeC3gqZy9BOaGLodkdUWSQL3dcXits7slk8R7sp+DB/l7G5Dv39H/WltzeNCZ7PPmo8aTnEu/gEq+SmFnO6cETfPtxVFT7Ljza+RQ2528MPt+nyMuTcPe43TJJaKqWQjdR7GvbJW+6Z7P0FhkPWU+5x0/2f7mDA9ishaFLPpeeOboqnGFi5xFTncpYHTE3D3Ry5eLERVcxlWOcqlZQtmnDDQpWEYPtqutwYscWjE8jsa5iD8sIUvuj6PQOoO6IGpPxu/etNiB1kGk1TFuG7l0yPR+8nNrpKJIlSN+VWaqxBKJIOiGLYVWVUkVdMoUhinbVVpNU6HKNwwjoNMjstax9nhx78494gnY1vPfzEjnA1d8ZMubseUcPaU15hw5577JNBjPMVH9P0F7VirDTZJdPXUFFIbATYGgfu00hKhJGx/pKd6yKvBUaf6DmOyPJY8cxLxew/B4lO5GNxUKyoY3aal2A0CYa2izWdx2VV+eT91evh3Bc3D+vxpfv3lyeTybDj+etNh6mq0F/3B8M3//r6t34/XA0/L/zM/fL+HI4ON/2+8bJO2PAjIcTTpbixkoRYzRRm6XAAirlmkB1WBAoZS5ecQlvm/EU5UtxcItOkd9z55xN2+rxNV+zaSVQS0tqWgy0zCxKULZe8CS77bwETbsDkj/mX+CowfhGx4kZs8Gybos6Wf3fCse19bQMPt+sNoq1dzVcylKsWEhWQLYrgjAdpbwyPHRrEEN1RFUpl7pKgyavCOpD27pbts4V1AJr5eW77nNaLuzpgDFsb6joKgHLxldfzH0uRUwYDZamiHabWFUGhXnCtOWlPVDNLzc1taX2l4DibOCYhmrf+NScS3YD+qvMMJi5XB0MVuG+BPi5iJbAWgsMvFC3o2Y82deTW/wIF2iitZbSVHArvufqtplnrtZPSRAWCtdc3R7rSbqjeyiFZyvhHRuFnd8ONkLWWFlzwypEYjeIwj66jmC1hGAuuR+g1LPbbkXxt91Vnnfd4FDAMBLB9dEVDHNbfP1TGfR8Nzy4+1q3gGHz9iXPVi8MzJrxcMxkwBJNF/dyYrq7NpXc1UKv3BFtICVTMC7awZwwLW4h09QYS2it5nS3DhjRnp8IvBbMvcFCkiWaR0buZ1IioxVamY65IjOG0ZFLRvKCigg5S9OqxNA/f/5flpk6VwN0HBxyXFyqjITdkPPXkw34w+aqyV1wfssVeqJrfZDhmeumoTSrd1ASZ7DvSkp8Yfc/3Jrw4F4IF2hZmlU/5k1enYUYsKW+w7QetJLpq0rx0krFTdUuSQUWqKaGhzvp3+ClgPVAVIGkMcDOogxqrsB2ST9NWRIWZtNpj+mgxwIF/+uavqdmV/HEIIWc6gb8EtKPNJOGqsGVeTCmmDfDFJYnlMQ0mmcJhvzAg1U1f4uKgVaSYgGVBdY+ML1RXVPWHcKVega5nQ8mPQPxeiFbsQjUZmOkYIHqYKdW5+8udRxZewmVjg7R/ExcZskWBrFIyGvTW8m+ZLn3dxpHTOR2WRAWGhu8OYgwibp551yhhKxrYyAGoCNEDUXn9y9hXKpaXALvxXrMtNp1k6FJULNDRzzG+zjc63msMktqKVr+wjKy5a1/cBnZKnfBVKT9m0epPhCQ22UA2Inm7rLJHEE2MG7fsnK+i17A7+lGd/3qn7sQP59BBGatwrUNDqw1LCuhjTV1JDA3VNM3tWg3kc8mN0Qnhjgh42fuj4ZHW2fxz3meDCPcOzGFGbEOLq1DY36Sr5h8UMxVze6Phob6NmMG9eGtDLP3HmfvcX4inh3vQvYu5CfoQv5O7tz7AF4qgyXXzMS1ltDvhqEeRNcG0ezezp+dPR9ta6uGJ5iwdbySHlDTrYCaWUXtdYpuDdH8z3Py5hWZLtKfp85Wxgtl1cKMCrwaSwFbsS+b5HgCrXZYbThFjlw5pWgViglClYJ5UMP9u1nCxreMT5x+luQmprZDH2izyhU29GZcvjU6GUtEtljWuXcyS0pG/yaIbYJPOqNHoSVGNGAoYJ8pnizgkOKDLlfIA9nvJ1vs9mWrvPVllE25f6GyZTSkeytbPvOZz3zW2CbsM595MPjAmc8KSfRGCBDtjjRgcnn8zeWRI8nuH8uuzkjtnFv7zLySE7zvSumKSwYY8OxIGjkTzF1yAtxFDfYAWhQ2GRAAZs64Ql/gm6O4wzUvAKKhCqugOmCQZuNyMHfz92fe1GD8If84lgKFZpRm1qmRebiwsm5MMv8KyYuOsonVO7/Y75BKAVuwCaqpTN22c+4vpZZnlMWNPNkWRAO4DbGN5dnNssUiJ1io5TCuOkN3Bqw7ZcJQTxxuNl0b6zV0XUvd33gznEFjEoGHgjx73vnZ7HEtRTaLmFoKod2cA5Gu7zFpaI6Z2+E+ckHNY8lXVLO+CSJueChS06gUfcwUAVRFniWCsFsgjdCIDMfW4hLRGYsOAHdHW4LNQLk9Bv5Rq11wRGYBb+V7jFY+n6ToEds2k7kymsn+Fbx9PSEmjRHRRpnByP4lBX61ytNfY58NCRTQZVyk4tvkTHi0/ajRtje9bp+bOjC96ARNX2ukalazi7KY8qjITAKcUrg+zG3pTCg2A5HzH2rhLpdy6LBkgYhjw02Bg51KEWYmbWzpFOaeHTQ8NSPeOitVfpiMraxZB5P8WWNMBeueBQMfx4PyVZBzGlgM4rDBaXWvFZGFzfMyz6Jo3fkzo5Ghs0k2Z5IljoP3+eOoZLa0IxX7A8Vvd4HwGgky9izhxum5hh3XUJ20cUHAOEcykPvhtNebQsrXOb9tl13Fe0UA1KX5EV5EQ2GVa8N3a/iPgtvhsfTTx9J32VKeCOL0kM5DuicI6R7I+tbUnVTpo1ZCc9NE+0UkDXZ6pU9oUgZbu8fo0DpnzgLNPN3JnEulTY+2NxqlSzpjWCoObUpbYPE5QNsG2GUrIgaMAMlXdvncD+MNViyz22ywL74rbdAUycIwMbQxYuCWy9YHYpFiPEOJ0wy3jM0IA8q5pdznEPLjqEs+f5hlic7IxftJY9gGo6ueUJ2Qacoj9VOGfVxFWp0Qu33SbBbxwMzUOONy72YXnMNAuejYgpxlSj4ln88YS8kFoxIX93F0x7xCxtJOZB/trOLyBH+aUcWubIyhOiHwn/bNITdg8OGsX3tDXNULeiJEgym/cxGJjnbQETdAuQxMNIBdp0uHRVeUY8kzw8SfZ9rUuI0YVeze/JjqHn6YYOf7O1mgpdugBf/E7bWaElrQW6dpmB+gacEuRa6HCU2snCNDWqnSVZ4I48HX9vYKyiNRUHxtb1/b29f29rW9m3iOfW1vX9vb1/b25p8fwfzzRIyzvrb3vWt719W6R+Fb8vWfvND3Qv+hhf7BduZcS0O2slObCzXrJapZd2vi+JPB2Q3D+5yubsF5Ed33ceS4bkjAaJRojUud0SIyqQT5HfUjf7xRxhmcW7mV66l2VTXpDAoGdahSfAEG3I1bqT7XAy7Durtg633nosiqZYpcLOYnIa+xinKTES7EgvQTGq01DxSyeEwBZjtCLBKuhXR05kgs3sOhaJZbzaa50bnkBE28MqDRlaimAxFFprT0eRJi3qMGWhrVlAR5Q8JsS5MKwUWRVnu/zKJGr6XeNySyc+8kEgsiRZZzvO9hNq7eS9dsS7LL3XdNWe0d0bR7nmi5vprgj13zf1eb2vT9zM/7aDDDVyNyMXnta9Q9arOyr1GnfY06X6PO16irHxRfo+5hteUs4fq1kBc85nq7KTxl0gSn4DNbXqB55j1V15cMgyq2P+MV50etOEM1vHJmgyiTsQdZHmR5kOVBlgdZHmR5kOULAf8Y0Of3bIb1LcCA9TgSO3mm44/NdDSh7vuXWNnZJi1bGtGEkQ+XF7kLx01wLTLZuf5VdQB7AJHdOnOUigZMNoGfkwsSwKmY597qqvfalH1NrAEc+e7wt/IsSxAIOUXgOThonXkrvOxcDHEJvpUuHEvfnpaF1eTA8OfS0PX45y0hoR2LMaB4hi3vtnENVmYF8vRhp2S/QJ4Z24JD2Lz2nG++NHeeB/bhVJqkK5s5+JsRJa5/VT/ZgTulvux+M4yGQUR53AwCjyGcQgHm/4gUfGxqcB1SKqiC42gyZdnkats3R5u4lNtQoa5jG00t+RQTmJPpJaPhJ8k1G9FkPXVRPLHD1XYEzDLRrGTyqMgyYVF7mi/IBRUEuKQdqynvnl4+aSMSQ8uz2yQKjkVIAvMjSZGFZ+UeoLe/mB84zudd8AMNKTuEePDGjsLt9TBSEeYV23fU6nVxVCJkE7yihZyagmlQWirhej2FzgGc8kSrTXqynSn5V390QZSWmUkcqzSVqGGg9JtC3tDTSt6Fh1nhNjatkwWpCP+K9XnM/Kgxs8+l9IjJk7XvbuFjAe12kQRt7cPfJzlMOMBA7LUrr1157cprV1678tqV1668duW1K69dee3Ka1c/unb1aLUbH071IwiiBoFDh1fNxCUbSNoMdGI1yk+Tiu0B17E34KtJXBZ4gHdES5ZneXdizje/n3uziDeLeLOIN4t4s4g3i3iziDeLeLOIN4t4bcSbRbxZxJtFvFnkSQmiBzSLgG2jbDywmUg7EMHTwVTkR5lLyl06U8l+S8hec8q9TCUfEr6iBII3XI5lH2H4mM0XPsJQ+whDH2HoIwx9hKGPMPR4sWmEYT/SlEsyfjXx+MfjH49/PP7x+MfjH49/PP75MfDPSNCZRz4e+Xjk45GPRz4e+Xjk45HPE0c+tc/jmlwIqCqcC/wNUOShjoc6R63xbrFROxHwV7ge2Jazq+7ic3W9CPr7i6DvjXsPvBLHB12J3a3knGNK/NTq5LhS3/Z0Nq3/UzuUeb3wK1e43FYIasS22DFTWw5o9ZKsbImaEIpS8lmGVLWiSpCd+wHlg/ZP3xUYskyPYmPh57E7aOObum6BawnU++p2qeKsAVYFGVUr1lwylYpEmSuz3frl+fNNsvArGhI4BEyBeLFbEB4DKptVcnr/VoZzo4Iliyn8q3xuYqYUXbASUXiHuHIPbhJ7Sis5l1LIjZn/vDnzd6bwvUhIIiyHm4XYlWJBJrleo6HjFaOSyX4GhO3Pf8Drj5leirB12lownCNyuVs9W62HM9X7ulFc6FvLBWco7DWTUeu05TYETXnXlKjPd8XmjYe/EPdVbfGW/njYgjm5KU/gDZu3VZ54/sJgRJgKPga7Hh9qte0/Xjvl5d83Gl8FT+YCm7sU5GYWMOy+CVpasbIP4zkOcGtUF19eMospj1B3mov/V/wA1www33GcF90Xz192nzvQENOkuMpaZzilGduozlSf7tdir7YumZacrZip+RsyTXmUa9AbZZ6oUiLgqMzkkSoLvmIJmW589mmpArNmtxrOOkdGF76Dr3bzfG4Vm6fVbp1u1qb6w5gE4NGvX2dUsQ8y+vYN/vxnxqTZqSFXVqihJnXHgt/JBU34F7v7s5hJHtgFzjlYIHZMGksVtYRcDMP8ojtt4QZ0d+aBM3lmS6aFJ2Sj6tUBE3NQKlmX5+UmvPk6QQFAzAHBUp9tDaZWPwhYqks9bMiwyvF/c/6+hSWcywesdqDKttLq7L5+NU+8hwrD377lk8WKwzDBb9/+PzsoEh8= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the managed identity associated with the given `managed id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-organization-quotas.ParamsDetails.json b/platform-api-docs/docs/describe-organization-quotas.ParamsDetails.json new file mode 100644 index 000000000..c3093431e --- /dev/null +++ b/platform-api-docs/docs/describe-organization-quotas.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"include","in":"query","description":"Optional array of specific quota names to include in the response. Omit to retrieve all quotas.","schema":{"type":"array","items":{"type":"object"}}}]} diff --git a/platform-api-docs/docs/describe-organization-quotas.RequestSchema.json b/platform-api-docs/docs/describe-organization-quotas.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-organization-quotas.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-organization-quotas.StatusCodes.json b/platform-api-docs/docs/describe-organization-quotas.StatusCodes.json new file mode 100644 index 000000000..93c5db555 --- /dev/null +++ b/platform-api-docs/docs/describe-organization-quotas.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"quotas":{"description":"Resource quotas and usage limits for the organization.","type":"object","properties":{"maxWorkspaces":{"type":"integer","format":"int64","description":"Maximum number of workspaces allowed in the organization."},"maxMembers":{"type":"integer","format":"int64","description":"Maximum number of members allowed in the organization."},"maxTeams":{"type":"integer","format":"int64","description":"Maximum number of teams allowed in the organization."},"maxPipelinesPerWorkspace":{"type":"integer","format":"int64","description":"Maximum number of pipelines allowed per workspace."},"maxParticipantsPerWorkspace":{"type":"integer","format":"int64","description":"Maximum number of participants allowed per workspace."},"maxDatasetsPerWorkspace":{"type":"integer","format":"int64","description":"Maximum number of datasets allowed per workspace."},"maxVersionsPerDataset":{"type":"integer","format":"int64","description":"Maximum number of versions allowed per dataset."},"maxRuns":{"type":"integer","format":"int64","description":"Maximum number of concurrent workflow runs allowed."},"maxRunHistory":{"type":"integer","format":"int64","description":"Maximum number of workflow runs to retain in history."},"maxLabelsPerWorkspace":{"type":"integer","format":"int64","description":"Maximum number of labels allowed per workspace."},"maxDataStudiosRunning":{"type":"integer","format":"int64","description":"Maximum number of Studios instances that can run concurrently."},"maxSeqeraComputeComputeEnvs":{"type":"integer","format":"int64","description":"Maximum number of Seqera Compute environments allowed per organization."},"maxFusionThroughputBytes":{"type":"integer","format":"int64","description":"Maximum Fusion throughput in bytes allowed."}},"title":"OrganizationQuotas"}},"title":"DescribeOrganizationQuotasResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-organization-quotas.api.mdx b/platform-api-docs/docs/describe-organization-quotas.api.mdx index e1ce7fdd6..3f9fc2e5a 100644 --- a/platform-api-docs/docs/describe-organization-quotas.api.mdx +++ b/platform-api-docs/docs/describe-organization-quotas.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the resource quotas and usage limits for the organizatio sidebar_label: "Describe organization quotas" hide_title: true hide_table_of_contents: true -api: eJzdV01v4zYQ/SuETi1g2Gm7LVCfmmSzbdAuNuuku4cgwI6psc1EImV+OHEN/ffOUJQtx26SbZ1LAQOyxOG8NzOP5HCVeZi6bHidGUvPm16Wo5NWVV4ZnQ2zEXqrcIFO+BkKi84EK1HMg/HgBOhcBAdTFIUqlXdiYmw0JGeg1V/AXoTKUXs1UZiL8TIOT9UCtfhCVuf5l7742HjLcaJ0B6Tjs1IVFjToekKasgoeBeqFskaX5Ju+MhNDrsm0AE9TSjFB8IGc9bNeZiq0kcx5TkG9jSGO8UOHZcOBTCuwUKJHy1lZZZpeaEqkSqOKk1KBn2WPM9V1JnQo0Sq5Cd0yC4vzoCwSBW8D9jInZ1hCNlxlflkxitIep2jJlCMA33z66U1W1701FaVlEXJsycwD2uUum/gHCgHWwlKYiXAVSmIim9oJdkZFNSK5o2db4spoh33xgbLPBjZJQEBRpMJzMDvkIxKz8li6znczvkXpKYT6hlPQuI8G3x8d8eMR89/JhzSUCe15FKqqUDKmdXDr2GS1i50wqHqWS+1VA9Cw3cUY/Rsdc9BPw5Xw8NnYO1eBRPeSsj6u2nt4UGUoWT5jkjJV7X7tj9Nv7mkNpUJtU6t7jP4eed6BoMvG2UtwrxDKA6F6dvUSzIt2S7hAu876YTisd5s1DyryphRrBkCVl6oC2oFegUTH+9M83gJpGF+DQ548P43/iVRCHhg/UTkM+iL53UJPlFrsUdAHEh5tOTJYS7tOjHBCkMKGDXoH8TflvKFN92ArfAPW7LdAuqffrMFpkf+AMRavUOUi+n1eY5c+5Mo4SoBWenoY7OSTonUetIx9BnghQXM+OkUp1mm4xDkd5qdNG5AeZ3pxIBk03sXpni5jK0P7tqR3gfV6NbMmTGc0/WTp/9s50DiklLQeWRVj9tpRJWF75Qt81IOkhqY7/M99zygdy3xK04Q3+w7mE8gFdzDo/Nec0Jum5zqjloNPWW4znzlJk+Emd46aEBJdN5wza43dYf7Dnpai7f6ENr7NXHTlkOSl/DK2eicIFu1xoOZueH3D3Qr1gTPDHeMUI0fu+4bZgFvlwSq2hPVg3jaODu2i7RqDLchw5n3lhoMBVKovCxPyvovq6iuzU/Kku4u2ez1le3F8cZ4xkZbnJae1SVGX7TpLjNj2Zvw+jkb0pfnzrpXd7b2P8Ss9MXF6SmliwbDPEeRwFS/Yxpj1ADLqYTv4bsgkCVVE1U/ML5sBIpL2ehr7rv/zj/0j/lYZ50uIckqtbyvg7fvFugJbhFcbif5fbjGpyB4f/IAMqP2nLMVsr5I20zWulw3bC0tKDmloRulki9VqTCfon7aoa/7c3B9YtLlyMC54pU6gcPhEPl//drE31Dtcbt1/FlAEtopLZAFWMf2vDOWbUdqfvhUvuMHtpdXef/Syy6ml2xSiviHDGUJOq5EJNmPHUmLlO7N2ttKtXejXsyuyhe0l/2iJR+97GVHdo8WVuUNNtW8Jen5ngnX9N7jOrGc= +api: eJzdV8Fu4zYQ/RWCpxYQ7Ox20YNOTbLZNmgXmzppewgCLC2NLSYSyQyHznoN/XsxFGXLsZtkW+fSk21pPO/NzCP5uJKk5l7m19Li3MubTJbgC9SOtDUylxMg1LAAL6gCgeBtwALEfbCkvFCmFMGrOYhaN5q8mFmMgRbnyuivirMIXYIhPdNQiukyvp7rBRjx2eL8vPw8Er932UqYaTMAGeR02kGtDfhMFLZxgUCAWWi0pgFDPotMLFWAwtWKZhYbMQNFAcGPZCatA4xkzkuZy/exxCl8GrDsOMhMOoWqAQLkrqykUQ3IXEaqMpOam+IUVfJxp4bJhAkNoC42pSOzQLgPGqGUOWGATPqigkbJfCVp6RhFG4I5oMwkV6Coe/TjO9m22ZqKNkUdSujJ3AfA5S6b+EXVQiGqpbAz4R0UeqaLbnaCk3lBVqR0Qpt+xM4aDyPxqdHEAZgkIFRdp8FzMTvkIxKzImj84Lmd3kJBsm3bG25Blz4GvD064o9HzH+VmSysITDEb5VztS5iW8e3nkNWu9gJI5MOedSkO4CO7S7G5N/omIt+Gq5RX/6yeOedKsC/ZKyPp/ZRfdFNaFg+U0Ce2sM6H7ffPkDZD2qbWpsx+kfg/x0IuumSvQT3ClRzIFTiVC/BvOi3hAvAddcPw2G926x5OMDNKNYMFJIutFOGXoPEIPvTPN4rUh5eg0OZMj+N/yeg19YwfqJyGPRFyruFnij12JNgDiS8wpoiIIKhWOGstg8CwwZ9gPiL9mRxebgVvgHr9lulDUu/6nB65N/UFOpXmHId8z6vsUsKpbZ+EozRZn4Y7JRTaONJmSL6DEWiUIb7MRhKvW7DJdwDqtPOBqSPM7M4kAy67OJ0j8vY6tC+LelDYL1eVWjDvHKBTpb0386BLqGgdUZWxZSzDlTZZpI01fDIgyRDM3z9z75nko5lPqXbTL7bdzCfqFKwgwFP33JCb0zPtWzA8ynLNvOZkzQFbnrnCVl0w3LOEC3uMP9hj6Xo3Z8wlvrOxVQeioCaltHqnYBCwONAlcyvb9itNECVZcc4h8iRfV8ux2yVx6toCdvxfW8cPeCid40Ba5nLisj5fDxWTo+K2oZy5KO6RtrujDzp7qJ3r6ccL44vziUT6Xleclu7Fg3ZrrvEiL0349/TGCSz9OVDL7vbB4r1azOz8e+ppYkFwz5HkMvVvGC7YNaDKqIetosflgyN0nVU/cz+tHnRZjLt9TKXb0Zvjt6Ojvihs54aFfWUvG+v4O0LxnoEW4xXG43+X64xacoEX2jsaqUNdym2e5XEme5xmcz7G0tqzk0mK+uJI1arqfLwB9Zty4+7CwSrttReTWteqjNVe3iin69/vdhb6h0sty5AC1UHjoprZKFQM/1vLOW7SdqgvhcvuMLtpdVfgMxyyKmn2w2ivWkzWYEqASPB7t1xUYCjwb929tKtbejnsyuZSbW95h+t8Zh9L6PVqou4sndg2nZNkPg3E2zbvwGuzqyM sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the resource quotas and usage limits for the organization identified b id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-organization-team.ParamsDetails.json b/platform-api-docs/docs/describe-organization-team.ParamsDetails.json new file mode 100644 index 000000000..77a4c6e23 --- /dev/null +++ b/platform-api-docs/docs/describe-organization-team.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-organization-team.RequestSchema.json b/platform-api-docs/docs/describe-organization-team.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-organization-team.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-organization-team.StatusCodes.json b/platform-api-docs/docs/describe-organization-team.StatusCodes.json new file mode 100644 index 000000000..d21073abd --- /dev/null +++ b/platform-api-docs/docs/describe-organization-team.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"team":{"type":"object","properties":{"teamId":{"type":"integer","format":"int64","description":"Team numeric identifier."},"name":{"type":"string","description":"Team name."},"description":{"type":"string","description":"Team description."},"avatarUrl":{"type":"string","description":"Full URL to the team avatar image."},"membersCount":{"type":"integer","format":"int32","description":"Number of members in the team."}},"title":"TeamDbDto","description":"Team details including ID, name, description, avatar, and member count."}},"title":"DescribeTeamResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-organization-team.api.mdx b/platform-api-docs/docs/describe-organization-team.api.mdx index 3d240e8f0..77b6a90ea 100644 --- a/platform-api-docs/docs/describe-organization-team.api.mdx +++ b/platform-api-docs/docs/describe-organization-team.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the team identified by the given `teamId` sidebar_label: "Describe organization team" hide_title: true hide_table_of_contents: true -api: eJy1Vdtu2zAM/RVBTxtgJF3bDVie1utQbNiKtH0KAlSxmUStLbkSnS4L/O8jJefWtGlWbE+2KF4OqUNyJlGNvOz0JIIqvOwnMgOfOl2itkZ2ZBfQaZiAFzgGkQEqnXthh+HINkJnYFAPNWRiMA3ikZ6AEbd8e5HdtmQibQlOsceLjHyehggD+OlGyujf4eKalEmxVE4VgOAY00waOpCBdSMyTKRmRKXCsXwKc9WVMFUBTqdLZI4xOHiotAMCgK6CRPp0DIWSnZnEaclRtEEYgSPVoXWFwij6dCjrOllAiUltxcKp/AcMfTb3pTUePFvs7+3x50kdvpFpasmLQb5VZZnrNJSlfedZZbYZ1A7uIEWuvuOHQh0DcKq7afGrvp7CznWqk6baC5+eSGhGL3gg1WCzdreT6YooeFAThcrduPx1+/Mqz8VN97tAu2yFaC90oUYRUgHFgLh8Yqv4HFtLdLC/EeVHxfbcbo0noc0iXIuJKVFjDk1Cp4NTtC+lGjtXmzSvMspIXJwmoXbJahmSJgf6mqwJKlKGvx5t3sLsu9uwkhRY5fA5Xh6rTDD5wePfEHTZLz2qpfdUVx5R2xk5V9x4w9UEzpyzbgP5wTMdNR9dwlgUKs/tI+FhdQ9p5TROw6Q6BuXAHVU0Dzq9PjcrjbGx5XE3goCRR0VHtmmW+fYsTLS6HYZuexZ7qJbs003mw69iHsoxYuk77bYqdSvNbZW1PDwQpJbefOmrcCMuc4VMLHHC+uLo8kIyoDneKy5vLNUq6kW1OKJsZhOfB0GJJPHnfE7Zu0cMddBmaIN5U9oGBYd9DSCnq1NaLlGZeaHSwIv15FdTJmroPHTM0H5ZXhAQrlyM86H1+WNrj2Wl9VioQKtmgs+pK+zqzsC4f57MkAVR/9EebCqM8AvbZa5ohxDEKs6bSJAeLztPqp350ouLmQTNpKWXHFNSrDqbDZQHmld1zWJqL8dspN+JcloN+DmISJn2/E9cHKrcw5Ys33Wbhnsvdtioz2bTCJWZSoaRV3yi33uYLjY579M3gdqyWt8Apilo3SfNMaiMSM7lipdHaQolrphtTKq1Jv96dk26ar2TnnRO8P4sJHrIoHFt78HU9RIhnxlgXf8B0GdR7A== +api: eJy1VU1v2zgQ/SvEnHYBwk7TYg86bdq0hdGiW6TJyTDQsTSWmUqkQo7cuoL+ezEU/RWnTrZoT7bI+Xjz+GamA8YyQDYFJqwDzDQUFHJvGjbOQgZXxN7QioLiJamCGE0VlFvET/FRpiDLZmGoUPN1PC7Niqz6LLeT4vMINLiGPErESQEZXMYMc/rPl2jN93hxTViDhgY91sTkBVMHFmuCDJwvJwVoMIKoQV7CfZj7oZRta/Im3yHzgsHTXWs8FZCxb0lDyJdUI2Qd8LqRLMYyleRBw8L5Gnk4+ucF9L3eQhmKOolFSvkDGGbiHhpnAwXxOD87k597PLwDDbmzTJblFpumMnmkZXwbxKQ7Turmt5SzsO/lodgMCaTUp1nJqz5ewpN56nViexszsDe2/EkErCn6HNw9yXXvKEbAFTL6G1897v+mrSp1c/Vesdu1wuCvTI3lAKmmek4+vHLt8BwnKXp+fpTlQyv+0m4pkjJ2m24kwgQ2XFEq6HJ+ye5npQ6da2xetYWxpZpc6sid3qdBpxq0QlukpCoX+IfZNi0ssa+SKqHvxeTFQ7p8iYUS8VPg/yPQXb9MoaYQsCQZUacVuTE8esP9Al577/wR8ucPdNRmdCnrWGFVua9UxFCB8tYbXsdJ9ZLQk79oeQnZdCbNWhMvnYy7kiJGGRUZjJ0vw7iLE60fx6E77oYe6kFi+tVm+LWiQ1gyNyEbj7Exo7xybTEKdEceR+b4pT/FG/WxQhZhqVdiry4+TkAAbfB+EnoHqvZRb9mSjJBmk3zPoxHo9OfNRrK3XznyYOzCRfdEbUIhaR8DKOWanEIyFl1gHnVxWPx+yVSjqWLHLNy/u4tegzA35Hk2enZ2PjqTw8YFrjHqKo3wjXaV218aPCyge0Nkq9TftAgTxUzfeNxUaKxAbIeBMyhkKtsugIZss/WGzawhS6N2pmHpAotp180x0I2v+l6O71ryIseZhhV6g3N5j2kHhQnyv4BsgVWgE1X+dZU67m/1hJX6YDXpEO0aBEbVyhdo+ELr7SqXhfpLoE7s1l8AkwjtZ72GJWFBPtI1XF7kOTW853Y0qg66/O3ra9CAh610r3Vi9Achdd1gce2+kO37HUL5FoB9/wOV2VIR sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the team identified by the given `teamId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-organization.ParamsDetails.json b/platform-api-docs/docs/describe-organization.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/describe-organization.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-organization.RequestSchema.json b/platform-api-docs/docs/describe-organization.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-organization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-organization.StatusCodes.json b/platform-api-docs/docs/describe-organization.StatusCodes.json new file mode 100644 index 000000000..0444a60ad --- /dev/null +++ b/platform-api-docs/docs/describe-organization.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"paying":{"type":"boolean","deprecated":true},"orgId":{"type":"integer","format":"int64","description":"Organization numeric identifier."},"name":{"type":"string","description":"Unique organization name."},"fullName":{"type":"string","description":"Full display name for the organization."},"description":{"type":"string","description":"Organization description."},"location":{"type":"string","description":"Organization location or address."},"website":{"type":"string","description":"Organization website URL."},"logoId":{"type":"string","description":"Logo image identifier for the organization."},"logoUrl":{"type":"string","description":"Full URL to the organization logo image."},"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier for the requesting user within this organization."},"memberRole":{"description":"Organization role of the requesting user. Accepts `owner`, `admin`, `maintain`, or `view`. See [Organization user roles](https://docs.seqera.io/platform-cloud/orgs-and-teams/roles#organization-user-roles) for more information.","type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"},"type":{"enum":["pro","basic","academic","evaluating"],"description":"Organization type. Accepts `pro`, `basic`, `academic`, or `evaluating`.","type":"string","x-enum-varnames":["academic","evaluating","pro","basic","internal"],"title":"OrgType"}},"title":"OrganizationDbDto","description":"Organization details including ID, name, full name, description, location, website, logo, member role, and organization type."}},"title":"DescribeOrganizationResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-organization.api.mdx b/platform-api-docs/docs/describe-organization.api.mdx index ca4931384..a3dbb5110 100644 --- a/platform-api-docs/docs/describe-organization.api.mdx +++ b/platform-api-docs/docs/describe-organization.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the organization identified by the given sidebar_label: "Describe organization" hide_title: true hide_table_of_contents: true -api: eJytVt9v2zYQ/lcI7qUFZDvbugHz09KlHYJ1W+EkT4EBU9LZZiqRCknZ9Qz977s7SbZkq4077EkUeffxu+P92sugVl5OH6V1+J1HMgWfOF0EbY2cyhkEp2EDXoQ1iBSC0pkXdsm/qKKM/keRrNApmKCXGlIR7/h4pTdgxAKlbtPFWEbSFuBY+DZF6Bu+KIa/OygoVCincgjgiNVeGvxBYQbBU02kChXW8pRpF0aYMgenkyMpR/c7eC61A7w8uBIi6ZM15EpO9zLsCrpFmwArcCi6tC5Xod76+Y2sqjmp+8IaD540fri6os8Jhz9QNbGIYgKdqqLIdMKUJk+eRPbnl9r4CZJAljtyUND1BV3nvixdqJ02q45cbG0GyrCbCgdIorW7ihpvXmD3NzsZwesXO2B7DCBkdor0YPRzeRJCpMkQyzLL/roI5j1KilT7IlM71hdowVlwMmhP8SXcnqGdI0bKbHL6LJfAtGpITag0xXDyDLeF2OtwgbE9tEZLPMw+NKRWtveoXwD5gHJC52oFnYf7stcI9sFlF74EkhHBnheH7HApg+aQx+D+Wwj+yboDwXewgdIcfECSovS4v9VhrQ0eaX9uX01lhskykM5dExyKtIXv5IaxuE4SKILHYrc14BaRWKg014YWuUI7FK+R32KjYbsYizsA8djDZ6p0iZ+/WodQ+OlkktrEjz08Y9kcazvBIA/knVGS2TKdUMUeKZOOAqjcT1j3u66BI8Ic8f5r9k5uHb66qT3MHojOXhXQs9wPyBLZOojrWpap2GIFt44axecRiY42ylHe+Yt0gg7kaPIsu7xq798f7sW6hoqx8jrBr0pUCjkvYaOyUpHTz9tUz5OE2HkSBKR3YER+mQayeZAj7GLIHQNWDnOKTphTQKNOdmL2PeFXVW/vQP0mvgn2pVpUt2BtkqxMKQJvbyKufJGgstksOwjRofBEbdGIOCEjUb8TR10kMJL6Sct+7HEdatmzpiuiIIm+GeqLb1Xa5sy3NMhjv37EkPIeywd786udsBU8K1hdQ945Z90Z8x8HSkA7sghjg1BZZrfIh8Q9JKXTYcdTyltQDtx1iXPJ9HFOwwKOMGtLY84KmCONLFPJOTvZc/+tJIG4TTvplFRlZZv6qtBjTvNj/p8Fxh2fiI9NWRC/kby4/ngriUFL8I78WfumS/PgHrpRNsMQTw4sRJHMi/dtOX7aBjac6gerN75sWNC1LxEkc3WCw2QtTIGgEg6EvvFdkzEWdMbdYGl/PR4gEfJcfc/3419+Gl/RXmF9yBXHUTM5tjHbi+1TpvtjUP6/I2/j4wCfA5VvHF+RZFn30zommsk7ktN6KsOXW6MRdLDfYzEB7L5VRduYP47CDZdYjrSKyf0YODj+0BqDbakyD18x7dWsyajX4oJxeZB7s6nMThKNrKQ/XH6C3WFMr+YouAasko4J1md1Qe5onSV/L29+f3dP9b8fqyexyeiDjNB1LHFvP4GpqgPBQP9EsKr+BVQYiek= +api: eJytVk2P2zYQ/SvE9JIAtL1Jgx586qabFIumbeDdPS0MeCyNZW4oUktSdlxB/70YSrIl28k6RU+W+fHmzeN8VRAw8zB9BOsyD3MJKfnEqSIoa2AKMwpO0Ya8CGsSKQVU2gu7in+ty9Cof5DPCpWSCWqlKBXLXdzO1IaMWFiX3aaLMUiwBbl4+DaFKdxEQ0v6u4cCEgp0mFMgx6wqMJgTTCGCgATFpAoMazhm2ocRpszJqeRAyrF9R8+lcpTCNLiSJPhkTTnCtIKwK9iKMoEyciBhZV2OoVn65R3U9Zyv+8IaT55vvL264p8jDn+AhMSaQCbwLhaFVkmkNHnyfKQ6NWqXT5QE9tyxQEE1Bvrivny6wJ0yWe/c0lpNaKJMhaMEQ+d3LVs1L/D7h0WuZftie2wfHDM7Rnow6rk8CiG+GSFWpdZ/XQTzsdRapMoXGnfxvlhZdxKcEXRw8SXcgaO9rYikbXL8LJfAdNeEdQLT1JH3EW5LS6/CBc4O0Npb4mH2qSWV2cGjfgPkk82sUDlm1Hu4b6vGsA9OX/gSD7NPItjT4qD3RiNoTvmS3H8LwT/j3TPBt/eB05x8UCYTpScntiqslRFhrfypfw2VmdV0Jp37LjirqSt8RxbG4jpJqAheLOzWkFtIscA0V4Y/clQmYPy2Tiw2iraLsbgjEo8D/EiVjfj5q3UIhZ9OJqlN/NjTMzkcKzspNAZWZ5RoW6YTrtgjNOkoEOZ+Eu/+1HdwxJijuP46qpNbR0KZRuGogDx5VTJlHvsBewKdQLGuaY1L6zBYx43i64iPjjboOO/8RXeCCiw0Kxslrzv71d5u4SxIWKJXCUjABFPK4ydtUJfIop+2qYGSjNh7ksJZfoeIGF+mhWwf5AC7OCfHGS/Pc5JHzDmgnUF95PY949f1YG1P/WZ5E+xLtahpwcokukw5Am9vZKx8UnDZbD97CHJfeGRXNGRMSCmad4pRJwWadJi0UccB13Mte9Z2RahrPvruXF98j2mXMz/SIA/9+hFy8h4zimp+txN2B08KVt+RD85Zd8L85zMloBtZhLFBoNZ2S2mE8pSUToVdnFLeEzpy12VYw/RxzsNCTmFteczJKHLkkWUKMWcnVey/NTCI23STTslVFrrUx0KNY5of8v8kMO7ijvjclgXxG58X159vgRl0BO9Yz0abPs29PGwR2mEoTg7xEEdy/PjYleOnbYiOc/2I11stWxZs9iWC7K5KyLeHORAwiYEwdL7vMuWodOwGK/vrYaOWwMo1dt6M31y9HV/xYmF9yDEGUjs6dkE7CO5jqtUhKv/fmbcVOdDXwPVbGSZZNg21CYp29JYwbcayuYS19YE3qmqJnh6crmtefi7JcbzNJWzQKVyy/o8VpMrzdwrTFWpP33Ht1axNqdfignn5LPd2Ec0OmIYu+R9I+EK7/Zxez2sJa8KUXCTY7DUVuXfrJPsHifP7h3tuAMNgPQrOiH6WUVU1J+7tFzJ1vScY+D8TrOt/AW7cig4= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the organization identified by the given `orgId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-pipeline-launch.ParamsDetails.json b/platform-api-docs/docs/describe-pipeline-launch.ParamsDetails.json new file mode 100644 index 000000000..9c718b90a --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-launch.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"pipelineId","in":"path","description":"Pipeline numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"sourceWorkspaceId","in":"query","description":"Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace.","required":false,"schema":{"type":"integer","format":"int64","nullable":true}}]} diff --git a/platform-api-docs/docs/describe-pipeline-launch.RequestSchema.json b/platform-api-docs/docs/describe-pipeline-launch.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-launch.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-pipeline-launch.StatusCodes.json b/platform-api-docs/docs/describe-pipeline-launch.StatusCodes.json new file mode 100644 index 000000000..7c4350430 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-launch.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"launch":{"required":["dateCreated","pipeline"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"computeEnv":{"nullable":true,"allOf":[{"type":"object","properties":{"credentialsId":{"type":"string","description":"Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)."},"orgId":{"type":"integer","format":"int64","readOnly":true,"description":"Organization numeric identifier (read-only, set by system)."},"workspaceId":{"type":"integer","format":"int64","readOnly":true,"description":"Workspace numeric identifier (read-only, set by system)."},"id":{"maxLength":22,"type":"string","readOnly":true,"description":"Compute environment alphanumeric identifier (read-only, generated by system)."},"name":{"maxLength":100,"type":"string","description":"Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters."},"description":{"maxLength":2000,"type":"string","description":"Description of the compute environment. Maximum length: 2000 characters."},"platform":{"maxLength":25,"type":"string","description":"Compute platform provider.","enum":["aws-batch","aws-cloud","google-batch","google-cloud","azure-batch","azure-cloud","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform","moab-platform","local-platform","seqeracompute-platform"]},"config":{"description":"Platform-specific configuration. Structure depends on the selected platform.","type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp (read-only, set by system)."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp (read-only, updated by system)."},"lastUsed":{"type":"string","format":"date-time","readOnly":true,"description":"Last usage timestamp (read-only, updated by system)."},"deleted":{"type":"boolean","readOnly":true,"description":"Deletion status flag (read-only, updated by system)."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"}],"description":"Current status of the compute environment (read-only).","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]},"message":{"maxLength":4096,"type":"string"},"primary":{"type":"boolean","readOnly":true}},"required":["config","name","platform"],"title":"ComputeEnv_ComputeConfig_"}]},"pipeline":{"maxLength":200,"type":"string"},"workDir":{"type":"string"},"revision":{"maxLength":100,"type":"string"},"configText":{"type":"string"},"towerConfig":{"type":"string"},"paramsText":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"mainScript":{"maxLength":200,"type":"string"},"entryName":{"maxLength":80,"type":"string"},"schemaName":{"maxLength":100,"pattern":"[\\p{Graph}&&[^/]]\\p{Graph}+","type":"string"},"resume":{"type":"boolean"},"resumeLaunchId":{"maxLength":22,"type":"string"},"pullLatest":{"type":"boolean"},"stubRun":{"type":"boolean"},"sessionId":{"maxLength":36,"type":"string"},"runName":{"maxLength":80,"type":"string"},"configProfiles":{"type":"array","items":{"type":"string"}},"userSecrets":{"type":"array","items":{"type":"string"}},"workspaceSecrets":{"type":"array","items":{"type":"string"}},"optimizationId":{"maxLength":32,"type":"string"},"optimizationTargets":{"type":"string"},"headJobCpus":{"type":"integer","format":"int32"},"headJobMemoryMb":{"type":"integer","format":"int32"},"launchContainer":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier associated with this launch."}},"title":"Launch"}},"title":"DescribeLaunchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-pipeline-launch.api.mdx b/platform-api-docs/docs/describe-pipeline-launch.api.mdx index eb77c4e9a..5c5dec99c 100644 --- a/platform-api-docs/docs/describe-pipeline-launch.api.mdx +++ b/platform-api-docs/docs/describe-pipeline-launch.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the launch details of the pipeline identified by the giv sidebar_label: "Describe pipeline launch" hide_title: true hide_table_of_contents: true -api: eJztfXtzGzmS51dBqGN3pDiRtGVPx6z/OuphD68lmyfKdsx6fSZIglSN6sEuVEliO/TdLzMBVKEeJIuU3G3TmIhpiyQeCSCR+ctEJvB1L+Ezuffq097cmwvfC4Xc+3y4NxFyHHvzxIvCvVd7lyKJPXErJEuuBfN5Go6v2UQk3PMli6b0ranOvIkIE2/qiQkbLeinmXcrQjY0JXqTYXvvcC+ai5hjB70JdHFKHY5EXxc6p06g2JzHPBCJiJHIr3shfIDieVtQxEMa5zzB4kXCTWssTAMRe+OcuBhJiMXvqRcL6D+JU3G4J8fXIuB7r77uJYs5duOFiZiJGIpOozjgifrq15d7Dw+HGS13UXwj53xsEfN7KuJFhZqPpuAScrbrXkZpPBYfmxIxoOLsbhUt7L2E1bu7hlXj47GQ0gtnjDN5zWGy8pWexlHAeBjBGsd5g8WJnXJfbjSzh3th6vt85Au1Kg8Pn7E9OY9CCbwJLRw9e4b/FIf17jeoOY6g1TDBX/l87ntj4q/OvyUW+VolIhr9W4wTZLIYuTHxVAeKwfGvfByf9iY8ESexgP/iDJtJwM2yujVvgv8N+P25CGfAo6+OjrIqEvZVONt7QNKDeZqIs/AWSxen4HCP+/67KfG/TREMd+rNcMaQE6Bfnyc4m7XfrCisf1o7kjH0izwCS9qbWNOoR1HmtJO8uMVcDDplerRMhLdeHIUB/Mh4CnwEhdSitdmlGqlk4t6TCXLg2I9SYL84uoXm4s4/+yfMIqnNBkKwT2qJ7B8+718nyVy+6nQm0Vi2pfgdBE/bizpmClp87nXGVK9l1Tto48JE8aww2BWMCy1M3oX+wqxaiUPjGQ+9P2h0NZuO7WP1VgT1D5kUCQpPuZCJCBQdtpR5AmpWyaJ1pDTg6HXdn9QxgD+/5muomYkQtYbSLTZNShgWqHr+7FmVrCIZ70MPpCTDysSXqK1qeLPNLlKZwC+hBFZEjfe8Ba0XKD5kEy6vDxm0kobAnnIcxdAYiEw+Ru1FVBZ6L07hs/XUnuafjNatJ5bfe0EaMJ/afsWw7TIl2fYvkfH3KhECRojiht/J1ognpJXxb9qO8Pcsima+aPneFOjzRAgKI//WVNAfTR3+RxrnP6pP5rebf8iWJZ3ETeHj7EbYH9NZ4aP0U9jP1he+nNofuQ+gJba/CSI+KlSIxtwvNEnyQk90oa3V89Fo5BuNdd3gSnNRHll17H/uWB+xyn/ZyCtQ2AguUyJTR22lxUmTVtBJ32gaORdjkGpjpkqmsVZ2AxCS4wTmB2D1XIQTgNUhbXApfFDFiLp0EwivVqtp1BSnXrxeQaMOYBPQseMkihcMETRJQQkfUd+icokDMfFQoWKrUz+6Y1PPF1qGxOIyDQfU4vreupMJYkj6BobGE1DsYgxzCehAjTWctrRtoUvNYw+FcgQFbqMbJOmtuE+IChgyAlNh1H4fpo6HME2RTFpxGuomGih/YsiO6rjDJ7ccBNjkFxhbC9prmfZauj2lbfDbpxk6n8IcgyLxa4bGrvmtEvE+GECTv2SklmKxxsnjmKNp4YH+lesBtVHOq2fpzMICtzz2EACTaiZCbrmfbtsI1aVWrgFKWI2MosgXPKwuGFgPaLt6Mm8E2BCZNFsmbIr9Oxq1Lfj+RE0brQ6t4057OCzAfg3g1YQcFj8ihvcSNBxAUqGEgfn4oLupAJDayZJIDYI+vSnrEAYBLk3sSSby1u4BD//kvj1OSwhiv2i1LTSfl0qR3NmWxw2xLdVWC9tS/D3xkMjACzkIvfWjMIKcYTFWqFxFzRytaBhYpiuUMIeWDtoVhPxQR4zeRou3ytQv/g56DuYLqUQMV1B5OA7NBhfwQ3GiaxRIbl8+kWrJFu+uqGO0Vhv7gKdF/DdpfAq4IBrPa7A9QinH+EhGPulbVE4o9iwDjQVYkIQkTf1dDPJIeyycgvpJFNSOyCFVstHeOs120921iC21AXMjn2j3sN6URYGXwKqCYSumPPUT0gxDLQKGRHUqRfy2kXJ/DyUzM3sw+CfOZqiEITaLvhxSqGE00ZoaVrtZ0/+EktQ0tNzrMz6ZxDAEtJCrrc6jOFnrPnlxVPWaAsVYt81O1WS8YsOjo2GGKf5vKpqgk6tr7WzQ5vvvWK0kFFmKagPmRIuaAjJQ2xJNBgt1bNF5bcfQ5921B11mHl4EIAwENJPpSHFDm50AYwF7Rbcijr0JcJNx82e1irYNEhrweyJy4P0htpl+JD3QXo0wDUZALAyCqMu3J9ClyDR4Sg1SQi2w/0IRpRI3db6Az589y1fw/0Sjd9Sd3EiG6B4jVTVzItWjRFSmfAbW1D+XdbgMNcJ2JDcaGxZpHdLqwG5WMstTnGNT0MqWrgZWGpDQHcFI+Th5AyuqBSmeMBSV/4ZQyWAXhScR+BTwpJamlglewkPO9tgp2wP+9/nBdiRZGLX7ccCO8cu1QLW4tuio4DNxRYXqVgegw5gObAxLoaSLxbLTi0rxW1CfgZANuC8/ySnxxPGA6VZwqoMoBebYV+IORFAH1VwH1fOrDp5ecZCfMX0ebmWfPH7TxWKmvdNrZCCsmSqrYQgoXTpalOzOA7Q4ojMYctXvi/asDaIrlS3BAcM912PbTH3ZTKJGo+Q7ilxAPiGib820UBX5Ity45bzF08vum7O3mdfLoPieD0sJi6F/b4oDZTpH9CAmX2Q0Te5AZncUhR1Uo7eeuDuwyO6FMkG8uJyvCxx2cgTmh6qhzNI6+rNFmD5vH937PJ6J4iqATrmM/Ab9YSnWvXyLLDaLObDzFJi2BX/CPxPW614wYMHAk5I0IpRaJltAwhs406xrbDs23eMoz04GLOHypoSLNkBkdWu/XNRq5futJmqFjPe9PgY4rHdQINLXTeHYTs57ijt8X1k3mVtHC5vscLHW9nBG9E9hRGu+Ppmncht4/jaD5Cf99xLHGZEeXc3TutMLEYAtezHapmNV13SI7L10/x4i/wVixkeLRJ9fOHy5S/gSpBhspLMQPzaZB1WSffqotp8Wh8s3GLZ+YJuPFNqkDMhpijL8aPPOX1NF2/25tH/Vx4EVGFOifAlt4S1wzEAh5Y0JfPvhQuToQuNti4Qq/cqbFc3exFE6bxAkhNLqIyng82gmQVFCNR0jpAfGoDW5S74+tZKDkM/ldZQ0Mf9L7JJVXcMsnVnqTURHmuIH61cOBjQT1QNsBZFe44+lGdSejzb7ZJVpOmfmvB0ksexkpuEv9N8WkdKyihjhd4CxYhHoBR2QWrUMCmFFIYkyje+KxBvRQwwH9p8fLYr4w8TErj91T5aAdRM9M+i/u4KPgNarQQU9G7632RAKDTU5kqUhncPHKZRGJojC1kQEOCob+cMCDLGLvF6x1mAeJXlhtg+jE7jHZKJ4EoyabbX/hReSY450P4VDIGfBpK45QQz4/dZdal/gpl3O5unGIvBN/701y4QbRrILDDgYc3+ZVix6EpZ68zLSJbrr0VeAnN0S93NYX+od7P+bVaNib6OEfuBqne88wP9L9rZn2ZWP8WmcREHAW1JgaDaiPF8HxSEMuxNFviSWVtNGKG2QYJ3ZYtVWOT4bXH153cPtYv780r989+bybDDofTiDr5HTv5x0+92T3tW/vrzrX/Uuev99dmp+6V/2Ts7qfq/svFOMLA9wh7Nr2O9KiijHiSzuL1QVY5ipBYvShARKZnMWNG8dxUOSL/nGzRvFT8OVNKu6xe2rVjMAVdwoDjcFvR2w7kWP9U5xGKlUdq7SWCjwSpLEOkJC2Xruhel96wit7RaK+8D7A7ca9q/snECIRBZY1DiD/iapXxP2pKOd7MMllVEAojxBTQz7AZq+BTRjBTl2A/4HfCp2j83aocS5+wnQJx6hKGQ9HzeZog/9E5wbbC8UCVrDUIoakOkIvnnMbjnXuwP70K2RsSsjHDZNfU47hdQLDkxIUfUUTopTQMIcqiqagO9iL1kQxHoK0kyDGn31TonCiUB/BZq0gkpNQVPeoQ0bpxQmgiuPIC2OfBqFWQk8bAP5xqew4ApTyPsL9HuuX4fXg3tahHNy02pv6TzytPiGhpodCZbasQRhbnRBY9seR61oXkKTKK/fHBv3LVjc4l14CjLFhP02PeuZYB0FbyznKmZl1OEcYHtVQXG+GB/9JhZ93uREGVfvRmAEoBdnB7RWHAUJ9uN0fPM0O4HnsHzwgo1UuybTRNuMyzQ46N5jUCM32y5d7o8vL5WCzKvhwWq1rgFDVfuy/dvnCmaNvElfwDqCaTPbin6DfIyuncfemE50eVFHHDIOU4oORt2ZEaa5FlJVlcOEJ0WN3S4DRvLphxGpBaU3oHPYnZ6v5H4ax8iEEmuphoEfRwJBNIWxKgVAh5DABDlZpfPY/1A2q5hKlcexyXZRxw0SJPgdO3s9qMAfaLSJLjgz6SalNkAsmmYaSrNyA5Y4Q76zLPfc97+5C+HJTyKYLmNR1Q28JlOnIQay1DcgqwLCj6Mo2VYOYF0FrkkMIMlZ+4eWVBBj2dTboHFW0cI0/kg8qcDxwPpnCY0q0mO0yA3YNuvOMfw7d50OOyIZd4AK/H9btT1UXAVEElIw4RsU5MK6PvyN7EtuOCoY8AUqENhkWIfDZ38KOxjpw4JF277GxCDXSD6AwgBLCww2fJsTXANag45CblC1oyBeZyJuQSbA9leeCRhTixrVTpL2dRL42knCYxMp0XxPXKZh1YmJYS6vVWuWU0kiW41X+7IInhcEYW6x4cwFMON+O2sc5jusscZQDGBDhBryxrVqjYNfX2686buXF7++ZPtvYn7rJVFo7w1rPIqsw7Kf8FBRU28jbnMC2Vt7+liMNiFWy8JMlMtpcmkQziau+BxJ9C1njD7JLucwGwRljqVh49msn4fvHlT90vpUPD8pO6x+heENhQQYK8LhDX3PyNu5YZDDnx4B4A78dv/Ab9WB74542d3pnjvd2/3TPWBXZNwm6Lygg3Q9Y9Q0jfoqtKHDv6zwLjTqYu6bAC/Afg0Yv9AmViHYpJXH8j5aHHpZGqeOdadeDLYmtahbo4TtkcBLBnxyW2t/GkHB7niMBtpZwD1/PdUDVQndFmTWCaxG4AcDe5QzQ+m4gtN2I2B1wdE9q3GVmYLweQvbmPB4QpF0hSngZhJKIWG2T7Sx4xhMOe00UL5ecggq00IwfX0LfLKwMiodHW0EAMuYcpkR9OGizT69H8F0pez8apBvBpLtbQWeyHDQcoR2SYd6l51ItvSdM7+k1MYXWOsDptlnno58vDeAyuqYdW1TthHh4TlOS6gtbJt6HExVIebsXPCYBvfhYgVdEyja8nXR1m1gE/gLJnx90b5rIAw/6pkjO+Dk/Wm3NEOwLPooEzkSpKtJ922zd8bTfQhKE6VEK7rDE66xsjL1OE2oJb+FeSGhQxbeNKVc4hhaAyIebWgUefhpDtGgQnIK9jca8G+2Cv7BmoZBR5k5b3jNJGqfhTO6lUh33mbD+STbQMNsY+Auwnsb0OVd2Ed/f8beHBuXob2N/kKzRYnKJzRb7NR8Oy4bv/4xjJbtIxjX434HJh2Y/CnA5DrLb2MAowTIhwvlZDUIZqCl75fTI/nl9oUGi8sgKP2khGDDmDLVq6lkhZR9uDBxZHTG2+hk2IuTFMCirpK3qoGzTEdZ8UYucqLNrmVaCngIKn3So/zMZNGkMUyqbHEpvRkiA92AvjopWVRoLfVw4nvwR5N+Lsotj6mq8fWXbu7SAYAfay+sWtLDeTRjXdCHC2hFWpfT6R6CKPTUpSSm9SvcFM0Og7VfPskEKWKkQofK88kTfhL5OkP/LJzQQc365k+hHmwtU5EJXVOFWJjQxWLrl6nfaFrKbePJu5kTaJoBZydmUh6BR4pq6kbUROcsVz22Z/eCz9tnYJ4tvgzox7b650v1LPhxuMaEexeQTc2X5JK1rxKqumTf/HaWnaBscE2CbuS3dERxGTiOAljZQaDkPL+74PlFZ4dowGkFzlZBPtAvWFLvL88zTW4IXMBebuGNXpjOiIay1ulS+icibjChg8E5G+OuoCAxgoKWVhEmZcncGED2NH5nU6k2cXYbICmQjcaZ1SL5ml14leeWWahJm4dDG/YOCn6kjbqWJW+SFaVXk8hdyM9fShUi86clSa+AAepGbCLz6n1enbTsXk5dGLiT4karZ8fNosSBy37RHbestjS/qQSFE597QTNw0Ed3jcRbYz+QiU9VFUqg03kucTuqsFDV+BLmOGR6TyQYWd3SlYY6mJLCddjwEpbkI96zAYhqMTRewsDcTqF7oPCSZul+FyqkBJP+zD3M2YCM02JMQ1oyGpt7OhnRSiROTtAgUYi7NGvRBJqlH0Fs+d54oeUeHrdr+UZQMA/qjcIvMqXxkiK94wv8IxS35OpZ9evn6pWU9y1stgWWI+3Zde1b5mA/G1Wf6DYbBb4fzMX4kVEeMGdZLvKSLDTjxYU1H5ACj+KhCgPGgEmAucAXeNFogmmiiR2Mi/a7N2GaUvav7sU5rKK5NxDMspjcsSQbhxhw9Wpou7efZoR1kYdGUsDo/4rxOd/MbvlmvlUyaqPU7j8pG7WajLoTp+4lNtBYM8eBtrm24sfP38HlM86h7ITWBkKrgeu06Rk7XnZleyX0EXgLc0FadJytboSgX5uh3HKTNLYmzui1rvIH/T5DzZmTTWHtCVR9ASuMrnJRkPbZmDQtBTu+c4dL5pbaLBAi0yH7ar4OSJmokdPFZ8vDLlaJLgzQb7Cb3styyugTHdqW4q4p0LqQx1XscDxP+7bvrvn8qZkCCGDdnE0+cAqp2CL+opbI2qiMl3odnig2R8rrUw7QoknukD4swvydCdXRmc2jdDbLUtrkdS8opp8sswSyaGkVxmBSg1TTyq+NTV8A2N+GGU6xMvMxJpztP2u9UDyexFGKFxFfA6sYmsfRfPEIorE62g753eVgDvdj7xaAYVfdF9lwU8xVJeuiSYF3tYPq2Q8jBkoAr7n04Wdp7vUcCX+DIIC1SVTLkm9VRxnowz/UFshSx9rOxftzuHidAfXDGlAwjKm8wtvZGrDo29cDpqwollAV9XqDulHb+Pd0mw1T1rDJIPcpVrPUnN2yW3aLC4Spo01ueGwyoPTWBeXK14UFZ3dS01N5oE3CuhhFE3KYREbX2Pc3xgLYIFDJgbjPYUtNUhNykDF5dis6has0iG/pn2SxLdneUtcUNGtgkJVVpyZW7Da0bWuGLKlMBCgdG2xeM61JdnN1zKap7y9av6fcV/nEsZiKGB+dUknQnz5cWKHPuqfGgca6YstUlAeHNCC88oOyMc0P0NQQj7Km3v2hfVi3ViLAPMifYSIayq5NAjnyd6fsEFW84/JHCFB9ojsUlsH/pRcprLoOaYu7ftWtq0c1FnD5dt/NIgWrt9iadpMXbXyDKg2+aa4Desia3pBTvcDGEPJJh+oHeLalrnmFRre+DY2+/kWH7bVUXnVLezBaNDT40jvIg9jJbUPNY7/qOvqRUBcuEPZG6te5iJyJuPsm4o4YS84acdbI7lsj3+g21cdkhPEYlFAiVGiGdQ9F5co8lGSVa98fnUG2tOWtb70qvE20LHvzkXfOFDDOqHAQYq6cKQEclXw2nM1fDEspaBgurVFHAW314whZsRs3PGgc9ooVh3RjvelB3VxjIzOQ8lIiHVzdxH93jYyvY550Fl122ZNJXVRpitnVKXSvIPRCkTwijNLZdfkmfGjQskSbADhlh5rg+Py+Fp+PBcnbfXzF3hf6Dj4TDPtEN+kNam7Qs+/HMyaydanaLuUPlt7nteyzAf7i3h90SNoh6e8aSbv3B937g+79Qff+oHt/0L0/uJveBfX+ICap1eFUl8jpgOePBTxdIqdL5NyWJJfI6RI5XSKnS+R0iZwOb7tETheH/A0TOUGEJ9yLa42uLv3E+scDd0LgDLVdNdR2QiC4EwJ3QuBOCNwJgTshcCcEu2qxqBMCX05rwWrv+IKdD147pOqQqkOqDqk6pOqQqkOqDqn+IEg1Db3kdRSfQ59JfUAzdKDcplSmZh5VmSsuby4F+fzqyzhMvHuYWL0PU7mOSz1mQF+7aBkHbb9naNs41Vm/HVJ4dQ7zmlM5zG/X6cNWXd+Wun9pDmXX6DJ8AwybLN2jtfzleZM+Uj3QLz7mbENxDE5g+S5sFx6/Lb5CZl5SV5NRukaKTVIcbe0BMlXU8QKrBcBtcLVokheevSCDxQp5SfnsVo+ebcJ1XRus5A/QvKQHaJS6CE5KoTVbnFR+uMikgE3fx2uAdjjHEiYYJw9kuX6L7lBJ9hhXWOIFHlS5CtCw5QxUqhAF4CsEarM4ulNvOpfekoN/VKrcM7RuQpaGWV48lhzg780T8LBKy9Bv+NkaJCVFeRK2n3gXngoVONKgeSpqWjJMRYMjopfFKsCcTYSSJ0qd6vzGSzHrTR53w4LJlEQpAKUKD+mUwd4fRHfpReskuhHhqdGF641Qs0W1JTPoDhg1YedsGclRAN1HOsRHzQTeLfIuPMmidqrSoVtgkIk988o8mapnUL7juB8MKCjH/aiBoAStjH8dtlo+IciCNTNSn6LrQO8ugV6XiL7d+3A/iH9wg3fQwtSnZ1UV7KpzpahHcjn7VHl+TT2Stt3lL7m9lV3/Yto9YDxJ+Pg6d0/YaAeF4GGGk7L5rIRhR4VaCB4G2YWB2yYB09DMOGqTgVU2+En0QyRYNL6vW929mLkTtfWgWDp7hJjllyhJ9gmfmo0ZbNI5e8nQ87wVm6hSLf3dLwottPB6KPv7lqWc1l8Q/QR322sfNz5edykwgBnGrJX1Bt45RN8x3vzEAYHRxb3kn9OgTyvmo3+wCQAFXGS1T7Lg7jGQ2UlldgXm+vvZnQ7fJR2+pRATN/X5YV26fIud/TZwrwU6t9lP4zZzSWYuyWxbklySmUsyc0lmLsnMJZk5lO+SzKrC2CWZudcC3WuBP6XQesLXAnO3Is3Apq8CYnXbqWFeBlzz6l+TpwM3fRnQevjP96ZAqYevGUjbC6OfScOfmfn9e3ehLFtI+AnfctzkqPph1WuC66WQCGBUo9oz/4dt3vZ7WPnE3cPql+seVj1ER07kDR6We1j5QtxDs+feHp7gtbanEfcbYprt8EgzMbTiOaqHVQ9LOaW1Y0oLm0pn9ed670PYWgwDns1TRi5JyrnEd9QlvhOml0uScklSLknKJUm5JCmXzr+7iPUzoVYwsktxGOj0ON4ia0mfgl0tlmUuVLI0UNDFSx+gqxRXZ3CPiV4/Ox7okzwVFEUnfvtK2uGhHWq5DmrnV50s3JM+6zP478Y9stzPpVFInpBCr8uAhjDR8steJNxMe9lMokajxDtKXHNql707NEG+CDduOW/x9LL75uxt/t6rxoI9H5YSFkP/3hQGZlGHX2Q0Te5AZHcUhR3UoreeuDuwyO498qXGOvqzRZg+bx/d++hCKK4CqJTLyG/QH5ai54KAxWYxB3ae4vOHs1i9r9jrXpQfD1omWkDAGzTTrGtsOzbdq5cvByzh8qYEizYAZHVrv/aY6VtN1AoR73vNQgqwVBaHjG+xnvcUd/i+Mm48k8Kjhc0jA1CdDb0LNvS3OrRdydN/7pntYfXQ1sHLXYKXLkloSZLQLXCMTibZmMC3Hy5Eji6yqLOMhCr9ypn1bV7I3BFXn1rJQcjn8jpKmlj/JXbJqq5hls4s9SaiI03xg/Urt3Eau3Z8tNknq8zWL2yrFCv6b4tIqU2aMYnVQmY4p2gZ2PFtqEUxZkfhuyLxRvQQw4H950eLIv7QHi25PoE+WQLWTQTloP/uCj4CWkdBVsK1NnxvsyEUGmpyJEtDyryJU3VYzKKwNREBjqrwuCtUwy7yesVag3mUv8sO1oCPca6UlKNz8LxwW+1/4YXklyPdnz0qipl3S7PFjU9w6y61K3DTLh/90K3CDSPZXZOvX/QkLHXmZaRL9Najr4Cy+sX9HC9EwN7pRdoVo2Jvo4R+4GqdKb5yyd72LLvycRn5QYBJbRS9DZPuezKhpEsMkxYTVrFI9fvGiNIGCdaZLVZtleOzwdWX1z3cLubPL/3Ld28uzwaD3ocz+Bo5/ctJt9896V3968u7/lXvovffZ6fml/5l7+Ss7vfKzjsVmNSGO5xdw35XUkQ5TmT18eQxzNSCRWlCAsUOks81bx3FQ5Iv+cbNG6XQ2pU0q7rF7atWE4MrmrzEqyOCuxc9TI61chOUxkKBV5Ik1gkSytZzL0zvW0dobbdQ3AfeH7jVsH9l5wRC6HsyDIsaZ9DfJPWrXyBWGL14toS1fBTlCWpi2A/Q9C1Gwef3L5hcr0L32KyCCcUepXmRWSHr+bjJFH3on5iXivXLwFBKhV/T68SP2S3nendgH7o1MnZlhMOmqc9pn8awUoIDE0Yw8viQaXOGhDlU1SHhT/RKsiFN1ryWHOGpHx7mgEkrqNQUNOUd2rBxSveY2O8p4yjMSuBZG8g3DBgfK0wh75dEpZQJej24p0U4Jzet9pbOI0+Lb2io2YlgqR1LEOZGFzS27WnUiubx8XD9dvi2F7Bk2kFff6E8rZlzFS9haXABy9YvrxcfXc8k991xOr55mp2Qx26xwQs2Uu3q/jxtMy7T4PjkO6iRm63ffM/88eWlUpB5NTxYrdY1YKhqX7Z/+1zBrJE36QtYRzBtZlvRb5CP0bXzGHM36MaDgo44xGwhjg5G3ZkRprkWUlWVw4QnRY3dLgNG8umHEakFpTegc9idnq/kfhrHlEyCtVTDwI8jQXcdwO/ZE/QEOS2ySsex/6GTQqbyhA4PNtku5pasUNyxs9eDCvyBRpvogrN7YFNSisU2QCyaZhpKs3IDljhDvrMs99z3v7kL4clPIswdCRZV3cBrMnUaYiBLfQOyKiD8OIqSbeUA1lXgmsQAkpy1f2hJBTGWTb0NKzOv8KQCx4PpfjGoIFDnMrsWJDNg26w7n4twkrtOhx2RjDtABf6/rdoeKq4CIgkpZKHiGOPCuj78rTLYYAdSwYDTlVmwybAOh8/+FHYw0ocFi7Z9jYlBrpF8AIUBlhYYbPg2J7iGecQdhdygakdBvM5E3IJMgO2vPBMwphY1qp0k7esk8LWThMcmUKL5nrhMw5psHViG16o1y6mk095WekTUPSy2IMwtNpw5TP3021njMN9hjTWGYgAbItSQN65Vaxz8+nLjTd+9vPj1Jdt/E/NbL4lCe29Y41FkHZb9hOpuuiU24jYnkL21p4/FYJPS7Wzk55lcGoSziSu+Pgpcn2SXWCNDUNYlbjbr71MQXBT6i5pcqIbXVRRDGsi3+b2nQzwRtlvmE1gK8Fa5abaIQVCnwba9vizqwHvk6bppN3nRxttwUrwtoWDRchMvWapo26WNjXfKCWpouVcNa0PIJ3XTUyvArF11/AyNbu2lpa+zi7CUvIe2kSLRoqHBl95BNmL2HujWl01BvypKbiQUECRFjdS7g2h3EL0jJzzuZNmdLO/+yfI3OuV9DCTmMSihRKhLJyx8XHHloySrhKM9+nhoactbe+MKKRP6xhnSUE9oCxcwzqhgGBtTuARw/v4MvmTD2fzF0HjTvNyc1aijgLYAnyMrduMGsA4xz7BXrDikSDr7vvEiMgMpLyXSwVWE4N01Mr6OCyXy0zBzQh0aMEJercyko/MO6IWsNhFG6ey6HKEHDVrHAk0A3IBKGrdIbkf6fCxI3u5LqOYLfTZgrvl6Ig//oMazb/vt9WmH7ez9C80xZTB9C3PM3XTqbjpt7Eh2N506uPin33T61V2q4S7VWEeJu1TDXarhRPc3vVSjIodNTJi6JfE7l8PLJWe5Lz06Bbmz9Il9JcgPyFixHqKxnOl4cB9z37jTV4ljjAZosOTkHa4GuG0uq9cc8pIpWwgaK3Y4nqd9+zaV5vOnZuqk/z5bHB3hSi7xZicNF6pwfohWITJbhfB5S+ons1ov9TqsUFIrSdf1THTDKm22xAOCnokJ1dFh1KDTZln83FL1Vz1BMp4gFVlonB6q6fbG6rIa6gmVmY8H0Gz/WeuF4nGwglMYhLwGVjE0r9CyTYjG6nh4QJZDu6lirtsUc1XJutQCmABNYrYfRmD2YUwg9+Fnae4QeaRmb3qqpzrKfOv4R+lVOnf9zk9yYuPue/2Bz6lWAN/KQr0eMHXpK0uU2wmnS9/eJbO3ilbB5bomg/wK9GpInAPXuwSu3TFaPW1yw1ceBnSMsaDA/OIjDyLgnp/ff4UZBKhNlPI0vm99I6AJDUkio2vsyyJiAWwQqEhE3OewpSapuqzL2pTZoT0dIqynHFMgzIlDtrfUuUezBgZZWXUwhic1GhtA27ZmyCLYRIDSscHmNdOaZLdkxWya+v6i9XvKfRW8HIupiNEhp9+Y+3BhHUHpnnL+IGncVlfoUjik3lrEOB1TsWUqyoNDGhDmF1Hop/kBmhriyxtT7/7QjgJaKxHwAdKfYSIayq7MOLZ9sTVfFgP53JvqDor/GFDcvanu3lR3b6q7N9Wb+HXcm+rf8TNX7k11Z407a/yvscZ3xLPn3lT/Fm+q52Zh7/iCnQ9eu4cVnDm5q+bkjkhC97CCe1jBPazgHlZwDyvknuI09BKw58+hz6TeXwAdqPN1KlMfSAplrri8uRR0LlxfxhmNu2Q04hMOdlaNn8aBg8AOAjsI7CCwg8AOAjsI7CDwDwKBHTDdYWD6Wzqi63IpcfKHSPl2sTs/N9JUodXrh1jgbHWHA/QLevH95XkWy2MIXERp3Lr5h2wh3sHAOx3eI6V/IuImoaaDczbGXTHNjlSKRyzqJSmDtejiDPzOplLpfwWn8Rx8zscNxJ3VQlaLFKAJUrXQiqV1NZoc2rJrsGF8rdV1OcC2JubQUoEFZLOUKhSvT0uSXoHsVj2NuJB59T6vTprZzye6MHAnJfl4lSs9m53mAZf9ojtuWW1pflPHbic+94JmsLuPN8BLvMHhA10vQ1UVwCQEyyVuR5WZqa9dqGeOQ2au68MHL1q60lBbMnT5IRtewpJ8RAvlgoeLoblmJzC4XvdAWQ3NXmG7yLMaNBifZwMyF+aMaUhLRmNzTycjWonEiY4NqYa+9CPAYepHEFsYOaLlHuawfNcRL/1sVHnEiwpCnGA4coNEvFWX78KcZU9ELnkczGRWwpoPSIFH8VC9zoD32IdeAnwBjSOSBStCVsPxNKXsX92Lc1jFOFV3UMmEx3SbNMnGIV5B9KoQ9v80I6yLHjOSAkb/V4zPAexdAtgu0e8H9gCW2EBjzRwH2mEvK34s5kXoR1l+G2SAY4ODAGenOTvN2WnOTnN2mrPTnJ3m7DRnpzk7zdlpzk5zdtpT2Wk/rJ203pxwQmvnhFaDSzo3fxSIZkBh3WZo9ko/Jm47NWgca7PlmiS14SH1kqwjm8rVtwK/+e3M+Vucv8X5W5y/xflbnL/F+Vucv8X5W5y/xZkuzt/i/C3O3+L8LU5o/cn+FnSa2F4Jfa9gCzOmWgxf/9nKD2M3aXww610sa/00m/pgDjdy0rwPvVvOMNHFXLPrkmOda2ZHXTM7AQFccqxLjnXJsS451iXHuuTYXYX7peTYLuxJL2b944FDpw6dOnTq0KlDpw6dOnTq0KlDpw6d/tXo9CLiI4dLHS51uNThUodLHS51uNThUodLHS79S3BpoQj1kz+ANoF9caLeLqub6kxCYLlW4lHHRZapRDLqlwUZlpYJD+b4EC+ougiqHAJTJii6FOo0Wlgm7+eTJ6ThHFpkKTW5hAz146SWFPnEdEgMYN6IDP1eXi1zre7RPOeHoZtJCqLR57MmParidcMu91exWpaWNFHIJ5dn3ave2zdQpPuh2zvvHp+fwd+nZ+dn+uuzy8t3l2en8Ffv7Yfuee90r8qzwNftgaISObocPhvHFBWrRq0VfV3cbD4XB3ak9BIaq4QdNi/6GXUwgCKunv8EVXouwhlGmL989l+/lgOsSVN5AY8XDZbdViP5/HwpbO8ve2iT7hmAUCLh6NmzGgpWBeDF4taTOpjKauh5bUNK0VyBfKtti+L1V4RtYYZBIJdWf4JYwIB71s9rJwZYJ14YZGyV/kddYTm+FgGvKU1zBWYB4D7k2k//8z/zr29iPr9++M///PT/Op8/51/8r72ahgFip0Gdzsl+Oyf4qp5Iswd1VMduqe+f4/OxS17GkEk6gklc8iMwNjBDpacXdYwNNlLTuVOM048jtNI2eR1UG0YDAdZWsmFFZHtKQtqqNsLQwPuDtF51Pupm3q5xxeOZWPJ+yYZR2dtFVGd2cPaeai0tmyOFrVS7vRqFl/7q6f/1ZQVvfTTV0WgRsTfWD/1NPXSpSBmNPdKAOp8NYJkafhGcq41U+OqUuhnpPXYp5BxsAQWyDvdePntGcL1AyjHHR+bBIpIIkTGlT6NqMhtUvHrn31LJVCU18C8b+xkF8nldUqulaaosaoZwFsdRXKH8RZXyd9CygnFhpDOpgJ4H2vjjNPaSBUGAYwGWUNxNkdM/EdIMRHIdAeV7wNR7JOzgp72O0UKy89X82Zs8aFfNnglMl9RoGvtQxfh6+Nxrk18nd/hUHQX0C+trs4adYHnW7fcIKhiKBzjBarJsurP5wh73tPQmaUeF4Bv1x2vDdv++S2gmvHAaUXXzkIyiArtdR6DO3pG6ML3nOSbOKA7eHjIwh+cT10+j/53/gJYSpp9RP8/b//X39jOjAQMe5sZYxr65yyCb/QKxX3NG3bsUwEPiVqi3rrVvZCJATPgZysqay7ZZ9vL3zLsVIRvmKz603htPQLuj684jfULj/qr55VOGWjCf7FVef8/IKtwP6KzCsl+/jrgU72P/4QG/hu0WK+4E21mHUNPTqCvGuUpmLCX5RkA3BWmVGa17ZMk373+gXq2+W0UGQ8NEPbWt/IXo+ebGl5+twjSOAsZh116LOG9wzSDUq9kflwzlM37QJuVm87qv362dHLC+IXCDGTY6OFzY9BiiLbYgpIu6D5UXUKgKdGGa5olVtSJ2CxLrzdnVHj24bguFkhCwDZ8iWcCFVOIK3wMHTjRU0vvgSODDw/8HDGNq1Q== +api: eJztfetz2ziy77+C0tQ5J66rh+PMbs3Np6vISlY7dqJr5VF7cuZaEAlJHJMEBwBlK6n877e6AfAlSqJkZ2fs4MPuxCIBNECg+9eNfnxtKbqQrZefW0mQsDCImWz91m75THoiSFTA49bL1hVTImArJolaMhLSNPaWxGeKBqEkfI6/2uYk8FmsgnnAfDJb46NFsGIxmdo3Rv6022q3eMIEhQFGfutl6xwHnLGxeekCB2m1WwkVNGKKCSDyayumEWu9bOV9tdqtAGhMqILXy4Tb3kicRkwEXk6cABIE+yMNBPNbL5VIWbslvSWLaOvl15ZaJzBMECu2YKLVbs25iKjSP/3959a3b+2MllsubmRCvQIxf6RMrDeo+WRf3ELOccNLngqPfWpKxARfJ7e7aCEfJPPJ7ZLFhHoekzKIF4QSuaSC+fmXngseERpztWQi77C8sHMayoNWtt2K0zCks5Dpr/Lt22/Qn0x4LJmEHs5OT+E/5Wm9+7XVbnk8VixW8JQmSRh4uL96v0t45esmEXz2O/MUbDIBu1EFegC9weFf+Tw+t3yq2EAwqhissF0EOCy7ewt8+P+I3l2weKGWrZdnZ1kTqUQQL1rfgPQoSRUbxit4u7wE7RYNw3dz3P+7x/IEw69IQznyCxM141T3wiB/vfD5yZwLYughLF4FgscRixWhqVrCS3pZu+RKr44k7C6QCvaIF/LUJ4ngq8BnoveP8YAUSOqSCWPks17E4oPfni2VSuTLXs/nnuxK9gcTtBvwXhJSBfujQ5Og52G7TqHdSReWjotFabI7tpZg1H8Xh2u7rpU9JBY0Dr7g7GqOBXkGzTs8DtdtIpkC9ibXUrFI01HkAw9AzS5usY+UBntu3/CDug0QJku6h5oFi4Gva+5fpEmzqxJVz09PN8kqk/EhDv5IGYHGuC9BntTszS65TKUiHo9lIBXIpOed56enJYrbxKdy2SZckDT2mZAeF4x4SyqoB/IFqSyNXl7C0/3Unud/WblYTyy9C6I0IiH2/ZJA31VK7N6vkvG3fUTYL2c7yM4jcGYWpxFwM3orOzOqUMTCv/HkttqtBeeLkGWPzJ/2Kf2Sivyh/ss+u/lFdjKa2y12U/pzccOKf6aL0p8yTEVU/CGU8+KfNFQ0EMVfIk5npQbco2GpS2QiZvXzB78hr43nwWJThowtt5EJ84J54BH9ZioMw5sokXoqFYz4LGGxLwmP8SNLFjIP9rwdB5Z6N6sGbnEeiP1MGvgA8QPBPMXFmgDOwZMgFYf3CTAYETE/AKYKvc5DfkvmQcjMPhLsKo0n2OP+0fq+D5IefyFqSRVhd8xLFZMk0HON5x2DAM1biQjgYHISxCt+AyS9ZXcKqUgEB/jALOsfC0Zo7JOES9URaWy6aCAAcJf19MA96q9o7DH/p0SwDo39ju2vY/rTHAd+fZip07ligtAwrJkaWdKVPuYhU8z/U2ZaYC6FeVIhKADAQLFI7oc9lkHvXqVhQR6sqAgApiB7RkJWNEyP7QTbYi9LRosidMZ5yGi8+cGSJAQNI5B5J4rjJs0+E3RFfuezbgFkPVDXlrP/zmdw0r61S3ARV9MuCIDEQAGeaw2QpQzj1UfT74bUqV0dCcODpDensE6soJQ11A0yHrd30wfwTxoWJ1bgejAugOm12diVt5DRHLupLbEd3VcH+tIb2g+AyCiIqeINeKTl3AReI6XGm1CJgnLD41w+au4d8PikuwGLvtURY87N+q3WwMrP262IJglQCYK7JKZgHmYbXHI6Ky90jcRoCvsby5I6UAeNgWlnIuYIqTH5EeVF7aT/6pLi4fmDUbqxd01Lo614YaxIGbABTJMNodcTQBd0m0om3jaSTh8kE5muMJn8o6KzWh6OimmYSgWgGAQOl6rZAP/gUuEAXJDRmFDfF0xmRrBCv1ryxNxnZm8JtVcrfHG2uckm/yDQ1ijlcQycKl7UTYScszlNQ/WSTM/Oppkg/b8payKS8bVcz5LpLAqUHmqfPL33CNtEKrDSO2w2Cb6wY5bPKlpxGs2YgM8EXesz69GYzBj5A/r3CVWEx4yoIMoxyD/57B32JA86KFy3yfRVu2Z6ylLabQ1MnC6oYv/YNtY2eDKaE9TZ867tmFQwkvXrwzYprWlhj6BlbqqBi5VK/ZlUoIO+EYFvOARYGsvS5kDZbIWlBjAgaUsAxsCIguZWEcAO3T5udPvt2zdQunODQwEF9T9NyCv4cS8UKn9M0H3pgr3Hl+o+RyKYh5Zau4eARwq2zSi68fqKh2nEZIPtlptwK5vg1YSYXmBtI57GijzT7OolmfZA5PRAmX/ZAwlKg5gJ/Ht6FAK+/ykTbGGMXnsY3acJ0e/CDYFgRDB9BSHJbRCGwFK1pdYnz1h30W2TaSo7jErVeW7mdpjcKG4SPRtk2cheRRrHIEEygeHDvogP7jnv8fyq/2b4NjOkWCQ6CsMUPoZ53hScyTQB6c38a8nn6pYK1tMU9viKiVXAbk8KZI9iqQDEbd/XpR02OCOBaaEVnzr6s48wf949uwupWLDyV/gnn13xsMF48BbpX72FLbYQNFZkHsSssxCwd30y6l+ShAkj4HDTb5frGb5rNjT0LezwMMvhYEIUlTcVoHgA3qn79tt5q0ED32uhdjD1MBjDzeZ+FRjsgqYrmNvgYqR3Rxhq6JsZDgyzye4sauG6Mxz+EIZDs68HSSqPgddvM1g9GH+QME/uWdy59zBdsoiL9eXsKFyPbe2AsL23nt827L+ILehsrYxJ3AHKRw0o261bumLDGP5sMnH9Jvn8SZ83w/+2nyjo/aRWVWq35ikw7bPDB3+NDdFcaq5Ft46vxzgpXLBXKN9CW7yKIzbR0PhgAt9+vGQ5nDAAu0DCJv3a4sMXbwRPkwa2R2BPn1DiXvCFJAtoZs0aemIk5Av5lMzY+ktOYprIJVdNNPvKdsma7tksvUUa+Kwn7esn+7/cnIsF27wE1ZjoNTysrKAxMXTJ58I7TdfMXsSyeCV7mS74E00Vj6gKvE5prA6f6xc6mXJxQsy7xgttUysoeSrE2iyisV15Hpbt4N7zWRLydRl7WEe4/Ze4agtQt7fsk/G79602IPVNp7pREbp3yXQ4OJsaciRJY7zWFWmiAtgPPO74LIJZFVG/7JIpDJG3K7eaJFzlL5NnIb9lcNyk0tszCuJjJf9lEKNhDeU+OhjAJmP+vvupiN4dPaSx5R065CJJD+aGb8YfCquMmGEm+6niE4+G2yRi2Yqw1WaXkS4JjQnYCWBnd9hdQmMfR/cDebNrVuQtV/iA6u98G6jltmMeFHTK+9gzBjyKaEcy8McEhBcaPxuAYLesvC9xS+tlQ4Q2UdBmsd51VF4NJ++vX4/guNh/Xo+v3r25Gk4mo4/DVhsP0/WgP+4PRu//df1u/H50Ofrv4bl9Mr4aDYZ1zzdO3jm4k0ZwwsmS3xouoo0msny+0H5KhVgTnipkKJm+WRLCdRRPkb/kBzfvFP6a7qRZty0fX/01I7rYasUqfa5UKh6R/uWIjM5hGqnUOq4WXsDwKpwEHahmoHwgb70I4vSucwaadgc4fxR8gaMG42sdJ2JMydIWtbz6vySOa71ojPPMaE44GPyZ3zZuxIpJBUJZ8BXzyYoJWfCb6kf0C48rw0O3Re/E3PQUSJihr1F14jVZoo/jAawN9BczZa5BsQOZzmKm7nNaLszpgDFMb6joSg7TxqXPaUc/Wka9JUFXWvRQgyVAZh4zzcUk81IRqDWirYcgzXZogNjoHCn0GdgqQJ1l+NY8EOwW9FeRohMCXpzwWAke4izsl4CLLqIEnc8DT8MLeXcJNs/93+H15A4/wgWaaI2lNOGBYd9zedfsaq7ST4ER5grXXN4de5W0o3sZfIGvRd68sqbbhEv2Lj5nIbOehE1vdHxoo+FNwbAKrth1OCeQpoHe+cw7+5Wtx7TJBSx8vRsGDmWByK9L0d0749y3r1Lv5mFOAs0R+uQFmel+rXu50Re3SXA2k69C7t0c++lyW3z1U2n0vBse7BbrBjBsSl/ybPVcw6xZ4I+Z8Fis6OJet5hW1iYi8BguallGtAmVhIJx0QxmmWkuhXRTbSyhqiyxu1XAiPb8mKNY0HKD+SSNVRBqvp8KAZtQQivdcSDJjAGIRq9ILQCYj5CzQFZRdD4/Pf0Prb6yudSu4YccF33VIEnMbsnw9WQD/rB5I0/4ofVgr/RBRue2m4bcrNpBgZ3Bviso8bnd/3BrwoPfQhDzToGqfhQ0WToDMWBLfQeyNkD4K87VsXwA2mpwjWwASM76bxe4AvNkU8ODwVllDdPaIuGWAuajSB7FhDAFfOMzBbZL+gl4E+dm02mPKa/HPAn/6+q+p3pXBbFGCtbLBB1MSD9UTGhfjUDqFyO6BgGShrjtKIloOE9jdHODF8tqfo2KgVaSfAKlCVY+ML2VXYpwrevxqKeR23Aw6WmI1/PZioWgNmsjBfNkBzs1On93qaLQ2EuosP4Qzc/EVRpvGjDBwe+17q1gX5KwrbzdZi2E5yVGmGtssHIR91nYzToPJHLIqjYGbAA6QtSQd25Eq4j+/vPBh75/dfn3n8mzN4KuAsXj4tkozEeT1a6aDNuamnod8Zjbx9Hem8eyawlutcynRFuf/CuLcA4xw+dIYlwwxphb7GrgokVQ9kp6ti5t/dw59GTTJm1uxPNbMvBjKEVEFFwZ3uDvBK2cB3oz/Nuv+t3N3tO/2dt1s/tErOvuGs9d4z3Ba7xEcNipTbB3SeiYdlZlaerPVerDOHYVHLdAZRM0tK5bX3jcYKeX+oQmCIqMtNg+RodOT8qGQl8vUOYkMw+EVLpH0xtGeM4YeHiHaJQ21jIEen3PA/VrGNEgbODQrxuBUQKVNgbNENqAy442VWihVjLJHgSbLikYXw1qsksQP+9AHz4VPvrIlZaA2kWoOHsVLZ6NzcKjc2sS0JZcNPdZJ2+TkSFeFJEwSBnjR8R8YhW1TMX5eNklnz/M0lil5OL9JD8MyMy7Gi2hWmAYB56SHo4ue1x2TBqJn1Ls4zpU8oSY7ZOksxACjfFd9GzONMYu4De4pekwfYSLihwln88ZS8gFowIn9/FyB10+Y0knNK92VlGRwJ8gWOjaWKblCcYOmZVDlD/4cN6vrFAgSXapScNwncWGdsk7a8dukwlyiQ6/hfsrT+uQZp7WiZKuaIBJALT+Nk8x8FSwkFHJ7q1GlPfww1yRzThX54FEM92bo9x6oKXdoLNMWbd7zUYvDeMFJhoxg3fJNPGzAzTNDgacIgj0BoN26Rz97ZS8eWUNgsVj9CcqJZpVHquUFCOxi+7V8PPjUEmOd0Tcj+odVHRQ8WlCxX2K3MHwRHOMj5faQGrxycTw1uvzM3m9emGg4DaAiY80i2voGqZHtY0KnmEfL607GN7PNrrVDYRKaWivdPNeDSyW6Sx7vZF5G2krtrI9RTSmC+aPMA+KWjfpDMITO1TKYAFy33RgMqmo9QatlREGYcDiRnrBZbVnD5taO30lkY/x4/tUm79mW/gmX5B+TMO1CjxZyCZlRoh4HOj8FLb393Aoml3kGpu6yjgnIKDSgNpqSRUd8NDEbg9jHy9Z9nd/ThUlXtaQMNNSu0dYD8Ry71dp2GhZqn3Drbldk5AviOCpsotyD7RRlks3rMazZrusKVplL2nSHcZKrK8n+LCr/3O9eY97P9Ri3bSrxtRiVphNY+qbX4fZRccBsfKmk1/TGbpPAMklIPIEQZCz2T4Fmy1YLViDnVba2doXJwlpzMiHq4tMaFsC1zwVHUjOBBGHoPEa8S1lOGCiSZ6DyQXx4FSgLxfCvIIAYTaqKDYsDxVj+K1IZSHWHhg6yoqD5pm1QlaapTnKw78KAMnoedMipJ2UDEIHDS0rZqGCM53dRh0TzF7MjliNty5RBaj7YUkyX8CCcMs2YfOac765aFlGPvNyIrR75+YVbzO/7ptf5E9m4E6hL7PfdEjBIKRB1AwHjMHuIiG5xEfU1bGpBgR4iU4lHEftvak737I52sScCQUO0B3TaGp8HtGrhkyvGPU/iUCxSxqvp9bcF9kEDmYE9AJpFpF3qT0/IC7P5kjNJmStDx5OactsirunlxGtWaI/AN1Dg+vKqnGfePohSXgYeGvD9+BW3PA3RH257y2Pr2WK80VBekvX8I+YATP6bTPd3F0HGnZWFFNtyCY9GJE8zugeI2X2KIy5P0mYd093i4T7WUDwllAwa3DlPpugiOZiqv1xwXMxDtR6ikkEFcRqqqJXLGjfgU8MpeRf/csLIrN8cFJRgZZT5H5T8Hx6OS1aoh9mhnUugJYXJNz/M+bnLCuP3LLyvUJAGwVU/5tiQDdDQJ/EFXjluxv4mEO7krL1p6dxcSZex4h2MaIGxsymd9rvl2Xjgbly7kBkRQevj3VuBXzaDIxWu8S5NTEP7zVefzMpzmvueIoU1rqhbWTUMZYTG9OkocFf3OyRGYcO8yvI2P4zvV4nyP/1zDHL13Yvhl2sCLzZG5yOD7IaX/lAd6AVJ2X0Si4FPZUH9JJ0XLSgNV8/vVKD8YdC1mI0OqOHwhHuDLVE1jo5/Gy+wwO5uki5PKcsahRoY25nINjFxzYmDHiWLhZZ/JdcjqJyrMbWhJrWtVh7Bdg4Gt21NiRD15fcP8pj/RwakxAcqMmz084LvceV4CnkhF1ynlmTPZ6s70E0NAd8n+eNTiUbi2BFFevrJIcND0WiGxWyIzLIkx2uybOYE3YHMW00JKOxMXqFdMbCA+7U90YcbYtU1QNlOA3+oY9AFmfVdYbWH8PQ6nSeR6vztFvxXL6HNGYNtujb1xOitSKisInOPKrr2Fgrm+mzYXwXdBnllr3NkC6nhzxyPcS5mtTRJg+8rZhg8OcaI8nr3GqzzMlYPUotaVzn42dd9hS3wqWY2VAwj0eRDp2Dg50I7qf2Uj/b1Vnma3QIaeBBMh5k3iPZYdJB/M06mGTv6suKgu/zx/GgKAqykCsWATtscFrtsiKyMHmo52kYrjt/pDTU0baCzZlgsQ0R/vzxsuA6bEZq7KhrGnZsQ3nSxglBQgyMVbQPXvZ6U7hBmgd37eId2V4W8E8+kz/CQjRkVltcJfIiPS/L+XMfhXvnAyUT2Abtt2YU2JUX6IiEtzr16FmNdltNcXuY291mKlfbr3rRhdo+afRdwwLAuNU0VcxmJhdLyGfj1R7B3ZLOddq/HB2dIQx//sn4wHV0gHHHWCc6OLUOjYKT3N8bTTLYPYyr86/PmM48gLgaqN9n/nHq39NX/56IIuQ0DadpPEFN4zulFL1PtBQV3jJQTPtCFDIwbCSLA9a1kez83tFVW3s+Ot9TuUbOlsjGe2ZbKYGaWelWwyZbqSAaHZg1XSQvppXwLHA2NjCjBK/GgsNW7IuGl4LTUbnhFPO02xF0zpYiFOOESgl0UJ1//nYJG984GZkIsyzNkQ3r0yF8WdIQzKh39Va7zrCYp4tlNf+7SOOCltkEsWkd07qW55lKQuoxZLDPoGhzyEz2Oetf+kA55CY1ueOKmeGs+ltIJ/ZoY+sqtUkL2tcEnrgibo8axboibsoVcXNF3FwRt+pBcUXcHtYC6JTVR62s6iJupRrvL12onTMBPlYToAu1c6F2LtTOhdq5UDsXaudC7RyEdqF2zu30wULtWjRUNBC1qlIfH5Hxq4mzHD9q5cdZjp3l2FmOneXYWY6d5djB3n2W41DOa+HQ6NUluZi8dljIYSGHhRwWcljIYSGHhbZjoTQO1GsuLoIoUPWOegkT2tiD79QsoH7nPZU3VwzNGPXvONT1BFCXrguwkSRG57TGn909/Q8Azx7xPX3jID2TQn5RLC0EEXmpnOY5H8acN6gDpLOCJJyHeyzrUOgFuqxkd9lePNj6QW9eJZbrcRZBJVyLkvwUdkv1C8ulZmwxXL0YleQmxE9htrUXW9jQ3FTuZgCr6MBCAhiUWHSwz1d380qsSLhpW5TTeR2Cn7EOgZYP0aByqX/EhcrHy4wLFOn7BHW3YY2lR0NYvEASU3CorVm5gC8sIcocG0cbIAt6VhwCB7yluTrlIQKuheC3uixnpWCQR0Md83GqC3+ncRbRCW9O4HnzSBJo0rH02/1cmGTryIrl57pQ+SsjRfSmwskh0dvuUCsVy7NAnSu2GPn3iw22IT/ABaQSpXoKlWqk/S9Id6UoqeI3LD63snDvHrdvWpVn0p8Q7KIYfGA5R6nm9ZlxLtArAQHw7+JB5i+wyR36pQ3iF1ceQbzm4n+yxwHcbFY9DjSpwCM3ZrgPLm2fMmyymjnXR5M5HPuocawLkjyu8s+juFQ/qMJNnIZYDk8jqbrgPl3ckJLPG4V1dPmb4zIR5CpUlovA9ntCqFLUW+aV24sABrheO4M+2Xpu+HTyUiusPp5lpmoUoIbzsETXBqrpsMTB43DNbpzkVWf0yuyjBv3r/ZtViiR5+g5JPkM9QEGkYgn5mSyZaLylS3tCv9Uxv/2kpX0HEpMUf+8URM/+tKMPkAHZuL1CDaIrBobogMdGFB9gRwP0LCDnCAVLNKSDREuaAW1G7J79Qny6RpCqD0XmFupxqXqpzBKr7U/q6yT0o5bQTVgUu6mPG+ljUhcy/HXi6jw5o9YPY9RywScu+MQFn7jgExd84oJPXPCJQ+ku+MQFn7g6T67O04/BiB6wzlNu22sdU88JmhdtD7am0556TU2KPh1T0yld1JtvP8TBihJwRLNp0Z239GO2XDhvaect7bylnbe085b+zkjUQcVHDRXBhxna85hVrnwAuL06wn3ZGNy2uzBuuGsCixRbayhsvK7NffdxYxu+mhijob5dRePiM82twD4IEqcHxsaXvcxJBP825v6/7HV9oYzGLdy8FzxTMV/yjGVuc9uKahwmNoqbRM8GOTZyV2s+zOSFD/siPrjnvMfzq/6b4du8OpEBaaMwTOFjmOdNsVnmvnAt+VzdUsF6msIeX4EdkN2eFMge3bPYSB392UeYP++e3YXga1H+Cv/ksyseNhgP3sIE2IqThaCxInOo4LEQukTIqH9ZTYe9Xaxn8K7Z0NC3sMPr4i0Toqi8qeDEA+BO3bffa/76Xgu1g6eHQbPbC3gr816CckIXI707wlAj38D68hpmc09PFneD/RRusL+XMXnnnv732pLbm8ZkhycfNZ50vsRbfIlXccSMz+nBBL79eJlX+85vtDMSNunXBp/vU+TlSVz32N0yiWkil1w1Uewr2yVrumez9BZp4LOetK+f7P9yBwewGQtDl3wuvHN0VTjtiZ1FTHVKY3X4XL/QyZSLExtdxWSGccpaQdGmDRIUrCIa25XnYdmOKRifhHxdxh7GI0juj6JTW4C6ddSYjN+9b7UBqQNPq2DaInTvkulwcDY15EiSxui+K9JEYQlEHnd8FsGsSqWKumQKQ+Ttyq0mCVfFGochuNOgZ6/x2g/iYyX/ZRCjXQ3lflYiB3z1t4aMWXve0UMaU96hQ967bJPGDDPZ3xO0V7YibDXZZaRLqCgEdgIM7WN3CURFwuhYX2nHrMhbrvAB1d8ZnTy2HPNiAcvvUbITvbGYTza0UVOtCxDaREGbxXrXUXk1nLy/fj2C42L/eT2+evfmajiZjD4OW208TNeD/rg/GL3/1/W78fvR5ei/h+f2yfhqNBjWPd84eecMPOPhhJMlvzVcRBtN5GYpMI8KsSZQHRYYStEXLxfCdRRPkb/kBzfvFP17dtKs25aPr/6aTSuBGrekpsVAi55FMfLWiyBO7zpnoGl3gPNHwRc4ajC+1nEixkywrN2illf/l8RxTT0tjc83q41i7V0FQlnwFfPJCpzt8iBM61JeGh661YihPKIslUtdJV6TJYL60KbulqlzBbXAWln5rvuclgtzOmAM0xsqupLDtHHpc9rngkeEUW+pi2i3iVFlkJnHTBm/tAeq+WVJkzW1vzgUZ4OLaaj2jW/NA8FuQX8VKQYzF6uDwSzsl4B7LqIEeK15Gl7Iu8tmfrKvJ3f4ES7QRGsspQkPDPuey7tmN3OVfgqMMFe45vLu2JukHd1DKTxTCe/YKOxMOpgIWW1lzQyrEIndIAr76DqC5RKCGed+gFLPdrvlxd+2V3neJsGhgGHIvZujKxhmtvjqp9LoeTc82C3WDWDYlL7k2eq5hlmzwB8z4bFY0cW9LjGtrE1EYGuhl2REG5ySKRgXzWCWmeZSSDfVxhJaqTndrQJGtOfHHMWClhvMJ2msglDz/VQI9GiFVrrjQJIZw+jIJSNZQUWEnAWySjH0p6f/YTxT53KAFweHHBebKiNmt2T4erIBf9hcNpEFw7tA4k10pQ8yOrfdNORm1Q4K7Az2XUGJz+3+h1sTHvwWwgZaFqjqR0GTpTMQA7bUdyDrQSuZvioVLy1V3JTtAldgnmxqeNjp/g23FDAfiCoQNALYmZdBzRTYLuknCYv93Gw67THl9Zgn4X9d3fdU76og1kghc3UD/xLSDxUT2lUjkPrFiGLeDF1YnlAS0XCexhjyAy+W1fwaFQOtJPkEShOsfGB6K7u6rDuEK/U0chsOJj0N8Xo+W7EQ1GZtpGCe7GCnRufvLlUUGnsJFdYdovmZuErjGg9iHpPXureCfcn43u80jujI7SIjzDU2WDmIMAm7WeeBRA5Z1caADUBHiBryzu9fwrhQtbgA3vP5aLLaVZOhTlCzRUc85vZxtPfmsexZUknR8ieWkS1u/YPLyJZ9F3RF2r94lOoDAbltBoCtaG6XTeYIZwN97VtUzre5FwT3vEa3/aoXXYifTyECs1Lh2gQHVhoWldDGmjo6MDdU0ze1aEvIZ50bohNBnJC+Z+5fjo62zuLPWZ4Mzdw7EQWKWAen1qFRcJLNmHyQzFbN7l+OtOvbjGnUh1IZqHc3zu7G+Ync7LgrZHeF/ASvkL/Tde59AC8V3jJQTMe1FtDvhqEeWNeGo9m9L3+29ny0ra0cnqDD1lEkPaCmWwI1s5LaaxXdCqL52yl584pMF8mLqbWVBbmyamBGCV6NBYet2BdNcjyBVjsqN5yij1wxpWgZinFCpQQ6qPb9u13Cxjcen0h+GmcmprZFH2izyhQ2vM24eqt1MhbzdLGs+t6JNC4Y/Zsgtgm+aY0euZYYUo8hg30mg3gBhxRftLlCHsh+P6mx2xet8uYuo2jK/ROVLa0h3VvZcpnPXOazxjZhl/nMgcEHznyWc6I3nANrt04DOpfHX5wfWSfZ/WOZ2WmunfnWPtNLcoLyrpCuuGCAgZsdQUNrgtnFJ+C6qMEeQIvCpgcEgJnzQOJd4JujfIcrtwCIhkpeBeUBvSQdF4O5m6+fXqnB+EP2cYwLFJpRmlmnLvXLuZV1g8jsK8TPO9IkVu/8bL5DIjhswSaopkS6aWevv6RcnlMWNbrJNiAawK2PbYyf3SxdLDIHC7kcReXL0K0B61aZ0K4nFjfrrrX1GrqupO5vvBnOoTEJ4YaCPDvtvNB7XAmezkIml5wrS7PHk/U9iIbmmLkd5JENah6LYEUV6+sg4oaHItGNCtHHTBJAVeRZzAm7A6cRGpLR2FhcQjpj4QHg7mhLsB4os8fAPyq1C47ILOCsfI/RyueSFD1i22Y8l1oz2T+Dt68nRKcxIkorMxjZv6TgXy2z9NfYZ0MHCugyylPxbfpMOLT9qNG2M73W0yYPTC86QdPXGl01y9lFWUSDMM9MAj6lID60tLQmFJOByN4fKm6FSzF0WDCPR5H2TYGDnQjupzptbOEUZjc7aHhq5nhrrVTZYdK2smYdTLJ3tTEVrHsGDHwcD4qiIPNpYBGwwwan1S4rIguT52WehuG680dKQ+3OJticCRZbH7zPHy8LZkszUr4/kP12Fwiv0UHGnCXcOD3bsGMbypM2Tgg8ztEZyD542etNIeXrPLhrF6+K97IAqEvzIyxEQ2aVacO7NfxH4dvhsPTTx9K7bClPBHE6SOcg3ROEdA9kfWt6nVTqo1JCc9NE+4XHDXZ6qU9oUgRb28fo0KrPnAGaWbqTeSCk0j2a3miYLOmMYak4tCnVwOIhQNsG2KUWEQNGgOQr2+7cD/MbLFlm62ywz7+r26AukoVhYmhjxMAtm60P2CLFeIaCTzNIGZMRBpRz43KfQciPl13y+cMsjVVKLt5PGsM2GF32uOz4TNEglD+l2Md1qOQJMdsnSWdh4GlK9WVcdrvZhcthcLnomIKcRZd8Sj6fM5aQC0YFTu7j5Q66fMaSTmhe7ayiIoE/zahk1ybGUJ4Q+NOsHPoGDD6c9ysrFMhqQU+EaEDyOxuRaN0OOvwWXC49HQ1g5mnTYdEVDbDkmfbEn6dK17gNGZXs3v4x5T38MMHO979kgZZ2g+b+J3avVZTQ3L11mvjZAZrm3qXo66FDE0vnSDutlN1VnojHg6vt7RSUR6KguNrerra3q+3tans3uTl2tb1dbW9X29uZf34E888TMc662t73ru1dVesexd2Sq//kmL5j+g/N9A+2M2daGnorW7U5V7POUM3arYnjI42zG4b3WV3dgPM8uu/jpfV1QweMRonWAqFSmkcmFSC/df3IXm+UcQZpK7ayPVVEVZPOoGBQh0oZLMCAuyGVqrQeIAyr1wW18s5GkZXLFNlYzE9c3GAV5SYjXPAF6cc0XKvAk+jFowswmxEiHgeKC+vOHPLFezgUzXKrmTQ3KuOcoImXBtS6ElV0wMNQl5Yexj7mPWqgpVFFiZc1JMy01KkQbBRpuferNGy0LNW+IZGdXZOQL4jgaebjfQ+zcVku3bCaZJfbZU1R7b2kSXcYK7G+nuDDrv7P9aY2fT/z8z43mNGrS3Ixee1q1D1qs7KrUadcjTpXo87VqKseFFej7mG15TQO1GsuLoIoUPWm8IQJHZyC79QsoH7nPZU3VwyDKurfcYrzo1acoRpeMbNBmIrIgSwHshzIciDLgSwHshzIcoWAfwzo82s6w/oWYMB6HImdnKfjj+3pqEPd90+xtLN1WrYkpDEjH64usiscS+Cap6Jz84vsAPYAR3ZzmSNlOGCiCfycXBAPTsU8u60u317rsq+xMYCjvzv8VqSyAIHQpwhuDg6aZ9YKhZ2NIS7At4LAMe7b0yKzmhwY/lwYuhr/XBMS2jEYA4pnmPJuG2KwRBXw04clyXyBLDO2AYewec0531w0e54H5uVE6KQrmzn4mzlK3PwifzIDdwp9mf2mPRoGIQ2iZhB4DOEUEjD/R3TBx6Ya16FLBZVwHHWmLJNcrX5ztIlNuQ0V6jqm0dQ4n2ICczK9YtT/JALFLmm8ntoonsjiajMCZploVjL5Ms8yYVB7kk3IBhV4OKUtsynunl5GtGaJvvGz23QUHHOfePohSdALz/A9QG9/sn/gOKM79w/UTtk+xIM3viisr4eRcD+r2L6lVq+No+I+m6CI5mKqC6ZBaak4UOspdA7gNIiV3HRPNpSSf/UvL4hUItWJY6WiAjUM5H5TyBv6spR34WFmWOdNa3lBwv0/Y34OMz9qzOxyKT1i58nKdzfwMYd225wETe3DXycZTDjAQOy0K6ddOe3KaVdOu3LaldOunHbltCunXTntymlXP7p29Wi1GxdO9SMwogaBQ4dXzcQpa0jaDHRiNcpPk5LtAeexN+CrSVwW3ABviZYsUrk7MeebX4fOLOLMIs4s4swizizizCLOLOLMIs4s4swiThtxZhFnFnFmEWcWeVKM6AHNImDbKBoPTCbSDkTwdDAV+VHmkmKX1lSy3xKy15xyL1PJhzhYUQLBGzbHsoswfMzmCxdhqFyEoYswdBGGLsLQRRg6vNg0wrAfKhoIMn41cfjH4R+Hfxz+cfjH4R+Hfxz++THwzyWnM4d8HPJxyMchH4d8HPJxyMchnyeOfCqfxza54FBVOGP4G6DIQR0HdY6a4262UTkR8CuIB1ZzduUuf66uY0F/fRb0vXHvgSJxfJBI7NY65xxT4qdSJ8eW+jans2n9n8qhzOqFX9vC5aZCUCNviy2UmnJAqzOyMiVqfChKGcxSdFXLqwQZ2g8oH7SffFtgyHh65BsLP09e8NKnig10fY+6b55BU3ivA8By40NuCC1TSRZhqFQ0SgqVQtpEMgWFRPQET4zGJdWHxH9AGi6oVCTFLreQoR/6taTIB6ZDgpf4QWSY+qi1e233iLZ8K3jPqlSSeUgXTUbUr9dNuzrehkFn65vW1XtwNey/H71902q3+h/7o4v+q4thq906H14Mzc/Dq6t3V8PzVrs1evuxfzE6b23u2WG86k40lbCjqx7MQqBjsp61UWXrXJdLVWv20lhDGGh0TMI3hdWK6N0Fixfgm//z6f/+e9VxHaFZEFGxbvAtq9JB89BW24qJTL+oXZzr0tm+bgFibdnIkAqpZ6enNZTucpYUbBVI4wdX6Oh5bUea8Pfsrt5rEiMidnjcQQxHJLc2fwC/zYgGhcd7F4ZBwSRrWym8/Uvdy9JbsojWvI1rlVClmIAt+/l//if5+kbQZPntP//z8//r/fZb/sP/atV0LJhMozpckj3T9ihdtqo4qbO6bZmG4QXUCt9SK0KqdHaV1tXpxQADtABsjPSi7gCING66dnrjjAUHIXhIKWhjYJswTzB1YMOsltlRrcFoEQVfUORtrkfdyhdbvKdiwbZU9DjQSf44B/fM4JkVz66l5XCYcJRcL36NUvW1evr//vMG9spq2oG5jInAMyXx5gHoeVJyL0DxZyIGA2ki1co2JH2QSj+d4zAzc8aumEx4LLVpoN36+fS0tREU9Yr6BNg5HDFd5txoceCyb4y5vd+l5qmaa8C/ihLACprf9oUNFyTS5ha1UxgKwcUG5S82KX+XMKMgxNzEqjEfu5LMS0Wg1ij/XzEqmOinsNM//wZCOWJqyf3Wy9aCIY0Ys9bqWSkke1/tP0f+N6MKt2wMqsROUxG2XrYs7qVJ0EWMm4PfTcUen5CxkY6mRl1/PEKcYCmewALrxSrSna0XjNgy3Bu5Hb7Uapt/vLbb7vdbhSsRxHOOzW2lFU0FDLuPQBM9Jc3LqK54uDPKky9OmUU0CHHXz/n/yR+ANg0BfjjO8+7z07PuqRWBEY1zjT3bv3mwaLb8JWq/5ju1dcWUCNiKSURTxizkM0WDMMNYWXfZOUNsCY8WwYrFZJp/8mk3l2uK3SnQYwIUKDjxr2bDfM5gCwT0vczbtyyzggMB9x3w7tevMyrZBxF++wY//5EyobenH0ijsaGZeMc8dzGNrSRjEcYSu8osGy20ODcff6KLgN7uIoOAWkJulyw2YaJgiaNELqkoRgDPBY8IjblaMpF3uGcSutDjpy1T+Q3+MGaIw9b1malu65+QsSXwgBW2QjheF+mxRBe2BUJdEH4gvT6b+pitvuexRBWabvDdEst6M3wP19VlrlDhAkW1p0zW16/6jff8hsXfvmVUKvgbCPz27f8De/SHhw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the launch details of the pipeline identified by the given `pipelineId id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-pipeline-repository.ParamsDetails.json b/platform-api-docs/docs/describe-pipeline-repository.ParamsDetails.json new file mode 100644 index 000000000..9922f44b6 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-repository.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"query","description":"Pipeline repository name (e.g., `nextflow-io/hello`) or full URL.","schema":{"type":"string"}},{"name":"revision","in":"query","description":"Git revision, branch, or tag to describe. Default: repository default branch.","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, describes pipeline in a user context.","schema":{"type":"integer","format":"int64"}},{"name":"mainScript","in":"query","description":"Alternative main script filename. Default: `main.nf`.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/describe-pipeline-repository.RequestSchema.json b/platform-api-docs/docs/describe-pipeline-repository.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-repository.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-pipeline-repository.StatusCodes.json b/platform-api-docs/docs/describe-pipeline-repository.StatusCodes.json new file mode 100644 index 000000000..a947d8925 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-repository.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineInfo":{"type":"object","properties":{"projectName":{"type":"string"},"simpleName":{"type":"string"},"repositoryUrl":{"type":"string"},"cloneUrl":{"type":"string"},"provider":{"type":"string"},"configFiles":{"type":"array","items":{"type":"string"}},"workDirs":{"type":"array","items":{"type":"string"}},"revisions":{"type":"array","items":{"type":"string"}},"profiles":{"type":"array","items":{"type":"string"}},"manifest":{"type":"object","properties":{"nextflowVersion":{"maxLength":20,"type":"string"},"defaultBranch":{"maxLength":20,"type":"string"},"version":{"maxLength":20,"type":"string"},"homePage":{"maxLength":200,"type":"string"},"gitmodules":{"maxLength":150,"type":"string"},"description":{"maxLength":1024,"type":"string"},"name":{"maxLength":150,"type":"string"},"mainScript":{"maxLength":100,"type":"string"},"author":{"maxLength":150,"type":"string"},"icon":{"maxLength":255,"type":"string"}},"title":"WfManifest"},"warnings":{"type":"array","items":{"type":"string"}}},"title":"PipelineInfo"}},"title":"DescribePipelineInfoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-pipeline-repository.api.mdx b/platform-api-docs/docs/describe-pipeline-repository.api.mdx index 1bd6c3337..52c9077ac 100644 --- a/platform-api-docs/docs/describe-pipeline-repository.api.mdx +++ b/platform-api-docs/docs/describe-pipeline-repository.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of a remote Nextflow pipeline Git repository sidebar_label: "Describe remote pipeline repository" hide_title: true hide_table_of_contents: true -api: eJzFVm1v2zYQ/isEP22AJ6dZMmD+siVLWwTr2iBp1w9BANPSyb6EIlWSchoY+e+7o6RYjlTHCQLsky3eC587PveykkHNvZxcyhJL0GjAy6uRzMCnDsuA1siJPIfgEJbgRViAyCAo1F7YXCjhoLABxEf4HnJtb0XrRbzHQMLSegzW3SXiqCzBZNHB+lgYVYCwTuSV1uLL+Qdxi2Ehpn/w+TSRI2lLcIphnGYE5CTCmsFZc8v5gydSLZUjqwCOw1lJdkEm8WckkeP4VkHU3IyuddbD9RMk82QkpqYJ7he04wVobac/dzEzTJ8uoFByspLhruRrPWXMzOX9/egBiYMler5yK5o6b7XmSMycMulixNfRO4lgRdakIBEnkKtKh0kXd1afNXa7Iru17saXKgVK8lZwX1tFYaoCHKYCMzABcwSXiNNc2AJDgGz0ANOvGYGG+FJ5cCK1JlBOB+EhiebgSJRbV6hQH/12sAG4UGguIq7teI800cEQf5Yg2EbUQpGjBnbVSeKU5YnJp9uTRrXhwJfWeCoUku/v7fHP5rWf/iYfMUgTWKrKUmMaaTy+9qyy6l9hZ9eQcjylY9IHrC9o03dqcruDtrN8/jGmqYeeAsOi1PBD8ZpJX5we1Ei1NfAjId2+JEK4YUtrcpy/o8z7jlw5p/jdMEDhB1ka2XmC7plWbQ0904xCyJ8PsVAGc/Dh6Qdqe8m/1KawZkKhvn8AMw8LOdnfG/UT19T0cSzpXQyWu/te2ALO1Bx6ukPKcwyFzaomOx31N4fDuDs1sam/t38wYGAaWj7puVP+jx0PqasqLKzbyTOm/bwdHvYUSTNg0Hz0Nf+nfXzmqnKGNJ5Fn46zs26xdwWPBx8rnDd9iF2Q6sFQJzpWGY0Hao4+PKclsQk6yHgvKMB7ZsjV6Alqt4qDFdIG8tY563rIfx3ooe3gF8YGoWjq3hIeVveQVg7DXZzyx6AcuKOKX+ryitszrQALy8vCHCJGxSI5flhvxsjJZTdu2e4KFTc0uQih9JPxWJWYUJ+rssTDN0KRoO1NlosoEWdaBZ5T4i/WF0dnp5IxtBAvOKN1drpAHxLEN7bjhr9nUYlO6j/v2gl4fRti6NgOgSabDQq+9imAHC6mNI9rZaaCSiMVNoPvhkxsQB0HcG7/XAu6LUa+SX4/TPZi97c+UCOMXa4e0y1r2y2x7G9aj3Gv1iT9P9fO5n14SxmXmtoNB1jVY69mVHdhbh7mivspD4FLuVrNlOc5eX/Px/V2wkzL0KuZ5srKlfawJfrXWEsHw7iBu/VevFS6YhXJ29Xu4F57S90CtLM2vxDs62+tW+Bu7tIvRPzSvXULro2VeQ3rij8cMq7YQInCoOIKR2StLY/SFDaserNjo+2+f/tZ1jO30+geNbbovZ2P5q7jmwonany2N2CoeFr4gb/pIhoY/wEV5RWV +api: eJzFVk1v4zYQ/SsETy2gyk6a9OBL6zS7i6DbbZDsdg+BAdPSSJqEIhWSchII+u/FUFIsR1rHDgL0ZIvz9WY4nHkVdyK1fHbDCyxAogLLFwGPwUYGC4da8Rm/AmcQ1mCZy4DF4ARKy3TCBDOQawfsCzy6ROoH1nlhn9AxA4W26LR5Ctm8KEDF3sHmmCmRA9OGJaWU7NvVZ/aALmPL3+l8GfKA6wKMIBgXMZ/xcw9rBZdtlKtnTzzghTAiBweG0qk4ueCz5ifgSHncl+A1t7PrnA1w/QRhGgZsqdrkfkE9yUBKvfy5j5lg2iiDXPBZxd1TQWGtM6hSXtfBMxIDa7QUcieapm6NZsBWRqgoCyicEylzmsVtCUJ2DokopZv1ccfNWWu3L7IHbe5sISK4iHeD+94pMlXmYDBiGINymCCYkF0kTOfoHMTBM0y76QhUTLDSgmGRVg4e3Sg8VA5SMDzgiTa5cM3RbydbgHOB6trj2o13Lh0YJRyugZENa4QsQQnkqlfEJclDlSx3F20RcAO20MqCJfnxdEo/22H/+YsH3CepHElFUUiMfBtPbi2pVMMQenULEeVTGGp6h02ArnwXKtF7aBtN5198mQboA24xLyT8ULzppG9GjmpEUiv4kbAweo0xmHFLrRJMP6JskLZyYYyge0MHuR3tUt+d52gOtOre0IFmhdHJ4RBzoTAB616/oG6W/AvGz4JZxXPx+BlU6jI+O54Gw8K1b/rMP+l9DNb7+850DpcihYHumHKKLtdx2Vanp350Oo679ya29afHJyMGqm3LVz33nv9Lx2PqonSZNnt5xmhYt9PTgWIdcIdO0tH35O/u8qlXhVGo0oPap+fssv/Y+4KXi48Urto5RC7qgJ+MTaIzETMD9yXBO2AkkQkaiIkX5GAtdcgieKW1O8XRF9Il8sEYbQbIfx2Zod3iZ0o7JqTUDxB7Vxai0qB78lv+DIQBMy/ppm4WNJ5zcJkmspCCxyhIxCfP9GaCVFxyY9YdVyhpoPHMucLOJhNRYBhJXcahhXswIkQ92CzXXsIupXC0p9ifpM/mlxecMHQQr6miTXX6QJ8LRBG7dUPfK6/Eg/bPx24D3j44nzp2S6CtZouCwr4GkNLFCGyrTK0gIt8K28n3U4ZcoPQLONF/bAT9EcOPwqPpcTj1419blwvfSu2e7tq2o4nFkGq9BF5tuvT/5J3tBRFNmRRSoKIEy2bvNS3VZ8ztzSxooNIWuOFVtRKWFmVd03FDT6jVYrRiJelpJUJa2JH9e/DS0TTu4GlDjNdClqTCiV7tD+69aeoOoD3e/Eaw709bd8DdJtNvRPxW4roD1xZn3sBa0IdBwuUnaMAzEJ7D3VSt5TyKYMtqsDy25u6nD195s3R7k+7FZPPeuwWpnnq+q6rR+KrvQNU17+A7+ub1oq7r/wBGCxW6 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of a remote Nextflow pipeline Git repository. Append the r id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-pipeline-schema.ParamsDetails.json b/platform-api-docs/docs/describe-pipeline-schema.ParamsDetails.json new file mode 100644 index 000000000..e29256c85 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-schema.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"pipelineId","in":"path","description":"Pipeline numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"sourceWorkspaceId","in":"query","description":"Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace.","required":false,"schema":{"type":"integer","format":"int64","nullable":true}},{"name":"attributes","in":"query","description":"Attribute values to include in the response. `schema` returns the pipeline schema, `params` returns the pipeline config. Returns all if omitted.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["schema","params"],"x-enum-varnames":["schema","params"],"title":"PipelineSchemaAttributes"}}}]} diff --git a/platform-api-docs/docs/describe-pipeline-schema.RequestSchema.json b/platform-api-docs/docs/describe-pipeline-schema.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-schema.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-pipeline-schema.StatusCodes.json b/platform-api-docs/docs/describe-pipeline-schema.StatusCodes.json new file mode 100644 index 000000000..3ea858a6a --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-schema.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["schema"],"type":"object","properties":{"schema":{"type":"string"},"params":{"type":"string"}},"title":"PipelineSchemaResponse"}}}},"204":{"description":"Request OK - No schema found for given pipeline ID"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-pipeline-schema.api.mdx b/platform-api-docs/docs/describe-pipeline-schema.api.mdx index 9f65b6365..1ffe1aa6c 100644 --- a/platform-api-docs/docs/describe-pipeline-schema.api.mdx +++ b/platform-api-docs/docs/describe-pipeline-schema.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the pipeline schema of the pipeline identified by the gi sidebar_label: "Describe pipeline schema" hide_title: true hide_table_of_contents: true -api: eJztVlFv2zYQ/isEnzZAkbMuHTA/zV3bISjQBm6LPnQGTEsni4lMqiRlxxD033dHSZZk2U6bh2EPy0MSiR/F7767+3gld2Jt+fQrz2UOmVRg+SLgMdjIyNxJrfiUz8EZCVuwzKXAWiCzUQobwXQyfC1jUE4mEmK22vultdyCYssWcRsvAwbKSNzvMUvh8IBV4cAuw78V6/0sX1xfsyv24d2SGbC5VhZZSBVlRQyn2Iy335zYHstIOGCC2SKKwNqkyHD9WwHWBWwnXcqUZlZskV4TZKILFeNv0wvocPTt66NjecB1DkaQfrcxKvja67mCu2bLR/9VhOXCiA04MJSDkit8QHinFEIkpSAXLuXHeWm/xlSxAZSzk96ECKaIpAE835kCAl6Hwqcld/ucjpHKwRoMQjGwjXD1q99ueFUFBy47bR5sLqIeGRTK7EdsvrTAM3Sed7zVhYngy/eS+OjhbHeJC/tsMbG7FFMofPqlWlMtpALF6rKaGL1hQmlMuOk+OBQ2EZn9IWUDroosE6sM6qz0Q+264HKMsxbHtiIrqCv1oSWk8gXaFnvIljU3qn9XGHWyhQPsTapDewYVaZXIdcjmzaLIMiYTpjfSOYhJEXjMMx3DeUGEMYIikQ42tvfeYihqTV/ARJEN2UFneDN6vKLFq60wJJQ9g3LSkah82GKzTtOqqhaUu8YGiASaC/0ZyvvhHX4XQ3ZYMLQq8jwjv8DVyb0lSNmLr6uFAysiU0enV/cQOaJpyA+crI8dqdOoUB3iGS9V5yKcNwFRfAhCwxuHNK+9DX0QzfC9HpvayNCIy80pdV6JuLXK58qEObRiDU/r1AIvqvHGGG2ORLi5/vVEXltHRnN3VMN6h3wIbiEqjHR7b8GvAG3AzAr02+nXBZUM+nOqycXX4DmSFU/55HBhTsrOr6vJoTQtmG3r64XJcEvqXG6nk4nIZRhluohDC9+QVCj12Mj8CrvLhCMLYX8Sns3ubjlRahn7EqjF6vM+6EUnttZLzysPwjf1P29bc7rfOa+EVIn22xtxGxZ07FMEKVyJbtqAqTJE5CtjGHw/ZBRKZt4bE/1Ht4BESLn6nF/C31+G1743tHUb4Qurccz2Wj02tGOyZVeo/w8zzxhmmmpy8OgmeSbwbsJ0+LSWTTv058eATwcDTGeLKWaQsGW5EhY+m6yq6HV9zVGfxNLS3djdrGfT+NS0cZLyA+xHE42/Q/Etp5v4+8//VwaNC0GcmoueGcp/cJ64EPhgSuoiXtCDkfVk9UOV9NO8uZt+Zk8M1CdZtQOO2vf5tGx7jVAtEJ2CiNGAiWENmGFh5K63dXSPDq6gv958QqwYuvyRq/uvn6SFfecRn/QDKOy9lqWjZyJYVf8AywXacA== +api: eJztVk1v4zYQ/SvEnFpAsb2p0YNO9Xa3RRCgCbK72MPWgGlpZDGRSIUc2TEE/fdiKMmSP7ObQ9FDc3Ekjsj33gzfTAUkVw7Cb1CoAjOl0cE8gBhdZFVBymgI4QHJKlyjE5Si6AKFi1LMpTDJ/msVoyaVKIzFcuuXVmqNWiy6iJt4EQjUVkVpE7OQRFYtS0K3GP2txeBvcT2ZiCtxd7sQFl1htEMnlI6yMsZTaI4/n574PFaRJBRSuDKK0LmkzITF5xIdBWKjKBXaCCfXGHckE1PqWCTGDgjtjr75cHAsBGAKtJL1u4khhA9ezyXet5988rtCAIW0MkdCyzmoQMscIYReKQhAcQoKSSkc5qXbTegyR6uiXno7ggCYkbIYQ0i2xAAaKhBWQNuCj1GacIUWAkiMzSU1r36dQl0HOywbY59cIaMBmOcS7fYIzdcu8Ayctx3vTGkj/Pq9ID75cLG5hEV8cRiLTYpaSJ9+pVdcC6m0GPdZTazJhdSGUrT9hvvCJjJzP6RsALrMMrnMsMnKkGp/Cy5znHVxYi2zkm+l2V0JpX2BdsU+EosGG9c/lVafvMKBWPg6dGeiIqMTtRqJh3ZRZplQiTC5IsKYFcGXIjMxnhdEWiuZiSLM3eC9I6v0infQZc425PZuhjejlytevFpLy0K5M1GkiEWF/Ss26zWt63rOuWttgEFcTyb8sy/v3S0EEBlNqIlXZVFk7BfK6PGj45BqwK+vhR0qBtOwM8tHjIhhWvYDUs2xR+q0KtQ7PsdL9TmGDy0h5lcHcD2ZHlN6aLxN3N2KK/GXOTa1I0NjLNNT6ryXcWeVb5UpR+fkCl/XqQu8qMZHa409EGE6+eVEXjtHFtoQ17DZYOy3chiVVtHWW/B7lBbtrKQUwm9zLpkcKTXs4iv0GNmKQxjvGua46v26Hu9K06Fdd75e2gxCSIkKF47HslCjKDNlPHL4jFaOlDk2Mr8i7jNJbCHid44Xs/sbYEgdYl8CjVhD3Du9+MTOevl56YMgaP/5ozOnxw15JZROjP+8FbdFwce+BpDpqghdG8yVISNfGfvkh5Qxlyrz3piY3/qFOgBWrjnn3ejd5Ho08ZfDOMqlr6zWMru+euhoh2irvlL/n2beMM205UT4QuMik0pzOnxeq/Y+DAfIAMK9Cab3xdQ44tiqWkqHX2xW1/y66XN8UWLluDn2rfVsGl8bN05CfsLt0UjjmyiEANyKv//8f2XSuEDi1GD0Rir/wYHiAvG9MalnPOcHq5rR6ocq6aeHtjn9LF6ZqE+i6iYcvR3i6dAOLkI9rwNIUcZoPcImYBZFWNDg06NGuteD/vz4GQKQ+zZ/YOt+95OwqqqJ+GyeUNf1DiXxMwOs638AkBPalQ== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -39,36 +40,30 @@ import Heading from "@theme/Heading"; Retrieves the pipeline schema of the pipeline identified by the given `pipelineId`, enriched by `attributes`. `200 - OK` responses include the pipeline schema. `204 - OK` responses indicate a successful request, with no saved schema found for the given pipeline ID. - + + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-pipeline-secret.ParamsDetails.json b/platform-api-docs/docs/describe-pipeline-secret.ParamsDetails.json new file mode 100644 index 000000000..4ae64f5f9 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-secret.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"secretId","in":"path","description":"Secret numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-pipeline-secret.RequestSchema.json b/platform-api-docs/docs/describe-pipeline-secret.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-secret.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-pipeline-secret.StatusCodes.json b/platform-api-docs/docs/describe-pipeline-secret.StatusCodes.json new file mode 100644 index 000000000..10d8b075e --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline-secret.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineSecret":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true},"name":{"maxLength":100,"pattern":"^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\\1)){1,49}$","type":"string"},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true}},"title":"PipelineSecret"}},"title":"DescribePipelineSecretResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-pipeline-secret.api.mdx b/platform-api-docs/docs/describe-pipeline-secret.api.mdx index 075770e61..2c3d82734 100644 --- a/platform-api-docs/docs/describe-pipeline-secret.api.mdx +++ b/platform-api-docs/docs/describe-pipeline-secret.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the pipeline secret identified by the giv sidebar_label: "Describe pipeline secret" hide_title: true hide_table_of_contents: true -api: eJy1VW1v2zYQ/isasQ8J5rdsWYH4S5d23RBsQIO0xYC5XktLZ5sJTTLkyamn6b/3jpJs2RbSBsU+2eI9vHvu+NxdIVAughhPhFMOtDLQD5B6wCCmPZFBSL1yqKwRY3ED6BWsISS4hCQDlEqHxM7jZ3M9qa4nKgODaq4gS2abiFioNZjkY2W/yj4ORE9YB16y+6uMAvwaw83guvb1JkIJ5qSXK0DwzLQQhj4I3ngigGJ+TuJSHJKufCQmX4FX6Y6WJ6SH+1x5oNDoc+iJkC5hJcW4ELhxHEEZhEWEzq1fSayOnp2LsuxtaTxYfxecTGHH5D4Hvzmi8lcD7GbzlOhTJh+cNQEC3/hxNOKf/Xiv/6CrqSUvBtkqndMqjeUe3gaGFMdB7ewW0lhzz4+Dqgrg9p+ETnbFm1SVIE6P+1DZ1yTXEybXWs40VM9S9upCF2IlP/0JZkGvPD4bjVgWSJrgVP+ZyP6/l/2/P0xPno8no/4F/aeT6Q//nXw4PXn+3fv3Z6enxVnv/KL8Xmx5BtKzWQiKoGXAdwHaBGtji18mEfqoiAtXX2avjd5sObLxJZ3itziJNFz2LU7ICyrk4omDNmqbujvtppYUQRl83iWqFzJL+Okh4FPU1VbLCkKQi68QTAM8KkU7lVfeW3/E/KeOdmhmTWIsJlJr+0B8GE6DJPcKN3G4vADpwV/mrLLJlDuNJs/S8nxa1MOITWJ4ODCHRTOQSu5m8OtmXuVe04Ulogvj4VA6NUi1zbNBgHuiNFC2Y2qxJbnWEvnRk5eMTy6vrwQTavi+4fJWpWqz3laLIzaDhb9nEUQn1Z/fGjndPlTqUGZu4/W6tDULDvslgpyuSmk1VGDWhUyjLvaTb6dM0lA69v3c/rIzEBGuXBXnbHDx82DEZ84GXMkoq3rwNiI+3D2HZIudTP+PHVYXG+ETDp2WtACIbcy6qLXSsVx7YrxdX/SiS0qOcUUxkwHeeV2WfFztEZZQpgKPRFLhXOoAj2T4hS3TyfYONkeLbC11zsiouLX0qhrJT+JyclO3/Wny2B7u5FQfSrNpk2m4botXTgm7pBlInphcZb5MU3DYung0nfYa+/dXbwkr97vnoFui905S9GgR8dbegSnLLUfkbyZYlp8B3vo85A== +api: eJy1lW1v20YMx7+KRuxFgp0f0gUDqjet23VDsAEN0hYD6notLdH2JdKdckc5dTV994EnyZEf0DQo+srWkUf+jvcnrwLGpYd4CoUuKNOGBp4SR+xhpiAlnzhdsLYGYrgidprW5CNeUZQSo858ZBfhs9seNdsjnZJhvdCURvNN8FjqNZnoU2O/SD8NQYEtyKGEv0ghht9DujldtrHeBFdQUKDDnJickFZgMCeIoYsECrTwFcgr2IduYkSmzMnp5B7LgQJHt6V2lELMriQFPllRjhBXwJtCMmjDtAyuC+ty5Gbpt3Ooa7XFuLPuxheY0D3JbUluc4DyT+d4nOYx2WcC7wtrPHnZ8WQ8lp/dfK//AgWJNUyGxYpFkekklHt07cWlOkxq59eUhJo7uRzWTYJi90riqle8aVOJmXoghk6/5XAKTJllOM+ouZZatYWuIMfPf5NZ8gris/FYZMFMTo767xQHXyaD9x9nJ8/i6XjwdDJ4j4Mvs1/+O/l4evLspw8fzk5PqzN1/rT+Gbacnp02S6gVZOj5nac+YGvs8aXINGCdU5AOpq9NttkyivGlI+TvCRIwivR7gtQKWLMUD/baqG863mlXraSgrsX5/JioXmAaydWT58eoq6+WnLzH5TcIpnM8KEX/KK+cs+6A/Ncj7dDNmshYjjDL7B2lIZSnpHSaN2G4vCB05CalqGw6k07LiVdW5tOyHUZigtH+wBxV3UCqpZvJrbt5VboMYlgxFz4ejbDQwySzZTr0dEsOh9oemVpiiS4zZLn06KX4R5PLCxCgjveNlLcpVZ96Wy3J2A0W+Z4HJ1Dtnz86OV3fNerQZmHD9ra0LYWkfQhQjqsT8q2z6AKToIvdw/ePTDnqLPT9wj6/N9QKpHJNnrPh2fjJcCyLhfWcY9BVO3k7Fe8/Pvu01b1Of8Qj1lab6TOPigy1Edpw7KoVy5HXVUG8fb9mClbWs/hV1Rw9vXNZXcty85CIhlLtZSamEC8w8/SVEz7wzBylvaHNwUu2xqwUzyC5NTrdzORHsZxctX1/Gn3tIT7K1C6i2fRhOtZt8epZrWBFmJILcI15kiRUcG/jwXja6ew/X70FBbjbPnvtEqIfhaqqxuOtvSFT11tGlm8BrOv/AY4QPQk= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the pipeline secret identified by the given `secretId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-pipeline.ParamsDetails.json b/platform-api-docs/docs/describe-pipeline.ParamsDetails.json new file mode 100644 index 000000000..355b151e5 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"pipelineId","in":"path","description":"Pipeline numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns empty values if omitted.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","computeEnv"],"x-enum-varnames":["optimized","labels","computeEnv"],"title":"PipelineQueryAttribute"}}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"sourceWorkspaceId","in":"query","description":"Source workspace numeric identifier. Used when accessing a shared pipeline from another workspace.","required":false,"schema":{"type":"integer","format":"int64","nullable":true}}]} diff --git a/platform-api-docs/docs/describe-pipeline.RequestSchema.json b/platform-api-docs/docs/describe-pipeline.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-pipeline.StatusCodes.json b/platform-api-docs/docs/describe-pipeline.StatusCodes.json new file mode 100644 index 000000000..2635df3fb --- /dev/null +++ b/platform-api-docs/docs/describe-pipeline.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipeline":{"type":"object","properties":{"pipelineId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"repository":{"type":"string"},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"},"userFirstName":{"type":"string"},"userLastName":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"visibility":{"type":"string"},"deleted":{"type":"boolean"},"lastUpdated":{"type":"string","format":"date-time"},"optimizationId":{"type":"string"},"optimizationTargets":{"type":"string"},"optimizationStatus":{"type":"string","enum":["OPTIMIZED","OPTIMIZABLE","UNAVAILABLE"],"title":"PipelineOptimizationStatus"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"computeEnv":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"}},"title":"PipelineDbDto"}},"title":"DescribePipelineResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-pipeline.api.mdx b/platform-api-docs/docs/describe-pipeline.api.mdx index 43e9b70d0..d2e5ac604 100644 --- a/platform-api-docs/docs/describe-pipeline.api.mdx +++ b/platform-api-docs/docs/describe-pipeline.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the pipeline identified by the given `pip sidebar_label: "Describe pipeline" hide_title: true hide_table_of_contents: true -api: eJzNV9tu4zYQ/RWCT7uAY6fttkD9VOeyhdF0N5tLF2gQwLQ0tplQokJSTlxD/94Z6mpbcpwtsOiTLfKQPHM4N665E3PLh3c8kQkoGYPl9z0egg2MTJzUMR/yK3BGwhIscwtgITghlWV65j/LdUyGEDs5kxCy6cpPzeUSYjYpEeNw0mMQGxkscsxEONx4mjqwkz7vcZ2AEXTmOMRTzzyHKVwWyxGQCCMicGCI8ZrH+IHAen+ESCKcCLfg21aU+7A4jQBJ1IQNHW7gKZUG8GRnUuhxiywjwYdr7lYJHSNjB3MwCJ1pEwmXD/3ygWdZr+JSW1RyeUrBrHbIjMJQ0l+hWLWELYVKSWTNZByoNERNYy+kAZvo2AJ7N1FiCsqikBONe0XyHwgnzDrhUotjgY4S3Ok8Xk7e9xneW2piyyBK3KrcXc6YjqRzEJLV8JIoHSLzmVC2zWphjCD60kFkG+MWScdz2gHlJP+p6OBYThL/1HzIq16OCHy0FIbUsgeuctIpaNzfFxJ0VIqG6jfkf9bm0SYiaPhCu/5fS2CHN3zb7VudmgC+Hkri2sPZ8z4u7NZisDwvMJBEEIC1qDoTzC4E+modfDOjIyZijd5i6g03/brrijtN6/E4VXgrJD8FRZbd0365L3pn+PH4mH42zfr8h79D3DV2NCuSRMnAB/bgwRJkvUtCTx8gcBTjhtKAk/kBpYGHIyl3HHBrveLOth0627qklnkZdEwYSLSVTuNVt02nFszB7Aj8qYshTX6Uxrq9iAuxB6DN/GAuiO3cpxlxh+1WrejccymtnEolXbuOISisAc3jplorEDFNKjT6NgnFJqDKVhUdQhxh7gFvYJ6FqtrTplcDciPMHFxLNtzCXfu0vC9pfr68Gf85/vv8DMeK/6OTi3P8uv00+ms0vvBfLUnw8+4xWZVBX8/eHTEk/3Ps+CLTERx5dmy/NmnPYCZS5TqnV3imDLqmx0jWJFqJTsegCz818BbHyGrdL0jZs+mZ0364UaHeJmqtR6eECRpBbDpUnLenpQbX04pcTXjbf3ZnttutqyLPU4FF2Ie2TH8iQkb1Bax7S8qvS9Idxz7Aijl4H98rYwnca/q5MdrsMP+ppUaVrSbDmsmEUvoZ+RDcQpAan3qwwzwBLLNmlGI7Oby7p/KH7edCU3uKGcB3pDTFB1X3PFjXhSijRgLMsuxXU6MQu3AuscPBQCSyHyidhn0LT8imL/Vuh+Bn2GXhEuyU8Gx0OebEpaR6TcrmKjUJV0LRiWVP46PCg3Ak//OxdP2HZ+clkPFM++WFqgULOvY1gmSuxDalAJNLiMC7xKbxTZPRK6Ty2WWmf6snKJugcvk5P/R//bl/7MNDWxcJ71FF11V6btUNbbNc16753d4yhfQOXtwAI1r6HOQ1WBdO03xy9fiw0b/g1S7QSoKs11Nh4daoLKPhvI8kXwqlpcasbus6Lf6/PDVaFXmE1farqSghnFNjfbiZr3X0e47ffDV84/nfpZnfY0Tb26M25Z4+jMx7+Te5z7urIlu/Z6+8oFvJlY1IvGryKUk3nD67R/QCRIiZiRjmgBHKlLjG0p3KspGUfz+/QazYTH9b6c7v3koLg80jbvQjxFlWsXT0TQSz7F+p7/jZ +api: eJzNV1Fv2zYQ/ivEPbWA6qRdsQc/zW3SwVjWZmmyAgsCmJbONhOKVMmTU9fQfx+OkizZlhynA4o92dKdyO8+fvx4XAPJuYfhLWQqQ60MeriLIEEfO5WRsgaGcIXkFC7RC1qgSJCk0l7YWXisvxMqQUNqpjAR01UIzdUSjZjUGeNkEgk0TsWLMmciiZya5oR+MoAIbIZO8pzjBIZwFjBM8bL6HCLIpJMpEjpGvAYjU4QhNONDBIoBZ5IWsFtFPY4weYpOxQ1gx5M7/JorhwkMyeUYgY8XmEoYroFWGU+jDOEcHUQwsy6VVL769S0URbTB0lRUY/mao1vtgRklieK/UovNJ2Ipdc4kW6FMrPMEhTKBSIc+s8ajeDHRcoraTyIxsRmpVH3HZCI8Scp9JCaxTbOc8NwsJy8H4gopd8YLTDNa1aOrmbCpIsKEq8ZvmbYJwnAmte+qWjonGb4iTH3rvSenzJxHMHnK+tnAgQhKkBBBg4dV9e0VJ79aSsds+SO/IkUaW+v3FxM6qkmDok3/o3UPPpNxSwvd/H+pE3vU8GOr723uYvxyLIjPIV08HsIibjwm4nGBRsg4Ru+VmQsp/EI6TJrNN3M2FdJYWqBrBtzWdd8S95YWgcm1llOmnzdFUdzxeKUWgxjenJ7yz3ZZn/4Ia2gIDXFUZplWcdjYJ/eeU9b7IOz0HmPiPe7YBkiVE9QFHp/J3nHEqkXVmu0KuthZpI64insCDjPrFVm36gznHt3R6Dj5Yx9CDn5QztPBjAt5IMG6+dFYrJv3jtPecceNtvmid8yl8mqqtKJuHhPUSNiebmqtRmk4qKWnmyyR2wkbt9rA4YxXpFIMBZYutDl7uvhqpVxLN0fqcMOdvM/Blg+Z5qfL6/Gf43/OzyCq/4/eXZxDBDcfR3+PxhfhqcMEP+1PU2wc9Gn37tlD6j/vnXDI9GyO0h27l035M5zJXFNveGVkquK+8NgQusxq2SsMXvD3Dp8jjKLh/YKZPZuekQ2vWyfU80ht+OilMNOSGE0Pi/NuW2phfb8B1wDe1c9+ZLfduqp8ng/YIoK3XU7/TiaCzxf09BzLb46kW0jReznHoPGDNNaJB0s/d866PeS/dJxRdaspjCUhtbaPmIShPMa5C9Zzu4Z3KB26UU4LGN7e8fGXIi0st6dzDBi50xzCyaZ7Plk3B1HBjQS6Zd2v5k7DEBZEmR+enMhMDWJt82Tg8Ss6OVB2v0MIEXFZSUK853wxuhwDY6mhfmZmS5bagDdE8Yx1TxN2RUiCqPrzoZb+/SMFCpSZ2fB5xWqFgqd9CiCXq2L0VTJLQsZBEtvFt0vGVCod3GVmf2sC7CbofDnP68Hr0zeD07A/rKdUBklVbVct3U07tAtz3Wjzp11mKu4Jv9FJpqUKJhRIWFeqad+5Ihi2Gpi7CBbWE6es11Pp8cbpouDXZSPJYkqU586s6et6K/6/3DU6GXnA1e61qTpDALizPr7Mp1r6A9NvXxt+cP6f0s0fKKLr8tGUcscPTpXN/LPk8+KqsuuX4okrdCe4uhMxqzaeGnRL9MVdEcECZYIuICwTRnGMGbU+3Ttatlz59/NriEBu+9+O34XRO2Gt12XGtX1AUxQblMTPDLAo/gW1Wvj+ sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the pipeline identified by the given `pipelineId`, enri id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-platform.ParamsDetails.json b/platform-api-docs/docs/describe-platform.ParamsDetails.json new file mode 100644 index 000000000..8b06131c1 --- /dev/null +++ b/platform-api-docs/docs/describe-platform.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"platformId","in":"path","description":"Platform string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"regionId","in":"query","required":true,"schema":{"type":"string"}},{"name":"credentialsId","in":"query","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/describe-platform.RequestSchema.json b/platform-api-docs/docs/describe-platform.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-platform.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-platform.StatusCodes.json b/platform-api-docs/docs/describe-platform.StatusCodes.json new file mode 100644 index 000000000..271d0c3fc --- /dev/null +++ b/platform-api-docs/docs/describe-platform.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"metainfo":{"type":"object","discriminator":{"propertyName":"discriminator","mapping":{"gke-platform":{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"clusters":{"type":"array","items":{"type":"string"}}},"title":"GkePlatformMetaInfo"},"aws-cloud":{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"Bucket"}},"keyPairs":{"type":"array","items":{"type":"string"}},"vpcs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"Vpc"}},"images":{"type":"array","items":{"required":["arch","description","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"Image"}},"securityGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vpcId":{"type":"string"}},"title":"SecurityGroup"}},"subnets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"zone":{"type":"string"},"vpcId":{"type":"string"}},"title":"Subnet"}},"instanceTypes":{"type":"array","items":{"required":["arch"],"type":"object","properties":{"id":{"type":"string"},"arch":{"type":"string"}},"title":"InstanceType"}}},"title":"AwsCloudPlatformMetainfo"},"seqeracompute":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"jobQueues":{"type":"array","items":{"required":["name","state"],"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"}},"title":"JobQueue"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"Bucket"}},"fileSystems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"dns":{"type":"string"},"mount":{"type":"string"}},"title":"FsxFileSystem"}},"efsFileSystems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"title":"EfsFileSystem"}},"keyPairs":{"type":"array","items":{"type":"string"}},"vpcs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"Vpc"}},"images":{"type":"array","items":{"required":["arch","description","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"Image"}},"securityGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vpcId":{"type":"string"}},"title":"SecurityGroup"}},"subnets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"zone":{"type":"string"},"vpcId":{"type":"string"}},"title":"Subnet"}},"instanceFamilies":{"type":"array","items":{"type":"string"}},"allocStrategy":{"type":"array","items":{"type":"string"}},"instanceTypes":{"type":"array","items":{"required":["arch"],"type":"object","properties":{"id":{"type":"string"},"arch":{"type":"string"}},"title":"InstanceType"}},"discriminator":{"type":"string"}},"title":"SeqeraComputePlatformMetainfo"},"k8s-platform":{"type":"object","properties":{"discriminator":{"type":"string"}},"title":"K8sPlatformMetaInfo"},"grid":{"type":"object","properties":{"discriminator":{"type":"string"}},"title":"GridPlatformMetainfo"},"aws-batch":{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"jobQueues":{"type":"array","items":{"required":["name","state"],"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"}},"title":"JobQueue"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"Bucket"}},"fileSystems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"dns":{"type":"string"},"mount":{"type":"string"}},"title":"FsxFileSystem"}},"efsFileSystems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"title":"EfsFileSystem"}},"keyPairs":{"type":"array","items":{"type":"string"}},"vpcs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"Vpc"}},"images":{"type":"array","items":{"required":["arch","description","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"Image"}},"securityGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vpcId":{"type":"string"}},"title":"SecurityGroup"}},"subnets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"zone":{"type":"string"},"vpcId":{"type":"string"}},"title":"Subnet"}},"instanceFamilies":{"type":"array","items":{"type":"string"}},"allocStrategy":{"type":"array","items":{"type":"string"}}},"title":"AwsBatchPlatformMetainfo"},"google-cloud":{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"zones":{"type":"array","items":{"type":"string"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"GoogleBucket"}},"instanceTypes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"arch":{"type":"string"}},"title":"GoogleInstanceType"}},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"GoogleImage"}}},"title":"GoogleCloudPlatformMetaInfo"},"local-platform":{"type":"object","properties":{"discriminator":{"type":"string"}},"title":"LocalPlatformMetainfo"},"azure-batch":{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"pools":{"type":"array","items":{"type":"string"}},"containers":{"type":"array","items":{"type":"string"}},"vmTypes":{"type":"array","items":{"type":"string"}}},"title":"AzBatchPlatformMetainfo"},"eks-platform":{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"clusters":{"type":"array","items":{"type":"string"}}},"title":"EksPlatformMetaInfo"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"jobQueues":{"type":"array","items":{"required":["name","state"],"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"}},"title":"JobQueue"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"Bucket"}},"fileSystems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"dns":{"type":"string"},"mount":{"type":"string"}},"title":"FsxFileSystem"}},"efsFileSystems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}},"title":"EfsFileSystem"}},"keyPairs":{"type":"array","items":{"type":"string"}},"vpcs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"Vpc"}},"images":{"type":"array","items":{"required":["arch","description","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"Image"}},"securityGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vpcId":{"type":"string"}},"title":"SecurityGroup"}},"subnets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"zone":{"type":"string"},"vpcId":{"type":"string"}},"title":"Subnet"}},"instanceFamilies":{"type":"array","items":{"type":"string"}},"allocStrategy":{"type":"array","items":{"type":"string"}}},"title":"AwsBatchPlatformMetainfo"},{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"Bucket"}},"keyPairs":{"type":"array","items":{"type":"string"}},"vpcs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"Vpc"}},"images":{"type":"array","items":{"required":["arch","description","id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"Image"}},"securityGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"vpcId":{"type":"string"}},"title":"SecurityGroup"}},"subnets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"zone":{"type":"string"},"vpcId":{"type":"string"}},"title":"Subnet"}},"instanceTypes":{"type":"array","items":{"required":["arch"],"type":"object","properties":{"id":{"type":"string"},"arch":{"type":"string"}},"title":"InstanceType"}}},"title":"AwsCloudPlatformMetainfo"},{"type":"object","properties":{"locations":{"type":"array","items":{"type":"string"}},"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"zones":{"type":"array","items":{"type":"string"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"GooglePlatformMetainfo.Bucket"}},"filestores":{"type":"array","items":{"type":"object","properties":{"target":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}},"title":"GooglePlatformMetainfo.Filestore"}}},"title":"GooglePlatformMetainfo"},{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"zones":{"type":"array","items":{"type":"string"}},"buckets":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"}},"title":"GoogleBucket"}},"instanceTypes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"arch":{"type":"string"}},"title":"GoogleInstanceType"}},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"arch":{"type":"string"}},"title":"GoogleImage"}}},"title":"GoogleCloudPlatformMetaInfo"},{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"pools":{"type":"array","items":{"type":"string"}},"containers":{"type":"array","items":{"type":"string"}},"vmTypes":{"type":"array","items":{"type":"string"}}},"title":"AzBatchPlatformMetainfo"},{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"clusters":{"type":"array","items":{"type":"string"}}},"title":"EksPlatformMetaInfo"},{"type":"object","properties":{"discriminator":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"clusters":{"type":"array","items":{"type":"string"}}},"title":"GkePlatformMetaInfo"},{"type":"object","properties":{"discriminator":{"type":"string"}},"title":"K8sPlatformMetaInfo"},{"type":"object","properties":{"discriminator":{"type":"string"}},"title":"GridPlatformMetainfo"},{"type":"object","title":"SeqeraComputePlatformDescriber"},{"type":"object","properties":{"discriminator":{"type":"string"}},"title":"LocalPlatformMetainfo"}],"title":"PlatformMetainfo"}},"title":"DescribePlatformResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-platform.api.mdx b/platform-api-docs/docs/describe-platform.api.mdx index 922aa597e..4c3fa5d01 100644 --- a/platform-api-docs/docs/describe-platform.api.mdx +++ b/platform-api-docs/docs/describe-platform.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the computing platform identified by the sidebar_label: "Describe platform" hide_title: true hide_table_of_contents: true -api: eJztW91z4jYQ/1c8empnOJK21841T03uQoZe26RJ2j5kmDlhFlCwLUeSwxGG/71a2Qb5A/MRKFzPT2Brpf3tarW7krVTouhAkrMHEnpU9bnwJek0SA+kK1ioGA/IGbkFJRg8g3TUEJweKMo86fC+eXS5H0aKBQMnHcFhPQgU6zPoOd2JIRqwZwicTylFu/epSRqEhyAo8mj3NJcPhmcXbhIiTRBSQX1QIBDhlAT6QRMuRtEkDAGGVA1JHnU6jiM1eg1vjkpoUgFPEROg+SoRQYNIdwg+JWdToiYhMok7kdmsMec75mIkQ+rCgvFTBGJS4PxPSugEkQ+CuVneBV4sUDAwTYiXqvjVT28z3AUMYk3lWG8jiavpERD15GsG7CCxDHkgQWL796en+JNVxvVHPabLtYiBwlYahh5zzbSfPEokmRZZ8O4juAotQKCRKBYz8NH0gj4vo+wx5OqzgCoukCDpOvkjljnb3iC+BoJiaMrBCN6kRrUaRIFRTi0NMqYi0H+l1UiFoKhcpsCXpZNDXC+Ssamv30t3U0x5+O5qNF85v2s1tVFNupmO5RvX41HvcIJ1I3cEap1OS4CZ5V06dCr8hWFhXo1gckPZZmpskOfQfQVA1itVF5MfoE8jT1mtXc49oEEG/d+ha56ZTwdQCWOxNh90o5t3eg1E0ohXuV6cW4GOXURJQ2ZZl7QbPJWz1Eb5zBsJbiSYmlwJHoW7V/xSGfQ0t8u6WCDvbGgx2KgbvMp+l6B84cH2KA2m2GoCqWjgwr0m3sx4tjWRNWbawpR1U+dj+R7dke2rWOKrJDzphCBOKGC1WrfzRo+8+2cE0fqqMsakwSmq1lhVS00v7l+ptV8TaAfwmn3mwd1E5kbejZ33grKp0BGYR4GqRtiSn1tzZKYF+rK1N6wW50ubTx1Y6sDy9QaWFvWZx6rtpzgg9Tzu3im9wYPBZLOuX0BEK9lvVM08xrX3cVwrC3yjd3KHGxCL88d3smxTMBBsB/sBe/OhBywTDHcfXaoyyv2Pdx91vK/jfR3v63hfx/sjjffZzeEFRouyUDLgfODBoc+yUNXHd/x1ZXRjufe1M6g9ZUsxoELOtNovHZunSQRJ/E2hoXCUkWZYei1Qbz853W84dGmy9RIJOHS6FeqwtOnBNw9QiA2PvrV389c171Jf87LU1cBol+n4gb4HXI5KUn8k0B7sum++p9UJeZ2Q1wl5nZDXCXmdkG+ckB8qfNRfk2ufU/ucvfuclan1sX9NXqVG3KGh9W24tL/Gg4W8dpu5vFVqVbxmW6+oGEBZIlqx9tLp2wp/KwVdtqc/olh3zEZRnzbtPqRtedpUn/WsSmOXnvX8nw53vlRhym+uvlYYi0H5V/AdMljy+bvIofJGQHoBXuwW3JLz4s6Cothodc9fy79NbnzjHGqyt2V3vi9oz8H8UAdZssHlbzul9EFKdIMrs8qUsFIHl0JwUUD+QxH5dVqS4ARcObiFHms89ibDnJxeABUgziMMlQ8d1KUPasixjAEzmUYSRcnJvKriZLooW5jhaSaI57SuIRKeph0qFcqzkxMasqb5ytWM70M2GSf5CoPYfpx5iYOJDM75TdvMawr1DjUba8kGPFcUciTJBX+zmzRE+k38p5UWIzyO0zifXL3PWLFhuwogistckAmxCQOuMYms8LbI2ioYtiHbXxYNGA205mI+3zV//rF5SkwwksqnxqKSKofUcueFKXmU04Vp7q3GJVG1gs8KjYEFiNXInKZadulNg5xZ1S16KodaKiSZTrtUwl/Cm83wdVyrgbajHQHterhm+tSTUCHhiqqUUqAj0FxyhS/P1IuQ0nip9dl/c5us7m+dam5Wocu+WeXrYBb8OvggGDLcUM0W88oKpFJYafQMJjaaFK5lGrOOph4C7emxEF9McO66ECqra8HfZlzV1eW9pqVZp5BzAvaHoiwsbZKG4p6PIJjN5igVPiPA2exfiFDKBw== +api: eJztW19v2zYQ/yrCPW0A66RdMRR+WtI2QdZt7ZpueygMlJbOMmOJVEnKqWvouw9HSbZkyX/jLOmqp8Tikffj8Xh3PPLmYHlooP8RkojbkdKxgQGDAI2vRWKFktCH92i1wCkaz47RC9ByERlPjdxPX8VJaoUMvXIETwQorRgJDLzhzBGFYorS+1RSXAWfesBAJag58bgKoA+vHM8hviuIgEHCNY/RoiaEc5A8RujDchRgIAhgwu0YVlGX43jGaoK3QKWBgcbPqdAYQN/qFBkYf4wxh/4c7CwhJnknyDK24Hur9MQk3Mcl488p6lmD8z8loSfTGLXw67wbvIS0GLomwstt/unn5zXuGsNcUiusD5mJr9EB4pG5y4ADIjaJkgYNtT87PaU/dWG8fQMMfCUtSkutPEki4btlP7kxRDJvslDDG/QtaYAmJbEiZxCT6smRaqMMBHGNheRWaSIous7+yOdcb2cQ8yShafTnEE7wSalU20E0GK2IhcEt11LI0FQaudachCssxqZ1ccCPUpOr+u69MgZW2Ii+XU4WO+d3tPyKxJQx4LfmiR+pNHi4iQ1Tf4J2l05rgLnt3Tp0Oflzx8J9muDsHRf7iZHBNPHvAFAEreIS5hWOeBrZSutQqQi5rKH/O/HdbxHzEDfCWO7Nj8C1v2r0GCFh+S4fsMNA5yaipaG2rVvaHZ6Nq3RF83NfDPqpFnZ2qVWaHF/wa+cwTfyrti4VkNdVaDnYdCjvpL9rUH5V8nCUDlOuNdJYLn38MEv2VJ5DVWSHla5gqpups1vzksxR1VaJwlYZ/Iya5wEFbhfrYdboRg3/TDHdXVROmRgYy+0Ou2qt6uX9N0rt1wLaA1jNkYjwemZWRj6OngeybSkYxCqVdjPCC/PlYoHMteDIXNwb1grn11U+nWPpHMv361gueCwisVl/mgPyKFL+tdXcYjjbr+s34NFazhubVp782svcr7U5vskLc8QDSIXzmxem7VAQanGE80D18KFFq0en08eQ25pw/+PTR+fvO3/f+fvO33f+/pH6+/rh8Jy8RZsrCZUKI3zoXBaJ+vGlvy6dbCrmfecI6p6ipRxQI2babpcem6UpJlLYm0ZDI5VRRliR8nl0PzHdbzR0a7D1NdX40OFWolS0b+JbSZrEnqlvBtN4V/VutTVf15oanBwzHH+g+4DXk5bQnwiUxLcjd5/WBeRdQN4F5F1A3gXkXUC+d0D+UO6ju03ubE5nc+7d5jzi3Ptut8nbxEgnNNK+Pbf295hYWJVubyVuNVbpuxzrLdchtgWiG/ZeuXwH4b8oQbed6R+Rr3vMStFlm47v0g7MNnW5nm1h7Npcz/8pufOtTqb95epdJ7P1FvyIDNZcfzc5bHwRUD6A18cFtyZfPFhSNBsr3Vef5b8vXnzTGmYMnre9+T7ngUfxIRq7z+PvakgZozFkBrdGlSXh5mSS1ko3kP/URP62LEnwpLIeHaFvMagdMlzm9By5Rn2Wkqv8OCBZxmjHisoYKJJhhReFk0VVxcl8WbaQUTYT9bSsa0h1BH0YW5uY/skJT0TP3XL18veQPaEaFQa5/niLEgfnGbyzd1duXUuo1yTZXEpVwAtBEceyHsGdJh0RsOKfi7IY4ea29PPF0/uaFju22wDSdIWPpiB2bsB3KlGffHXKGHMRuVqIkfpl2UDeALXJ+TztPT191jsF542MjblTqaLMoVTdRWXKKsz5UjfvrcilkLXFL5a0QUjC6iZdxlrV2hsG/Up5y4DBWBlLJPP5kBv8S0dZRp/zYg1SnkAYPoxo04x4ZHDDDLeUpbQCneCsUfky5VFKlM5M7c7+h/fF9v7R28ytUuly36xWC2GW/Ab0QwtiuKeYK8w3liC1wirdp5xV0ZRwK6qRDTIGY+QBaocvJzjzfUxspWvD4NZs1eXrD8CA163CihWo3hTVYc3nOcUHNUGZZQuUln4TwCz7F5rEyiw= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the computing platform identified by the given `platfor id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-user.ParamsDetails.json b/platform-api-docs/docs/describe-user.ParamsDetails.json new file mode 100644 index 000000000..576981676 --- /dev/null +++ b/platform-api-docs/docs/describe-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userId","in":"path","description":"User numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-user.RequestSchema.json b/platform-api-docs/docs/describe-user.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-user.StatusCodes.json b/platform-api-docs/docs/describe-user.StatusCodes.json new file mode 100644 index 000000000..7d047a2d4 --- /dev/null +++ b/platform-api-docs/docs/describe-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"description":"User details including ID, username, email, first name, last name, avatar, and organization membership.","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User numeric identifier."},"userName":{"type":"string","description":"Unique username."},"email":{"type":"string","description":"User email address."},"firstName":{"type":"string","description":"User first name."},"lastName":{"type":"string","description":"User last name."},"organization":{"type":"string","description":"User organization name."},"description":{"type":"string","description":"User description or bio."},"avatar":{"type":"string","description":"User avatar URL."},"avatarId":{"type":"string","description":"User avatar identifier."},"notification":{"type":"boolean","description":"If true, the user has notifications enabled."},"termsOfUseConsent":{"type":"boolean","description":"If true, the user has accepted the terms of use."},"marketingConsent":{"type":"boolean","description":"If true, the user has consented to marketing communications."},"lastAccess":{"type":"string","format":"date-time","description":"Timestamp of the user's last access."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the user was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the user was last updated."},"deleted":{"type":"boolean","description":"If true, the user has been deleted."}},"title":"UserResponseDto"},"needConsent":{"type":"boolean"},"defaultWorkspaceId":{"type":"integer","format":"int64"}},"title":"DescribeUserResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-user.api.mdx b/platform-api-docs/docs/describe-user.api.mdx index 8b86d09d9..8109738bd 100644 --- a/platform-api-docs/docs/describe-user.api.mdx +++ b/platform-api-docs/docs/describe-user.api.mdx @@ -5,9 +5,9 @@ description: "Describe a user entity" sidebar_label: "Describe a user entity" hide_title: true hide_table_of_contents: true -api: eJy1Vktv4zYQ/isEL20B107bbYH6tNlkWxgtuotsgj0EOYzFscVEIhWSSpoa+u+dGT0sx87WadGLLZEz37y+0cxGJ1hHPb/WdcQQ9c1E+woDJOvdwui5PseYBbvEK7rWE11BgBITi86vN9rRCwmxLklPtHX0VkHK6dmIZsVIdMj6ytUlBpspa9Alu7ICGfC+tgHJWAo1TnTMcixBzzc6PVWMbl3CtYiufCghtUc/vdFNc8PqsfIuYmSN709O+G/X9IffSDXzhOIS30JVFTaTEGe3kUU2+0b98hazxBEHTkiyrQGOdN+CBGcwgS2isi4ramPdWi3OJ4oVOEsTRfi2mKiVDTGp9qiA4REeIEGgf2eUD2tw9i/xUJVYLindua2m5M2XvbPmmLQdWZqpbiYS7x9S5AE3pkDB7aM4e1/jEK9oS8hHqLIDIqvAGCpoFG3J1JHGGWGbWVHn5L5Ce6iFKI9LcCTATtUGoB3Bo3BGR4SpltYLUEuQIzFaYXV18ftId2Fep/2MCs7zS/Y8JUvvCwS3h7RYKelnlfKWFSqHqMYgUaGDZYFG4OmbUsYPK3LgjNu5bdV/ZQOyDKuERk4FVvkVX4udEsIdJor9v5rJWn2249WASsdlWbs+xIGJp+RUjIcKMHSngYTfJkuMfe7AJR3GBGXFgfROfBVbzoIgt2QjhLOA9Huw1K+y9Jij2wb8yAG3yENIV5X5nyxJXHUL33VRgbumXlerJZKJDoQAmW42FdgR/qIbIefJC9ERzcvkEG9WUBfpsw93sYIMF0d9dsdWx1O1t04CLPLm0Ah7B0bxnKSMvWaWbUfrtaZsR1gjT/gvD5FecK+s4wDeh+D3Pf/hwPDttwlufQVF4R/Jn0ayWAXMWgZ1kx+zOtj0JKvFO4SA4bSmXWJ+fcOTfhe4T6GCtsz8rSJVanBMuefVZY0SHG8jcz2T/Wa2aVeVRrO18NDvMXWgMaXzlKo4n82gstOs8LWZRrwn96fW7/Hsk9yojwUkrrM6Y3l1+nGh2dU+kk9cijat43iGzLJF3a08QjIRopP24ZeeQbePSXJm3cqLeleGzgs2+08OcriWvhSdMHMIMuHQbvDjkLv5LWbfbi/IEc5ca+e76c8/Tk/4rPIxlSAU7PbCF2t0eCom/DPNqgKsdJm4tenq1++nEz3vlk3Kck4G+WqzWULEq1A0DR9TmwTmED0+QLA8YqTIxkYZN3q+giLinhdDW+mvL7rG+Ua9vLcedLo7BMdRPkBR8xs93uHTdk9ubkgyRzC8S5Jj7eWpjK2R2l5vM7MGdv/6/pJkYZdPz/gj6AddopSJxKW/Q9c0g4eJ39nBpvkbT/8xeA== +api: eJy1VsFu40YM/ZUBL20B1c5uFz3o1GyyLYwW3UU2QQ+BD7SGtieRZpQZKmkq6N8LUrJix86us0VPtmfIRz7yjckWGFcJ8mtoEsUE8wxCTRHZBT+zkMM5pSK6BV0lipBBjRErYjHNr1vwWBHk6juzkIHzkEONvIYMrHrWggQ5iL/xTUXRFcZZ8uyWTiEj3TUukoWcY0MZpGJNFULeAj/Wgu4800pNlyFWyP3Rz++g6+binurgEyXxeHtyIh+7oT/+DhkUwTN5llus69IVSnF6k8Sk3Q8aFjdUsDCOUhB2fQBhuh9ByVlidGUyzhdlY51fmdl5ZsRBqpQZqtCVmVm6mNj0RyWOX/EeGWNm0FsT4gq9+0czNBVVC4pp7eoJZF/JztljynZkaybQZcr3T23yiJs4Or/aR/HurqGRr3or5SNcJQG1NWhtpJTUWyt1ZHBBeKqsuktxX+E99kKdt1twJMBO10agHcOjcLaOTIhm4YIC9QI5EqM3NlcXf2z5zuzrvJ9JwQf5UTwvySKEktDvIc2WRt+z4XWvCrPGZLZBkiGPi5KswjPFKn1cXiU6k+fcP9VvioFFQTWT1VOFNWEp1xqnwnhL7Pzqv4Ypen+JE8yIaopQVY3fUByVeFoUlNKhBoyv0yLTj+wq2kvg0lWUGKtaiGyS+C71mkVF7sWGTGeRkOlgq18V6WFN/onwgxDukUdKV7X9nyIpr6aHH15RSbuhXterBZE3A8gEOpGb45IGwV8MI+ScgwqdyL4sDs1miU3Jf4V4m2osaHbU3+521O2puokOXScm7w6NsPdojcxJSvyaWfY0Wq+hopRwRTLhvzxENoZ7bd0m8CHGsJ/5TweG72abkKdvsCzDA1mFslRHKnoFDZOfiiY6ftTV4j1hpHja8Bry67lM+l3gTQkN9m2W/yp+hAwq4nWQ1WVFSk62kRymut9M235V6UCixfvNHtPEEnJYM9cpn06xdpOiDI2dJLqjiBMX9nT2WW/MpxJZ+mzOxN6cfpqBpLph8lla0Zd1m89YWYkIw8qjIlMjyIYvv24UdPPAWjPnl0HdhzYMWUjYryUodF1BaTAWDWGhGtolv015mN8a9peniy4DqVwf583kzcnbyYkc1iFxharBYTF8sUmHxyLT3zytS3T6zDSvdmjgZkHNIB+2zXkG65BYrtp2gYmuYtl1cnzXUBQRzTO4x+hkxmiXrUs6byBfYploL4vxXcH3F8PL+cG8vLgeTHo4RC8s77Fs5BdkcEuPT4tyN+8yWBNaWSav2+HyVOfWltve4xZpjfL+7cMlZIC7gnomIEU/mFLb9haX4ZZ8140ZsvyWBLvuXyaeMZ0= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -46,30 +47,24 @@ Describe a user entity id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workflow-launch.ParamsDetails.json b/platform-api-docs/docs/describe-workflow-launch.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-launch.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-workflow-launch.RequestSchema.json b/platform-api-docs/docs/describe-workflow-launch.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-launch.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workflow-launch.StatusCodes.json b/platform-api-docs/docs/describe-workflow-launch.StatusCodes.json new file mode 100644 index 000000000..2d5cea1c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-launch.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"launch":{"type":"object","properties":{"id":{"type":"string"},"computeEnv":{"type":"object","properties":{"credentialsId":{"type":"string","description":"Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)."},"orgId":{"type":"integer","format":"int64","readOnly":true,"description":"Organization numeric identifier (read-only, set by system)."},"workspaceId":{"type":"integer","format":"int64","readOnly":true,"description":"Workspace numeric identifier (read-only, set by system)."},"id":{"maxLength":22,"type":"string","readOnly":true,"description":"Compute environment alphanumeric identifier (read-only, generated by system)."},"name":{"maxLength":100,"type":"string","description":"Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters."},"description":{"maxLength":2000,"type":"string","description":"Description of the compute environment. Maximum length: 2000 characters."},"platform":{"maxLength":25,"type":"string","description":"Compute platform provider.","enum":["aws-batch","aws-cloud","google-batch","google-cloud","azure-batch","azure-cloud","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform","moab-platform","local-platform","seqeracompute-platform"]},"config":{"description":"Platform-specific configuration. Structure depends on the selected platform.","type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp (read-only, set by system)."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp (read-only, updated by system)."},"lastUsed":{"type":"string","format":"date-time","readOnly":true,"description":"Last usage timestamp (read-only, updated by system)."},"deleted":{"type":"boolean","readOnly":true,"description":"Deletion status flag (read-only, updated by system)."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"}],"description":"Current status of the compute environment (read-only).","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]},"message":{"maxLength":4096,"type":"string"},"primary":{"type":"boolean","readOnly":true}},"required":["config","name","platform"],"title":"ComputeEnv_ComputeConfig_"},"pipeline":{"type":"string"},"pipelineId":{"type":"integer","format":"int64"},"workDir":{"type":"string"},"revision":{"type":"string"},"sessionId":{"type":"string"},"configProfiles":{"type":"array","items":{"type":"string"}},"userSecrets":{"type":"array","items":{"type":"string"}},"workspaceSecrets":{"type":"array","items":{"type":"string"}},"configText":{"type":"string"},"towerConfig":{"type":"string"},"paramsText":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"mainScript":{"type":"string"},"entryName":{"type":"string"},"schemaName":{"type":"string"},"resume":{"type":"boolean"},"pullLatest":{"type":"boolean"},"stubRun":{"type":"boolean"},"resumeDir":{"type":"string"},"resumeCommitId":{"type":"string"},"headJobMemoryMb":{"type":"integer","format":"int32"},"headJobCpus":{"type":"integer","format":"int32"},"optimizationId":{"type":"string"},"optimizationTargets":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"}},"title":"WorkflowLaunchResponse"}},"title":"DescribeWorkflowLaunchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element. Existing run name and session ID combination","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/describe-workflow-launch.api.mdx b/platform-api-docs/docs/describe-workflow-launch.api.mdx index fb4ab0e7a..c431c66d1 100644 --- a/platform-api-docs/docs/describe-workflow-launch.api.mdx +++ b/platform-api-docs/docs/describe-workflow-launch.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the workflow launch associated with the g sidebar_label: "Describe workflow launch" hide_title: true hide_table_of_contents: true -api: eJztXXlzGkmy/yoVmthYKUKAr53Y9V8PIezljbB5QpZj1+EQDRSoR30wXd2SGIe++8vMququPoAGyWMb10bMWkAdWVfmL7Mys74cxM5cHLz+dHAXRjczL7wTB5+PD6ZcTCJ3EbthcPD64JzHkctvuWDxNWdTHjuuJ1g4o4+6HvOcJJhcM0eIcOI6MZ+yOze+pjJz95YHbKSL9qaj5sHxQbjgkYNd9KbQySl1OeYfVaEzag6KLZzI8XnMIyTzy0EAH6B41hYUcZHKhRNj8TzpujUmYAjBnLlTHsTuzOURFI34H4kbceg9jhJ+fCAm19x3Dl5/OYiXC+xEVjp4eDjO9SsWzoRnHf+R8GhZ2TMVZEHi88id5Psu9eUGMZ/TT7Mw8p1YfvXrK+j9M5IqFmEguMAaL549w3/y/b3/DapOQmgliPFXZ7Hw3AnNb+t3gUW+lDsNx7/zSYyTHOFqxK7sQC7l5nLutGKykAp/kcS8G9ziz9ksf0L6Zu4c2qHZhOY8J8bhVn6zprD6CSZmPYET6Bcn3fFEr4LW4pp1suLGajHolKkxMR7culEY+PAjcxLY3FBIznKTncuRCsbvXRHjdpt4YTJlQNMtNBe1/j3oMIOkJhtyzj5Br3BczB8+H17H8UK8brWm4UQ0Bf8DTkrTDVt6ChrOwm1NqF7DqHfUxOkPo3lusCt3Fm4rZ/o+8Jb6BBS2VDR3AvdPGl3FLmaHWL0RQv1jJnjMxksmliLmvqTDPCpPQM26A7WJFLlRfef+jAdzYBOvX7w4Lu2F9d13qjaAt7h2NlAz5wGyOWCHBZokQ8lR9fzZszJZeTI+BC7wG4aVaV8ie63Ym03WT0QMvwQCtiLy6ucNaD1H8TGbOuL6mEErSQDbU0zCCBq7Bn47QXZLVOZ6z0/hs83UnmaftLyoJta5d/3EZx61/Zph20VK0uNfIOMfZSI4jBDZjXMnGmMnJjGCf9NxhL/nYTj3eMNzZ0Cfy4MJcIv0W11BfdR1nD+TKPtRftK/3fxTNAzuxG9yH+c33PyYzHMfhZfAeTa+8MTM/Oh4IG4j8xs/dMa5CuHE8XJNEr9QE51ra/181Br5VmPdNLjCXBRHVh77XzvWR6zyNxt5Cb1pxqVLpOKoKWU1SdISnBhoSSMWfAJcbcJkySRSwm4ITHISw/wAIFzwYAqAMKADLrgHohj4ne4Qsd56MY2S4tSNNgtolAFsCjJ2EofRkiHkIy4o4CPBOxAukc+niD8zZDpzPa54SMTPk2BILW7urT2dMofJb2BoTgyCnU9gLgEdyLEGs4aCvarUInKRKYdQ4Da8QZLe8fuYqIAhA58BCKfE/gCmzglgmkIRN6IkUE3UEP60IVuy45YzvXWAgU1/gbE1oL2Gbq+h2pPSBr99mqE7M5hjECRexdDYtXMrWbwHiH36TUZqCBZjnE4UOQjSXZC/YjOy1cJ5/Sx1DSxw60SuM/akaCZCbh0v2bURqkutXAOUMBoZh6HHnaC8YAD3l7BSrsgagW2ImzRdJmyK/R6OmwZIf6KmtVSH1vGkPRznYL8C8HJCjvMfEcO7sceJUyGHgfm4VN2UAEjlZAmkBkGfOpRVCIMAlyK2k7K8jWfAxT8dzxynwQSxX1SzlmqfF0oR39l1j2tiG7KtBrYl9/fURSJ9N3CA6W0ehWbkDIuxXOUyanYE8G0YWCorJDOHlo6aJYT8UEWMOkbLd1Jdzv8Ocg7mC6lEDJcTeTgOtQ368EN+oisECPCf9zMyCDyRaEkX7y4vY5RUm3iAp3n0d8EEwFKYJVwQhecV2B4jl2POWIQeyVsUTsj2DAWN+ViQmCRN/V0E/Ig5E+SeVkD9JAJqT/iQLFnrbJ2mp+numkeG2IC5EU90elhvxkLfjWFVQbHlMyfxYpIMI8UCRkR1Inj0rpZw/wAlUzV7OPw3zmYgmSE2i7YcEqhBOFWSGla7XtP/hpLUNLTcGzBnOo1gCKghl1tdhFG80Xzy8kWpD6QY6zbZqZyM12z04sUoxRT/l/A66OTiWhkblPr+B1YrMEWWoNiAOVGsJocM5LFElcFAHTt0Xtkx9Hl37UKXC3fBPTeQAIQBg2YiGcvd0GQd2FiwvcJbHkXuFHYTmmKwmbRWXrdBQn3nnogcun/yXaYfSfeVVSNI/DEQC4Mg6rLjCXRJMjWekoMUUAv0v4CHicBDnS3g82fPshX833D8nroTW/EQ1WMoq6ZGpGqUiMLUmYM29e9VHa5CjXAcyYzGRnlaR7Q6cJolz3LlzjEpaKRLVwErNUhoj2GkziR+CyuqGCla6fPCf0uopLGLxJMIfHJ4UnFTQwUv4CGre+yV7gH/+/xgGpIMjNr+OGQn+OVGoJpfWzRUOHN+QYWqVgegwwStxemWQk4X8VW3F6XityA+fS5q7L7svqawJ06GTLWCU+2HCWyOQ8nugAW1UMy1UDy/buF1kwP8M6LPo530k8cfuojPlXV6Aw+ENZNlFQwBoRsmEaAHducCWhzTHQyZ6g95c94E1pWIBncAwz1XY9tOfJmbRI5G8ndkuYB8AkTfatNCVdwXwdYtZy2enrffdt+lVi+N4nseLCUshvq9Lg4UyQLRA59eiXAW3wHPbkkKWyhGb11+d2SQ3QtEjHhx9b7O7bDOC1A/ZA2pllbRny7C7Hnzxb3nRHOeXwWQKeehV6M/LMXa5+9wi80jB7bzDDZtA/6Ef6as1+4z2IK+KwRJRCi1ircAh9dwpl7X2Haku8dRdjtDFjvipoCLtkBkVWu/mtUq4fu1JmoNj/fcAd7IbzZQINJXTeHYOmc9uTs8T2o3qVlHMZv0crFS97BK9E+hRKt93VkkYhd4/i6F5J3BB4HjDEmOrt/TqtM+90GX7Y936VjW1R3i9l55fo9x//l87oyXsbq/sPhyn/AlcDE4SN0AP9aZB1mSffooj59ih6sPGLZ+ZKqPM1C7uFQgZwny8Bfbd/6GKprmz5X9yz6ODMeYAuUraAtuYccMJVLemsB3l32eoQuFtw0SyvRLa1Y4fxuFyaKGkxByq48kgM/CuQBBCdWUj5AaGIPWxD7Z+uRKDgNnIa7DuI76X9guadUNm6U1T9wpbwld/GjzysGA5rx8gS0h0hv8sTCDyvLRZJ+MMnXnTN+3AycWrVQ1/IX+v0GkNIwimvkdoa9YCHJB+VCWNYOcW1FArEzhuzzxmvXQhgP9zwuXefyhTFpi8617vAKsa++Z4eD9BXwEtF52KuiZ8L3JRlBopMgRLAnoHj5KoDRugjBoTLmPozKRPyzACLvI6uVrDRdhnBVmhzA6jmdMxHJPglKzq/TvuwEZ5kj2kzsE7iyY1A03iL5zv3OXyha4bZfzRbI1C3w7+GDMMuGGsWjDBhxOHG+VVMxbElZa81LSBZrr0VaAO7vB7xewvtQ76P8360bF3oUx/eDIdSYv4RVn2zX0ysfYNDqh7zsNwdGXGFGep5ziEIbd8fy+pC0tp41Q2jDGOvPluqNy0h1eXL3p4XHRf14Nzt+/Pe8Oh73LLnyNO/2q0x60O72L/1y9H1z0+r3/dk/1L4PzXqdb9Xvp5J2iK7SPJ5xdw3mXXEQaTkT+fKGomMBMLVmYxMRQUp0zJ3mrKB4Rf8kObtYofhqtpVnWzR9fuZo+iOJafrgJyG2ftfs91jvFYSRC6rlSYiHDK3AS4woJeeuZGyT3jReobTeQ3fvun3jUsH+p5/icxyK3RbUx6O+C+tVuT8rbybxcwloesvIYJTGcB2j6FtCM4eTY9p0/4VO+e2zWdCXOzE+APvEKRSLrxaTOFF0OOjg32F7AY9SGoRQ1IJIxfPOY03KmTgf2oVojZVeEOGya+oz2WQQrxR3YhCGMPCJ3UpwCYuZQVdIE+y5y4yVBrKcgTTeo0FfvlCiccrRXoErLqdQMJOUd6rBRQm4iuPII0qLQo1HolcDLNuBvzgwWXGIKcd9Hu+fmdXgzvKdFOCMzrbKWLkJXsW9oqN6VYKEdgxFmShc0tut11JrmBTSJ/PrtiTbfgsbN3wenwFO022/du54p1pHwxjCuXvOgEufAtpcV5M7nkxe/8eXAqXOjjKt3w9ED0I3SC1rDj4IY+0kyuXmak+BksHz4ko1lu6o/V+mMqyQ4yN4TECM3uy5dZo8vLpWEzOvhwXqxrgBDWfqyw9vnEmaN3emAwzqCajPfiX6NfLSsXUTuhG50nbyMOGYOTCkaGFVnmplmUkhWlQYTJ85L7GYRMJJNPwhJLEi5AZ3D6XQ9yfeTKMJNKLCWbBj245gjiCY3VikA6BISNkFGVuE+9m9SZ+UzIeM4tjku8rpBAAe/Y903wxL8gUbryIKuDjcptAFsUTdTk5sVGzDYGe47Q3PPbP/bmxCe/CaCqTIGVW3frTN1CmLglvoKZJVA+EkYxrvyAawrwTWxASQ5bf/Y4Ap8IupaGxTOymuY2h6JNxU4Hlj/NAJPenqMl5kC22TtBbp/Z6bTUYvHkxZQgf81ZdsjuauASEIK2n2DnFxY24O/cfuSGY4K+s4SBQgcMqzjwGdvBicY6cOCed2+QsUg00g2gNwACwsMOnzTIbgGtPotidygaktCvNaU3wJPgOMvLRMwpgY1qowkzevY95SRxIm0p0T9M3GeBGUjJrq5vJGtGUYlgdtqst6WRfA8xwgzjQ1nzocZ95pp4zDfQYU2hmwAGyLUkDWuRGvk//pq60PfPu//+oodvo2cWzcOA/NsGOORZB0X7YTHkppqHXGXG8jextvHvLcJbbXUzUSanKbnGuFsY4rPkMTAMMaom+xi2K1GUPpaGg6eufUz992jsl1a3YpnN2XH5a/QvSEXAGN4OLyl7xlZO7d0cvjLPQDshd/+X/itu/DdEyu7vd2zt3v7f7sH2xU3bh10npNBqp5Waup6feXaUO5fhnsXKnWR42kHL8B+NTZ+rk2sQrBJCY/VfTQc6GWlnzrWnbkR6JrUomqNArbHHJMMeGS2VvY0goLtyQQVtK7vuN5mqoeyEpotSK3jWI3ADzr2SGOGlHE5o+1WwKrvoHlW4So9BcHzBrYxdaIpedLlpsDRk1BwCTNtorUNx6DKKaOBtPWSQVCqFpypfCPwycDKKHSUtxEALK3KpUrQZb/JPn0Yw3Ql7OximB0G4u1NCZ5IcVB8hE5Ji3oXrVA0VLaUXxJq4wrW+oip7bNIxh7mDaCyymdd6ZRNRHh4j9Pg8gibqp4DqirnC3bGnYgGd9lfQ9cUijY8VbRx65sE/oIBX1fKdg2E4Uc1c6QHdD6ctgszBMuirjJxRwJ31eG+TfZeW7qPQWgil2iEd3jDNZFaphqndrV0bmFeiOmQhjdLKJY4gtaAiEcrGvk9/DSXaFAhPgX9GxX4tzs5/2BNvUHHqTqv95oO1O4GczfIfBiabLSYpgdolB4MPEWYtwFN3rlz9I9n7O2JNhmax+gbqi2SVT6h2mKG5pt+2fj1j6G07O7BuBn3WzBpweRPASY3aX5bAxjJQC770siqEcxQcd+r0xfi6valAourICj9JJlgTZ8y2auuZLiUXfa1Hxnd8da6GXajOAGwqKpkrSrgLJJxWryWiZxoM2vplnwnAJE+7VF8Zrys0xgGVTYcIdw5IgPVgEqdFC9LtBZ66Hgu/FGnn36x5QlV1bb+QuYu5QD4sTJh1YoezsI5a4M8XEIrgqW5rnQPfhi4MimJbv0CD0W9y2Bll49TRooYKdehtHw6sdMJPRWh3w2mdFGzuflTqAdHS1dkXNWULhbadTHf+nni1ZqWYtt4867nBJpmsLNjPSmPwCN5MXXDK7xzVose07LbdxbNLqhny6sh/diU/1yV74Ifh2u0u3cO2VR8SSZZM5VQ2ST79rdueoOyRZoE1chvyZj8MnAcObCyh0DJWn73wfKLxg5eY6fldrZ08oF+QZP6cH6WSnJN4BLOcgMzemE4IyrKSqYL4XV4VGNCh8MzNsFTQU5iBAUNqcJ1yJLOGJDmQjWplIc4zQZIAmSrcaa1iL+mCa+y2DIDNSn1cGTC3mHOjrRV16JgTTK89CoCuXPx+SupQmT+tCSpFdBAXbNN3LzqnJcnLc3LqQrD7iS/0fLdcT0vcdhlv6iOG0Zbar/JAIWO57h+PXAwQHONwDSvl6TiU1WJEuh23hF4HKVbqGx8xeY4ZupMxOhZ3VCVRsqZktx12OgcluQj5tkARLUcaSuhr7NTqB7IvaReuF9fupRg0J+yhCzSAWmjxYSGtGI05u5ppURLljjtoEIiEXdh1sIpNEs/Atvy3MlS8T28blf8jaBg5tQbBlciofGSIL1zlvhHwG/J1LPu18/llJT3DWy2AZojndlN7Rvq4CAd1YDo1gcFvh8u+OSRXh4wZ2ks8oooNG3FhTUfkgAPo5F0A0aHSYC5sC8w0WiMYaKx6YyL+rs7ZYpS9p92/wwTMau8gaCWRWSOJd44Qoer1yPTvP00I6zyPNScAkb/LcZnbTP7ZZv5WsGotUK7/6Jo1HIw6l7cuhe2gcKaGQ401bU1P37+DpLPWIOyZVpbMK0aptO6d+yY7Mq0Sqgr8AbGgjToOltmhKBf66HcYpM0tjrG6I2m8gf1oELFnZNJYeUNVHUBw42ulChI2Wx0mJaEHd+5wSU1S23nCJHKkEM5X0ckTOTIKfHZareLdawLHfRrnKYPohgy+kSXtgW/a3K0zsVx5TucLJKBaburP39ypgACGJmzyQZOLhU7+F9UElnplfFKrcMT+eYIcX3qALSoEzukLoswfmdKdVRk8ziZz9OQNnHd8/PhJ6s0gdRbWrox6NAg2bS0a2PTfQD7u2yGU6zMPPQJZ4fPGi/lHo+jMMFExNewVTTNk3CxfATRWB11hyx3OajDg8i9BWDYlvkiax6KhaxkJJrkmKsdRM9hEDIQApjm0oOfhc7rOebeFk4AG4OoVgXfyo5S0Id/yCOQho41rYn35zDxWgXqh1WgYBgzcYHZ2Wps0XdvhkxqUSymKvL1BplRW9v3VJs1Q9awST+zKZaj1Kzesl96i3WEqaJNbHltMqTw1iXFyle5Bac5qTGoH6VJUOWjqF0O41DLGjN/Y8RhG/gyOBDPORypaaJdDtJNnmZFJ3eVGv4tg07q25KeLZmmoF4Dw7SsvDUxfLehbVMypEFl3EfuWOPw6mmN08zVEZslnrds/JE4nownjviMR/jolAyC/nTZN1yfVU+1HY1VxYauKI6OaUCY8oOiMfUP0NQIr7Jm7v2xeVm3kSPAPIifYSJq8q5tHDmyd6dMF1XMcfkjOKg+UQ6FVfB/ZSKFdemQdsj1K7OuvqjQgIvZfbfzFCxnsdXtxi+b+AZV4n/VWAe0kNXNkFNOYKMJ+aRc9X2825JpXqHRnbOh0de/KLe9hoyrbigLRoOGBl+6R5kTO5ltqHnsV6ajH3OZcIGwN1K/yURkVcT9VxH3RFmy2ojVRvZfG/lK2VQfExHmRCCEYi5dM4w8FKWUecjJSmnfHx1BtrLlnbNe5d4mWhW9+cicMzmMM85dhOiUMwWAI4PPRvPFy1EhBA3dpRXqyKGtQRTiVmxHNS8aR718xRFlrNc9yMw1JjIL8Ul6pMORmfjvrnHjK58nFUWXJnvSoYsyTDFNnUJ5BaEX8uThQZjMr4uZ8KFBQxOtA+CkHqqd47N8LZ4z4cRvDwVU87jKwaedYZ8ok96wIoOemR9Pq8hGUrV9ih8svM9r6GdD/MW+P2iRtEXS3zWStu8P2vcH7fuD9v1B+/6gfX9wP60L8v1BDFKrwqk2kNMCzx8LeNpAThvIuStJNpDTBnLaQE4byGkDOS3etoGc1g/5KwZyAguPHTeqVLra9BMbnAztDYFV1PZVUdsLhmBvCOwNgb0hsDcE9obA3hDsq8Yibwg8MasEq72TPjsbvrFI1SJVi1QtUrVI1SJVi1QtUv1BkGoSuPGbMDqDPuNqh2boQJpNqUzFPMoyF464Oedk86suYzHx/mFi+T5MKR2XfMyAvrbeMhbafs/Qtnaos3o7JPfqHMY1J2KUZdcZwFHd3JbMv7SAshtkGb4Bhk0W8mitfnleh4+UL/TzjzmbUBydE1h2Cpu5x2/zr5Dpl9TlZBTSSLFpgqOtvECmispfYD0DuPUvlnXiwtMXZLBYLi4pm93y1bNJuKprgpXsAZpX9ACNFBd+p+Bas8NN5WU/5QImfR+vAdrhHAuYYJw84OXqLbpjydkjXGGBCTyochmgYcspqJQuCrCvEKjNo/BOvulceEsO/pGhcs9QuwlYEqRx8VhyiL/XD8DDKg1Nv97PxiApKMoVcPz4++CUS8eRGs1TUd2S3lQ0OCJ6la8CzNmUS34ixamKbzzn8970cRkWdKQkcgEolXtIpwj2/iS6Cy9ax+END061LNyshOojqjSZYXvIqAkzZktzjhzofqFcfORMYG6R90En9dopc4d2boNMzZmX6slMPoPyHfv9oENB0e9HDgQ5aGn8m7DV6gnBLVgxI9Uhuhb07hPotYHou70P94PYB7d4By1IPHpWVcKuKlOKfCTXYZ9Kz6/JR9J2S/6S6Vtp+hfd7hFz4tiZXGfmCRPtIBM8TnFSOp8lN+wwVwvBwzBNGLhrEDANTY+jMhhYRoN3wh8iwKJ2vm6ZezE1JyrtQW7p9BFiliVREuwTPjUbMTikC/aKoeV5p20iSzXUd79ItNDA9FDm9w1DOG1OEP0Eue2VjRsfrzvn6MAMY1bCegvrHKLvCDM/OYDAKHEv2ecU6FOC+cU/2RSAAi6yPCepc/cEyGwlIk2BuTk/u5Xh+yTDd2Ri/KY6PqxNybdY97ehfS3Qms1+GrOZDTKzQWa7kmSDzGyQmQ0ys0FmNsjMonwbZFZmxjbIzL4WaF8L/CmZ1hO+FpiZFWkGtn0VEKubRg39MuCGV//qPB247cuAxsN/njsDSl18zUCYVhj1TBr+zPTv37sJZdVCwk/4luM2V9UP614T3MyFuA+jGlfe+T/s8rbfw9on7h7Wv1z3sO4hOjIib/Gw3MPaF+Ie6j339vAEr7U9DbvfEtPshkfqsaE1z1E9rHtYygqtPRNa2FQyr77X+xDA0WLo8KyfMrJBUtYkvqcm8b1QvWyQlA2SskFSNkjKBknZcP79RayfCbWCkl3ww0Cjx8kOUUvqFuxiuSpyoRSlgYwuWvkAXam4vIN7jPd692SobvKkUxTd+B1KboeXdijlWiidX7dSd0/6rO7gvxvzyGo7l0IhWUAKvS4DEkJ7y696kXA76WVuEjkayd6R4+pbu/TdoSnui2DrlrMWT8/bb7vvsvdeFRbsebCUsBjq97owMPU6vBLhLL4Dlt2SFLZQit66/O7IILv3yJcaq+hPF2H2vPni3kMTQn4VQKSch16N/rAUPRcEW2weObCdZ/j84TyS7yv22v3i40GrWAsweI1m6nWNbUe6e/ny5ZDFjrgpwKItAFnV2m+8ZvpaE7WGxXtuPZcCLJX6IeNbrGc9uTs8Tyo3rg7hUczmkQ6oVofeBx36a13art3Tf+2d7XH50tbCy32ClzZIaEWQ0C3sGBVMsjWB7y77PEMXqddZSkKZfmnM+jovZO6JqU+u5DBwFuI6jOto/4XtklbdsFla88Sd8pbQxY82r9zWYezK8NFkn4wyO7+wLUOs6P8bREpl0IwOrOYixTl5zcD0b0Mpij47Et/lideshzYc6H9euMzjD2XREpsD6OMVYF17UA4H7y/gI6B1ZGQFXGvC9yYbQaGRIkewJKDImyiRl8UsDBpT7uOoco+7QjXsIquXrzVchNm77KANeOjnSkE5KgbPDXaV/n03ILscyf70UVGMvFsZLa5tgjt3qUyB23b56IduJW4Yi/aGeP28JWGlMS8lXaC1Hm0FFNXP7xeYEAF7pxdp14yKvQtj+sGR60z+lSvOtmvolY+LyPd9DGoj722YdM8VMQVdops0n7KSRqreN0aUNoyxzny57qicdIcXV296eFz0n1eD8/dvz7vDYe+yC1/jTr/qtAftTu/iP1fvBxe9fu+/3VP9y+C81+lW/V46eaccg9rwhLNrOO+Si0jDiSg/njyBmVqyMImJoZhO8pnkraJ4RPwlO7hZo+Rau5ZmWTd/fOVqonNFnZd4lUdwu9/D4FgjNkFKLGR4BU5i3CAhbz1zg+S+8QK17Qaye9/9E48a9i/1HJ9zlSdDb1FtDPq7oH7VC8QSo+fvlrCWh6w8RkkM5wGavkUv+Cz/go71ynWPzUqYkO9R6BeZJbJeTOpM0eWgo18qVi8DQynpfk2vEz/mtJyp04F9qNZI2RUhDpumPqN9FsFKcQc2YQgjj46ZUmeImUNV5RL+RK8ka9JExWvJId764WUOqLScSs1AUt6hDhsllMfEfE8ZR6FXAu/agL+hw/hEYgpxv8IrpUjQm+E9LcIZmWmVtXQRuop9Q0P1bgQL7RiMMFO6oLFdb6PWNI+Ph6u3w3dNwJJKB5X+QlpaU+MqJmGpkYBl55fX84+up5z77iSZ3DzNSch8t9jwJRvLdlV/rtIZV0lwfPIdxMjNzm++p/b44lJJyLweHqwX6wowlKUvO7x9LmHW2J0OOKwjqDbznejXyEfL2kWEsRuU8SAnI44xWshBA6PqTDPTTArJqtJg4sR5id0sAkay6QchiQUpN6BzOJ2uJ/l+EkUUTIK1ZMOwH8ecch3A7+kT9AQ5DbIK17F/U0EhM9Ghy4NtjovOkhXwO9Z9MyzBH2i0jizo3sM2JaGYbwPYom6mJjcrNmCwM9x3huae2f63NyE8+U2EzpFgUNX23TpTpyAGbqmvQFYJhJ+EYbwrH8C6ElwTG0CS0/aPDa7AJ6KutWFt5BXeVOB4MNwvAhEE4lykaUFSBbbJ2osFD6aZ6XTU4vGkBVTgf03Z9kjuKiCSkELqKo4+Lqztwd8ygg1OIBX0HUqZBYcM6zjw2ZvBCUb6sGBet69QMcg0kg0gN8DCAoMO33QIrmEccUsiN6jakhCvNeW3wBPg+EvLBIypQY0qI0nzOvY9ZSRxIu0oUf9MnCdBRbQOLMMb2ZphVFJhb2stIjIPi8kIM40NZw5DP71m2jjMd1ChjSEbwIYINWSNK9Ea+b++2vrQt8/7v75ih28j59aNw8A8G8Z4JFnHRTuhzE23Qkfc5Qayt/H2Me9sUsjORnae6blGONuY4qu9wNVNdmFrpAjKSOJmbv1DcoILA29ZEQtVM11F3qWBbJvfezjEE2G7VTaBlQBvnZlmBx8EeRts6uurvA7cR96u63bjl03MhpNgtoScRutof8lCRVMvra28U0xQTc29rFhrQj7JTE8NH6N25fUzNLqzlZa+ThNhSX4PbSNFvEFDgy/do3TE7APQrZJNQb/SS27MJRAkQY3U24toexG9Jzc89mbZ3izv/83yV7rlfQwkdiIQQjGXSScMfFwy5SMnK7mjPfp6aGXLO1vjciETKuMMSagn1IVzGGecU4y1KlwAOP94Bl+y0XzxcqStaW6mzirUkUNbgM9xK7ajGrAOMc+ol684Ik86M994HpkBlxcC6XCkh+DdNW585RdK5CdBaoQ61mCErFqpSkf3HdALaW08CJP5ddFDDxo0rgXqALghldRmkUyP9JwJJ357KKCax9XdgE7z9UQW/mGFZd+026vbDtPY+w3VMakwfQ11zGY6tZlOaxuSbaZTCxf/8kynX2xSDZtUYxMlNqmGTaphWfdXTapR4sPaJ0xmSfzO+fBqzlnsS41OQu40fOJQMvIjUlaMh2gMYzpe3EeOp83p69gxegPUWHKyDpcd3Lbn1RsueUmVzTmN5TucLJKBmU2l/vzJmeoMPqSLozxcySRe76ahLwtnl2glItNVCJ43hHoyq/FKrcMaIbWWdFVPezesk2YrLCBomZhSHeVGDTJtnvrPrRR/5RskbQmSnoXa6CGbbm4tLsuunlCZeXgBzQ6fNV7KPQ5acAKDENewVTTNa6RsHaKxOl4ekObQrCuYqw7FQlYyklrAJkCVmB0GIah96BPoePCz0DlEHinZ697qyY5S2zr+UXiVzqbf+UlubGy+1x/4nmoN8C0t1Jshk0lfWSzNTjhdKnuXSN8qWgeXq5r0sxToZZc4C673CVzba7Rq2sSWrzwM6RpjSY75+UceuO+4Xpb/CiMIUJpI4alt3yojoHYNiUMta8xkERGHbeBLT0Q853CkpolM1mUcyvTSni4RNlOOIRD6xiE9W/Leo14Dw7SsvBjDmxqFDaBtUzKkHmzcR+5Y4/DqaY3TLFkRmyWet2z8kTiedF6O+IxHaJBTb8xd9o0rKNVTtj+IGzdlCl1yh1RHizZOS1ds6Iri6JgGhPFF5Pqpf4CmRvjyxsy9Pza9gDZyBHyA9GeYiJq8K1WOTVtsxZd5Rz77prqF4j8GFLdvqts31e2b6vZN9Tp2Hfum+nf8zJV9U91q41Yb/zba+J5Y9uyb6l/jTfVMLeyd9NnZ8I19WMGqk/uqTu4JJ7QPK9iHFezDCvZhBfuwQmYpTgI3Bn3+DPqMq+0F0IG8X6cy1Y6kUObCETfnnO6Fq8tYpXGflEZ8wsGMqvGSyLcQ2EJgC4EtBLYQ2EJgC4EtBP5BILAFpnsMTH9LxpQulwInf4iQb+u783MjTelavXmIuZ0tczhAvyAXP5yfpb48msBlmESNm3+KBuIddLxT7j1CeB0e1XE1HZ6xCZ6KWXqlkr9ikS9JaaxFiTPwO5NKKf8lnMZ78IUzqcHujBbSWiQAtZOqgVYMqavQ5MjkXcMt/WuNrosOthU+h4YIzCGblVQhe31aktQKpFn1FOLCzavOeXnS9HnuqMKwOynIxy2l9Kx3mwe77BfVccNoS+03ee3W8RzXrwe7B5gBXmAGh0tKL0NVJcAkBOsIPI4yMlOlXajeHMdMp+vDBy8aqtJIaTKU/JCNzmFJPqKG0neC5Uin2fE1rlc9UFRDvVfY+llUgwLji3RAOmHOhIa0YjTm7mmlREuWOFW+IWXXl0EIOEz+CGwLPUcU38MYlu/a42WQjirzeJFOiFN0R64RiLcu+S7MWfpE5IrHwXRkJaz5kAR4GI3k6wyYxz5wY9gX0DgiWdAiRNkdT1HK/tPun8EqRonMQSViJ6Js0sQbR5iC6HXO7f9pRljlPaY5BYz+W4zPAux9Atg20O8HtgAWtoHCmhkONN1e1vyYj4tQj7L8NkwBxxYXAVZPs3qa1dOsnmb1NKunWT3N6mlWT7N6mtXTrJ5m9bSn0tN+WD1pszphmdbeMa0aSTq3fxSIZkBi3Xpo9kI9Jm4aNWgcG6Pl6gS14SX1iqgjk8r1WYHf/ta19hZrb7H2FmtvsfYWa2+x9hZrb7H2FmtvsaqLtbdYe4u1t1h7i2Vaf7G9BY0mplVC5RVsYMRUg+HrPzvZYcwmtQ1ms4llo51mWxvM8VZGmg+Be+swDHTRaXZtcKw1zeypaWYvIIANjrXBsTY41gbH2uBYGxy7r3C/EBzbhjPpRmxwMrTo1KJTi04tOrXo1KJTi04tOrXo1KLTb41O+6EztrjU4lKLSy0utbjU4lKLSy0utbjU4tJvgktzRaif7AG0KZyLjny7rGqqUw6B5RqxSx3nt0zJk1G9LMiwtIgdf4EP8YKoC6HKMWzKGFmXRJ1aCov4w2L6hDScQYssoSZXkCF/nFaSIp6YDoEOzFuRod7Lq9xc63vUz/mh62acAGv0nHmdHmXxqmEX+ytpLStLai/kznm3fdF79xaKtC/bvbP2yVkX/j7tnnXV193z8/fn3VP4q/fusn3WOz0o71nY182hpBJ3dNF9NorIK1aOWgn6Kr/ZbC6OTE/pFTSWCTuuX/QzymAARY58/hNE6RkP5uhh/urZv34tOliTpHJ9J1rWWHZTjGTzc5U73lfUpIIH1R5z6sfci1rV8ODXVwcb/PMifuuKSl8rcocW+FvV013ES5HeQRQiMt/mRUgFhoccEHa8ZUUcCwWe7FRbknwB/LtyRBSPsMYtDSMofLGy+hP4OvqOu94VMo6W1Ugfl2tyzX1n5c+A9JPcT+ZzGonnneGbtCue2xBxMgbKq3+UDa/eYfgr7HFAVit20g4Oxds7P0MNRJ6++ycJuhWkmEUunGjOV7xRsr0ENg//RxUTc0ZqyzkXC8Cn+SKnxCnHfGVRLPzq2TNCmzmueuLgG+kA6AUiPIxIU6CQUK90t279LuSZl3sG/zKhi+Z/nzfFZBqMsnza9FC6URRGJcpflil/Dy1LFBKEKhAI6KHS/yqXPk3kcEBSeBylRJN1711BkQ9oSiH9DRV5xcbwKUGQLWME5cqr8nucG+K7kyRy4yXJ6xMOakvUTlACfSJY6PP4OgRaDmB3Yq8U/nTQ0oFWrS/6r970QZlVDrQTuaA2k8iDGtou4yzcJtlgMuNMWamnX9hAqSCsg+VZe9Ajsa4JHuKMydGbZKcTgD0eKEZFTIQKwTfyjzf61Px+F9MsucEspOr60RdJBXa7iUAVaSNUYXp7c0JLnR+8OWRYbdcjhjEL/yf7AbUaDBWjfp43//WP5jPNzX0nyBSn9MxmMW/p7OeI/ZLtvINzDpuC33L5LvWUx0BCCoUK7TBHiHDiEhJM4zrn7i0PpK1JrvnIeB08BlmFhjaXGDWN/IvaMJ8OdBUo/jqrfqANbLjD0bKERb98GTuCf4i8hwf8GphLJHcnKLrK35neMV0z0I9acqNVgkfuRL3kOXNpB1QSfMOhl0zmE3FKwTygjadVsy1pOVQPs06PmOavTB7OGkRpuBEsTWpMYtVE4uUCSSkMIgb6ZIH2ZMIXsVG1xHpyZ/xt9+KA3hM3z1Hh3Ji4Pk8WrBuVuMDnrmHtNJX0/DUS+PDw/1YZme4= +api: eJztfWtz2ziy9l9BaerUiat0STKzW3v86VVkJasdK9GxHKf2pKYsiIQkjkmCA4CylVT++1vdAHgTZVGyszN28GFqYpEAGiDQ/XSjL19bii5l6/Rz65aLm0XIb2Xrt3bLZ9ITQaICHrdOWxdMiYCtmSRqxYjPFA1CSfgC/7TtSEjT2FsRKiX3AqqYT24DtcJ3lsGaxWRmXx35s26r3eIJExSGGPmt09YZDjlnn8xL59hdq91KqKARU0wAmV9bMY1Y67SV99VqtwKgMqEKXi+TbnsjUokgXpLAZ7EKFgETrXZLsD/SQDC/dapEytot6a1YRFunX1tqk8AgulHr27d2aVyZUI/lA/+RMrGpHRlfJHEaMRF45bG3xgpixZb4aMFFRJX+6e+/tL59+w1IlQmPJZPQ4vXLl/C/8ngffm21Wx6PFYsVPKVJEgYerm/vdwmvfN0elM9/Z56CRRbwNVSgB9Cfcv97gV+zWEBFlKSKDeP1/i48wXBZaChHNb1VV3WQv15YT7LggphRCYvXgeBxxGJFaKpW8JJehy650F9cEnYXSAUbwgt56pNE8HXgM9H752RACiR1yZQx8nkgGFWs+OC3FyulEnna6/nck13J/mCCdgPeS0Kq4AN2aBL0PGzXKbQ76cICcbEsTXbnt4cPT/0Pcbixe7Ty0cWSxsEXnF3NPiMvoHmHx+GmTSRTZL4hciMVizQdxc38CNTct+X3kaK3UkTvzlm8VKvW6evX7a29cP/wg7oNECYruoeaJYuBETG/SpM+8iWqXr18uU1WmYyPcfBHygg0xn0JDLBmb3bJOJWKeDyWgVTATV91Xr18WaK4TXwqV23CBUljnwnpccGIt6KCesAQkcrS6OUlfLmf2rP8L8vR64mld0GURiTEvk8J9F2lxO79Khl/20eE/XK2g+w8gphgcRqBgKK3sjOnCmUC/BtPbqvdWnK+DFn2yPxpn9Ivqcgf6r/ss5t/yE5Gc7vFbkp/Lm9Y8c90WfpThqmIij+EclH8k4aKBqL4S8TpvNSAezQsdYlMxKx+/uA35KjxIlhuM/2J5TYyYV6wCDyi30yFYXhTJVJPpQLEdsJiXxIe40eWLGQe7Hk7Diz1/awauMVZIPYzaeADxA8E8xQXGwKCGU+CVFwL4VgxETEfUEKOHxZByMw+EuwijafY4/7R+r5PKNG/ELWiirA75qWKSRLoucaLjgEn5q1EBHAwOQniNb8Bkt6zO4VUJIJ7TEpmWf9EMEJjnyRcqo5IY9NFAwGAu6ynB+5Rf01jj/k/JYJ1aOx3bH8d05/mOPDr40ydLhQThIZhzdTIiq71MQ+ZYv6fMtMCcynMkwpBAUoFikVyP3iwDPr+VRoW5MGaioDOQ82ekZA1DdNjO8G22MuK0aIInXMeMhpvf7AkCTdErQKZd6I4btLsM0FX5Hc+7xag1CN1bTn773wOJ+1bEQJ/1qtpF+S3dksFKmTInYGlDOP1lel3S+rUro6E4UHSm1NYJ1ZQyhrqBhmP27vpA/gnDYsTK3A9GBfQ78Zs7MpbyGiO3dSW2I7uqwN96Q3tB0BkFMRU8QY80nJuAq+RUuNtqEQl84FxZ/JRc++AxyfdLVj0rY4Yc24277UWU37ebkU0SYBKENwlMQXzMNtgzOm8vNA1EoOG4YcF6mmPJEvqQB00BqadiZgjpMb0R5QXtZP+q0uKx+cPRkvG3jUtjbaitkgUgA1gmmwIvZ4AuqDbVDLxvpF0+iiZyHSF6fSfFZ3V8nBUTMNUKgDFIHC4VM0G+CeXCgfggowmhPq+YDIz3xT61ZIn5j4ze0uovVrhz6+3N9n0nwTaGqU8joFTxcu6iZAztqBpqE7J7PXrWSZI/zdlTUQyvpbrWTKdR4HSQ+2Tpw8eYZdIBVZ6h82mwRd2zPJZRStOozkT8Jmga31mPRqTOSN/QP8+oYrwmBEVRDkG+Reff8Ce5EEHhes2mb5q10xPWUq7rYGJ0yVV7J+7xtoFT0YLgjp73rUdkwpGsn592CalNS3skQUNJZtp4GKlUn8uFeig70TgGw4B1rqytDlQNlthqQEMSNoSgDEwoqC5VQSwQ7dPG91++/YNlO7c4FBAQf1PU/IGftwLhcofE3RfumSX+FLd50gE8+AAZHsIeKRgu4yiW6+veZhGTDbYbrmhtrIJ3kyJ6QXWNuJprMgLza5OyawHIqcHyvxpDyQoDWIm8O/ZUQj44adMsKUxeu1hdJ+mRL9LbldMMCKY5KnwmCS3QRgCS9WWWp+8YN1lt01mqewwKlXnlZnbYXKjuEn0bJBlI3sVaRyDBMkEhg/7Ij6457zHs4v+u+H7zJBikegoDFP4GOZ5U3Am0wSkN/OvJV+oWypYT1PY42sm1gG7PSmQPYqlAhC3e1+XdtjgNQlMC6341NGffYTFq+7ru5CKJSt/hX/x+QUPG4wHb5H+xXvYYktBY0UWQcw6SwF71yej/pgkTBgBh5t+t1zP8F2zoaFvYYeHWQ4HU6KovKkAxQPwTt23381bDRr4Xgt1D1MPgwlcxe1XgcEuaLqCuQ3OR3p3hKGGvpnhwDCb7M6iFq47w+EPYTg0+3qQpPIYeP0+g9WDyUcJ8+SexZ17D9OYRVxsxvOjcD22tQPC9t55ftuw/yK2pPONMiZxByifNKBst27pmg1j+LPJxPWb5PMnfd4M/9t9oqD3k1pVqd1apMC0Xx8++FtsiOZScy26c3w9xknhgr1C+Q7a4nUcsamGxgcT+P5qzHI4YQB2gYRt+rXFhy/fCZ4mDWyPwJ4+ocQ950tJltDMmjX0xEjIl/I5mbH1l5zGNJErrppo9pXtkjXds1l6yzTwWU/a10/2f7kFF0u2fQmqMdFbeFhZQWNi6JLPhXearpm9iGXxWvYyXfAnmioeURV4ndJYHb7QL3Qy5eKEmHeN49S2VlDyVIi1WURju/I8LNvBveezJOSbMvYIEhYGMciKfXqo2gHU7S37dPLhstUGpL7tBzYqQvcumQ0Hr2eGHEnSGK91RZqoAPYDjzs+i2BWRdQvu2QGQ+Ttyq2mCVf5y+RFyG8ZHDep9PaMgvhYyT8OYjSsodxHBwPYZMzfdz8V0bujhzS2vEOHXCbpwdzw3eRjYZURM8xlP1V86tFwl0QsWxF22uwy0iWhMQE7AezsDrtLaOzj6H4gb+6bFXnPFT6g+juja+COYx4UdMqH2DMGPIpoRzJwIASEFxo/G4Bgt6y8L3FL62VDhDZV0Ga5ue+ovBlOL6/fjuC42H9eTy4+vLsYTqejq2GrjYfpetCf9Aejy39ff5hcjsaj/xue2SeTi9FgWPd86+Sdgf9jBCecrPit4SLaaCLL5wvtp1SIDeGpQoaS6ZslIVxH8Qz5S35w807hr9m9NOu25eOrv2ZElzutWKXPlUrFI9Ifj8joDKaRSq3jauEFDK/CSdCBag7KB/LW8yBO7zqvQdPuAOePgi9w1GB8reNEjClZ2qKWV/+3xHGtF41xnhktCAeDP/Pb2CoEVq5AKAu+Zj5ZMyELflP9iH7hcWV46LbonZibngIJM/Q1qk68Jkt0NRnA2kB/MVPmGhQ7kOk8Zuohp+XcnA4Yw/SGiq7kMG1c+pz2heARYdRbEa5WTKCHGiwBMvOYaS4mmZeKQG0QbT0GabZDA8RGZ0ihz8BWAeosw7cWgWC3oL+KFJ0Q8OKEx0rwEGdhvwRcdBEl6GIReBpeyLsx2Dz3f4e30zv8COdoojWW0oQHhn0v5F2zq7lKPwVGmCtcC3l37FXSPd3L4At8LfLujTXdJlyyD/EZC5n1JGx6o+NDGw1vCobVFYtrcU4gTQO985n3+le2mdAmF7Dw9W4YOJQFIr8u9cA2kXHu2zepd/M4J4HmCH36M5nrfs14gdEXd0lwNpdvQu7dHPvpclt89VNp9Hw/PLhfrBvAsC19yYv1Kw2z5oE/YcJjsaLLB91iWlmbiMBjuKhlGdEmVBIKxkUzmGWmuRTSTbWxhKqyxO5WASPa82OOYkHLDeaTNFZBqPl+KgRsQgmtdMeBJHMGIBq9IrUAYD5CzgJZRdH56uXL/9LqK1tI7Rp+yHHRVw2SxOyWDN9Ot+APWzTyhB9aD/ZKH2R0ZrtpyM2qHRTYGey7ghKf2/0PtyY8+i0EMe8UqOpHQZOlMxADttR3IGsLhL/hXB3LB6CtBtfIBoDkrP92gSswTzY1PBicVdYwrS0SbilgPorkYTcIU8A3PlNgu6SfgDdxbjad9ZjyesyT8F9X9z3TuyqINVKwXiboYEL6oWJC+2oEUr8Y0Q0IkDTEbUdJRMNFGqObG7xYVvNrVAy0kuQTKE2w8oHprexShGtdj0c9jdyGg2lPQ7yez9YsBLVZGymYJzvYqdH5uysVhcZeQoX1h2h+Ji7SeNuACQ5+b3VvBfuShG3l3W/WQnheYoS5xgYrF3Gfhd2s80Aih6xqY8AGoCNEDXnnRrSK6O+/HHzo+xfjv/9CXrwTdB0oHhfPRmE+mqx21WTY1tTU64jH3D6O9t48ll1LcKtlPiXa+uRfWIRziBk+RxKTgjHG3GJXY+0sgrJX0vNNaevnzqEn2zZpcyOe35KBH0MpIqLgyvAOfydo5TzQm+E/ftXvbvae/83efTe7z8S67q7x3DXeM7zGSwSHndoEe5eEjmlnVZam/lylPoxjV8FxC1Q2QUPruvWFxw12eqlPaIKgyEiL3WN06OykbCj09QJlTjKLQEilezS9YYTnnIGHd4hGaWMtQ6DX9zxQv4YRDcIGDv26ERglUGlj0AyhDbjsaFOFFmolk+xBsGlMwfhqUJNdgvhVB/rwqfDRR660BNQuQsXZq2jxbGwWHp1Zk4C25KK5zzp5mxQC8bKIhEHKGD8i5hOrqGUqztW4Sz5/nKexSsn55TQ/DMjMuxotoVpgGAeekh6OLntcdkwChJ9S7OM6VPKEmO2TpPMQAo3xXfRszjTGLuA3uKXpMH2Ei4ocJZ/PGEvIOaMCJ3c1vocun7GkE5pXO+uoSOBPECx0bSzT8gRjh8zKIcoffDzrV1YokCS71KRhuMliQ7vkg7Vjt8kUuUSH38L9lad1SDNP60RJ1zQIkemg/rZIMfBUsJBRyR6sRpT38ONckc05V2eBRDPdu6PceqCl3aDzTFm3e81GLw3jZRDnzgpdMkv87ADNsoMBpwgCvcGgXTpHf3tJ3r2xBsHiMfoTlRLNKo9VSoqR2EX3avj5aagkxzsi7kf1Dio6qPg8oeI+Re5geKI5xtVYG0gtPpka3np99lper382UHAXwMRHmsU1dA3To9pGBc+wq7F1B8P72Ua3uoFQKQ3tlW7eq4HFMp1nrzcybyNtxVa2p4jGdMn8EeZBUZsmnUF4YodKGSxB7psOTCYVtdmitTLCIAxY3EgvGFd79rCptdNXEvkYP75PtflrdoVv8iXpxzTcqMCTJEt9Y0eIeBzo/BS290s4FM0uco1NXWWcExBQaUBttaSKDnhoYreHsY+XLPu7P6OKEi9rSJhpqd0jrAdiufeLNGy0LNW+4dbcrknIl0TwVNlFeQDaKMulG1bjWbNb1hStsmOadIexEpvrKT7s6v9db9/jPgy1WDftqjG1mBVm25j67tdhdtFxQKy86eTXdI7uE0ByCYg8QxDkbLbPwWYLVgvWYKeVdrb2xUlCGjPy8eI8E9qWwA1PRQeSM0HEIWi8RnxLGQ6YaJLnYHpOPDgV6MuFMK8gQJiNKooNy8vyFBapLMTaA0NHWXHQPLNWyEqzNEd5+FcBIBk9b1aEtNOSQeigoWXFLFRwprPbqGOC2cE3w3gPb8Vbl6gC1P24JJkvYEG4ZZuwec053160LCOfeTkR2r1z+4q3mV/3zT/kT2bgTqEvs990SMEgpEHUDAdMwO4iIbnEFerq2FQDArxEpxKOo/be1J3v2BxtYs6EAgfojmk0Mz6P6FVDZheM+p9EoNiYxpuZNfdFNoGDGQG9QJpF5I215wfE5RmTRpJNyFofPJzSjtkUd08vI1qzRH8AuocG15VV4z7x9EOS8DDwNobvwa244W+I+nLfWx5fyxTni4L0lm7gHzEDZvTbdrq5uw407KwpptqQTXowInmS0T1ByuxRmHB/mjDvge4WCfezgOAdoWDW4Mp9NkURzcVM++OC52IcqM0MkwgqiNVURa9Y0L4DnxhKyb/743NIg2rywUlFBVpOkfvNwPPpdFa0RD/ODOtcAC0vSLj/Z8zPWVaeuGXle4WANgqo/g/FgG6HgD6LK/DKdzfwMYd2JWXrT0/j4ky8jhHdx4gaGDOb3mlfrsrGA3Pl3IHIig5eH+vcCvi0GRitdolza2Ie3mu8/mZyktfc8RQprHVD28qoYywnNqZJQ4O/uNkjMw4d5leQsf0Xer1OkP/rmWOWr91eDPexIvBmb3A6PspqfOUj3YFWnJTRK7kU9FQe0EvSSdGC1nz99EoNJh8LWYvR6IweCke4M9QSWevk8Iv5Do/k6iLl6oyyqFGgjbmdgWAXH9uYMOB5ulxm8V9yNYrKsRo7E2pa12LtFWDjaHTX2pAMXY+5f5TH+hk0JiE4UJMXLzs/6z2uBE8hJ+yK88ya7PFk8wCioTng+zxvdCrZRARrqlhfJzlseCgS3aiQHZFBnuxwQ17EnLA7iGmjIRlNjNErpHMWHnCnvjfiaFekqh4ow2nwD30EsjirrjO0/hiGVqfzPFmdp92KF/IS0pg12KLv306J1oqIwiY68+iKQvoHa2UzfTaM74Iuo9yytx3S5fSQJ66HOFeTOtrkgbcVUwz+3GAkeZ1bbZY5GULeQXzEdT5+1mVPcStcipkNBfN4FOnQOTjYieB+ai/1s12dZb5Gh5AGHiSTQeY9kh0mHcTfrINp9q6+rCj4Pl9NBkVRkIVcsQjYYYPTapcVkYXJQ71Iw3DT+SOloY62FWzBBIttiPDnq3HBddiM1NhR1zTs2IbypI0TgoQYGKtoH5z2ejO4QVoEd+3iHdleFvAvPpc/wkI0ZFY7XCXyIj2n5fy5T8K985GSCeyC9jszCtyXF+iIhLc69ejrGu22muL2MLe77VSutl/1cxdq+6TRdw0LAONW01Qx25lcLCGfjVd7BHdLOtdpfzw6OkMY/vyT8YHr6ADjjrFOdHBqHRoFJ7m/N5pksHsYV+dfnzOdeQBxNVC/z/zj1L/nr/49E0XIaRpO03iGmsZ3Sin6kGgpKrxVoJj2hShkYNhKFgesayvZ+YOjq3b2fHS+p3KNnB2RjQ/MtlICNfPSrYZNtlJBNDowa7ZMfp5VwrPA2djAjBK8mggOW7EvGl4KzkblhjPM025H0DlbilCMQwVmoIPq/PO3K9j4xsnIRJhlaY5sWJ8O4cuShmBGvYv32nWGxTxdrqr530UaF7TMJohN65jWtTzPVBJSjyGDfSGDGC5MdJfWv/SRcshNa3LHFTPDWfW3kE7sycbWVWqTFrSvKTxxRdyeNIp1RdyUK+Lmiri5Im7Vg+KKuD2uBdApq09aWdVF3Eo13k9dqJ0zAT5VE6ALtXOhdi7UzoXauVA7F2rnQu0chHahds7t9NFC7Vo0VDQQtapSHx+RyZupsxw/aeXHWY6d5dhZjp3l2FmOneXYwd59luNQLmrh0OjNmJxP3zos5LCQw0IOCzks5LCQw0K7sVAaB+otF+dBFKh6R72ECW3swXdqFlC/c0nlzQVDM0b9Ow51PQPUpesCbCWJ0Tmt8Wd3T/8DwLMnfE/fOEjPpJBfFksLQUReKmd5zocJ5w3qAOmsIAnn4R7LOhR6gS4r2V12Fw+2ftDbV4nlepxFUAnXoiQ/hd1S/cJyqRlbDFcvRiW5CfFTmG3txRY2NDeV9zOAdXRgIQEMSiw62Oeru30lViTctC3K6bwOwS9Yh0DLh2hQudQ/4kLlapxxgSJ9n6DuNqyx9GgIixdIYgoOtTUrF/CFJUSZY+NoC2RBz4pD4IC3MlenPETAtRT8VpflrBQM8mioYz5e6sLfaZxFdMKbU3jePJIEmnQs/XY/FybZOrJi+ZkuVP7GSBG9qXBySPSuO9RKxfIsUOeCLUf+w2KDbcgPcAGpRKmeQqUaaf8L0l0pSqr4DYvPrCzcu8ftm1blmfanBLsoBh9YzlGqef3aOBfolYAA+A/xIPMX2OYO/dIG8YsrjyBec/E/2eMAbjarHgeaVOCRWzPcB5d2Txk2Wc2c66PJHI590jjWBUkeV/nnSVyqH1ThJk5DLIenkVRdcJ8ubkjJ563COrr8zXGZCHIVKstFYPs9IVQp6q3yyu1FAANcr51Bn2w9t3w6eakVVh/PMlM1ClDDeViiawPVdFji4Gm4ZjdO8qozemX2UYP+9f7NKkWSPH2HJJ+hHqAgUrGE/EJWTDTe0qU9od/qmN9+0tK+A4lJir93CqJnf9rRR8iAbNxeoQbRBQNDdMBjI4oPsKMBehaQc4SCJRrSQaIlzYA2I3Zf/4P4dIMgVR+KzC3U41L1UpklVtuf1NdJ6CctoZuwKHZTHzfSx6QuZPjr1NV5ckatH8ao5YJPXPCJCz5xwScu+MQFn7jgE4fSXfCJCz5xdZ5cnacfgxE9Yp2n3LbXOqaeEzQv2h5sTac99ZqaFH06pqZTuqw3336MgzUl4Ihm06I7b+mnbLlw3tLOW9p5Sztvaect/Z2RqIOKTxoqgg8ztOcxq1z5AHB7c4T7sjG47XZh3HLXBBYpdtZQ2Hpdm/se4sY2fDM1RkN9u4rGxReaW4F9ECROD4yNp73MSQT/Nub+v+x1faGMxi3cvBc8UzFf8pxlbnO7imocJjaKm0TPBjk2cldrPszkhQ/7Ij6457zHs4v+u+H7vDqRAWmjMEzhY5jnTbFZ5r5wLflC3VLBeprCHl+DHZDdnhTIHj2w2Egd/dlHWLzqvr4Lwdei/BX+xecXPGwwHryFCbAVJ0tBY0UWUMFjKXSJkFF/XE2HvVusZ/Cu2dDQt7DD6+ItU6KovKngxAPgTt2332v++l4LdQ9PD4NmtxfwVua9BOWEzkd6d4ShRr6B9eU1zOaBnizuBvs53GB/L2PyvXv6P2tLbm8bkx2efNJ40vkS7/AlXscRMz6nBxP4/mqcV/vOb7QzErbp1waf71Pk5Vlc99jdMo1pIldcNVHsK9sla7pns/SWaeCznrSvn+z/cgcHsBkLQ5d8LrxzdFU47YmdRUx1SmN1+EK/0MmUixMbXcVkhnHKWkHRpg0SFKwiGtuV52HZjikYn4R8U8YexiNI7o+iUzuAunXUmE4+XLbagNSBp1UwbRG6d8lsOHg9M+RIksbovivSRGEJRB53fBbBrEqlirpkBkPk7cqtpglXxRqHIbjToGev8doP4mMl/ziI0a6Gcj8rkQO++jtDxqw97+ghjSnv0CEfXLZJY4a57O8J2itbEXaa7DLSJVQUAjsBhvaxuwSiImF0rK90z6zIe67wAdXfGZ08dhzzYgHL71GyE72xmE+2tFFTrQsQ2lRBm+XmvqPyZji9vH47guNi/3k9ufjw7mI4nY6uhq02HqbrQX/SH4wu/339YXI5Go/+b3hmn0wuRoNh3fOtk3fGwDMeTjhZ8VvDRbTRRG6XAvOoEBsC1WGBoRR98XIhXEfxDPlLfnDzTtG/516addvy8dVfs2klUOOW1LQYaNGzKEbeeh7E6V3nNWjaHeD8UfAFjhqMr3WciDETLGu3qOXV/y1xXFNPS+Pz7WqjWHtXgVAWfM18sgZnuzwI07qUl4aHbjViKI8oS+VS14nXZImgPrSpu2XqXEEtsFZWvushp+XcnA4Yw/SGiq7kMG1c+pz2heARYdRb6SLabWJUGWTmMVPGL+2Ran5Z0mRN7S8OxdngYhqqfeNbi0CwW9BfRYrBzMXqYDAL+yXgnosoAV5rnoYX8m7czE/27fQOP8I5mmiNpTThgWHfC3nX7Gau0k+BEeYK10LeHXuTdE/3UArPVMI7Ngo7kw4mQlZbWTPDKkRiN4jCPrqOYLmEYMa5H6HUs91uefG33VWed0lwKGAYcu/m6AqGmS2++qk0er4fHtwv1g1g2Ja+5MX6lYZZ88CfMOGxWNHlgy4xraxNRGBroZdkRBuckikYF81glpnmUkg31cYSWqk53a0CRrTnxxzFgpYbzCdprIJQ8/1UCPRohVa640CSOcPoyBUjWUFFhJwFskox9C9f/pfxTF3IAV4cHHJcbKqMmN2S4dvpFvxhC9lEFgzvAok30ZU+yOjMdtOQm1U7KLAz2HcFJT63+x9uTXj0WwgbaFmgqh8FTZbOQAzYUt+BrEetZPqmVLy0VHFTtgtcgXmyqeHhXvdvuKWA+UBUgaARwM68DGqmwHZJP0lY7Odm01mPKa/HPAn/dXXfM72rglgjhczVDfxLSD9UTGhXjUDqFyOKeTN0YXlCSUTDRRpjyA+8WFbza1QMtJLkEyhNsPKB6a3s6rLuEK7U08htOJj2NMTr+WzNQlCbtZGCebKDnRqdv7tSUWjsJVRYd4jmZ+IijWs8iHlM3ureCvYl43t/r3FER24XGWGuscHKQYRJ2M06DyRyyKo2BmwAOkLUkHf+8BLGharFBfCez0eT1a6aDHWCmh064jG3j6O9N49lz5JKipY/sYxscesfXEa27LugK9L+xaNUHwnI7TIA7ERz99lkjnA20Ne+ReV8l3tB8MBrdNuv+rkL8fMpRGBWKlyb4MBKw6IS2lhTRwfmhmr6thZtCfmsc0N0IogT0vfM/fHoaOss/pzlydDMvRNRoIh1cGodGgUn2YzJR8ls1ez+eKRd3+ZMoz6UykC9u3F2N87P5GbHXSG7K+RneIX8na5zHwJ4qfBWgWI6rrWAfrcM9cC6thzNHnz5s7Pno21t5fAEHbaOIukRNd0SqJmX1F6r6FYQzd9ekndvyGyZ/DyztrIgV1YNzCjBq4ngsBX7okmOJ9BqR+WGM/SRK6YULUMxTqiUQAfVvn+3K9j4xuMTyU/jzMTUtugDbVaZwoa3GRfvtU7GYp4uV1XfO5HGBaN/E8Q2xTet0SPXEkPqMWSwL2QQL+GQ4os2V8gj2e+nNXb7olXe3GUUTbl/orKlNaQHK1su85nLfNbYJuwynzkw+MiZz3JO9I5zYO3WaUDn8viL8yPrJLt/LDM7zbUz39oXeklOUN4V0hUXDDBwsyNoaE0w9/EJuC5qsAfQorDtAQFg5iyQeBf47ijf4cotAKKhkldBeUAvSSfFYO7m66dXajD5mH0c4wKFZpRm1qmxfjm3sm4RmX2F+FVHmsTqnV/Md0gEhy3YBNWUSDft7PWXlKszyqJGN9kGRAO49bGN8bObp8tl5mAhV6OofBm6M2DdKhPa9cTiZt21tl5D15XU/Y03wxk0JiHcUJAXLzs/6z2uBE/nIZMrzpWl2ePJ5gFEQ3PM3A7yyAY1T0Swpor1dRBxw0OR6EaF6GMmCaAq8iLmhN2B0wgNyWhiLC4hnbPwAHB3tCVYD5TZY+AfldoFR2QWcFa+p2jlc0mKnrBtM15IrZnsn8H7t1Oi0xgRpZUZjOxfUfCvlln6a+yzoQMFdBnlqfi2fSYc2n7SaNuZXutpkwemF52i6WuDrprl7KIsokGYZyYBn1IQH1paWhOKyUBk7w8Vt8KlGDosmMejSPumwMFOBPdTnTa2cAqzmx00PDVzvLVWquwwaVtZsw6m2bvamArWPQMGriaDoijIfBpYBOywwWm1y4rIwuR5WaRhuOn8kdJQu7MJtmCCxdYH7/PVuGC2NCPl+wPZb3eJ8BodZMxZwo3Tsw07tqE8aeOEwOMcnYHsg9NebwYpXxfBXbt4VbyXBUBdmh9hIRoyq0wbvl/DfxK+HQ5LP38sfZ8t5ZkgTgfpHKR7hpDukaxvTa+TSn1USmhum2i/8LjBTi/1CU2KYGv3GB1a9ZkzQDNLd7IIhFS6R9MbDZMVnTMsFYc2pRpYPARo2wC71CJiwAiQfGXXnfthfoMly2ydDfbVd3Ub1EWyMEwMbYwYuGWz9QFbpBjPUPBpBiljMsKAcm5c7jMIeTXuks8f52msUnJ+OW0M22B02eOy4zNFg1D+lGIf16GSJ8RsnySdh4GnKdWXcdntZhcuh8HlomMKchZd8in5fMZYQs4ZFTi5q/E9dPmMJZ3QvNpZR0UCf5pTya5NjKE8IfCnWTn0DRh8POtXViiQ1YKeCNGA5A82ItG6HXT4LbhcejoawMzTpsOiaxpgyTPtib9Ila5xGzIq2YP9Y8p7+HGCnR9+yQIt7QbN/U/sXqsoobl76yzxswM0y71L0ddDhyaWzpF2Wim7qzwTjwdX29spKE9EQXG1vV1tb1fb29X2bnJz7Gp7u9rerra3M//8COafZ2KcdbW9H1zbu6rWPYm7JVf/yTF9x/Qfm+kfbGfOtDT0VrZqc65mvUY1635NHB9pnN0wvM/q6gac59F9V2Pr64YOGI0SrQVCpTSPTCpAfuv6kb3eKOMM0lZsZXuqiKomnUHBoA6VMliCAXdLKlVpPUAYVq8LauWdjSIrlymysZifuLjBKspNRjjnS9KPabhRgSfRi0cXYDYjRDwOFBfWnTnky0s4FM1yq5k0NyrjnKCJlwbUuhJVdMDDUJeWHsY+5j1qoKVRRYmXNSTMtNSpEGwUabn3izRstCzVviGRnV2TkC+J4Gnm4/0As3FZLt2wmmSXu2VNUe0d06Q7jJXYXE/xYVf/73pbm36Y+XmfG8zozZicT9+6GnVP2qzsatQpV6PO1ahzNeqqB8XVqHtcbTmNA/WWi/MgClS9KTxhQgen4Ds1C6jfuaTy5oJhUEX9O05xftKKM1TDK2Y2CFMROZDlQJYDWQ5kOZDlQJYDWa4Q8I8BfX5N51jfAgxYTyOxk/N0/LE9HXWo+/4plna2TsuWhDRm5OPFeXaFYwnc8FR0bv4hO4A9wJHdXOZIGQ6YaAI/p+fEg1OxyG6ry7fXuuxrbAzg6O8OvxWpLEAg9CmCm4OD5pm1QmFnY4gL8K0gcIz79qzIrKYHhj8Xhq7GP9eEhHYMxoDiGaa825YYLFEF/PRxSTJfIMuMbcAhbF5zzrcXzZ7ngXk5ETrpynYO/maOEjf/kD+ZgTuFvsx+0x4Ng5AGUTMIPIFwCgmY/wpd8LGpxnXoUkElHEedKcskV6vfHG1iU25DhbqOaTQzzqeYwJzMLhj1P4lAsTGNNzMbxRNZXG1GwCwTzUomj/MsEwa1J9mEbFCBh1PaMZvi7ullRGuW6Bs/u21HwQn3iacfkgS98AzfA/T2J/sHTjK6c/9A7ZTtQzx444vC+noYCfeziu07avXaOCrusymKaC5mumAalJaKA7WZQecAToNYyW33ZEMp+Xd/fE6kEqlOHCsVFahhIPebQd7Q01LehceZYZ03reUFCff/jPk5zPykMbPLpfSEnScr393Axxza7XISNLUPf51mMOEAA7HTrpx25bQrp1057cppV067ctqV066cduW0K6dd/eja1ZPVblw41Y/AiBoEDh1eNROnrCFpM9CJ1Sg/TUu2B5zH3oCvJnFZcAO8I1qySOX9iTnf/Tp0ZhFnFnFmEWcWcWYRZxZxZhFnFnFmEWcWcdqIM4s4s4gzizizyLNiRI9oFgHbRtF4YDKRdiCCp4OpyI8ylxS7tKaS/ZaQveaUB5lKPsbBmhII3rA5ll2E4VM2X7gIQ+UiDF2EoYswdBGGLsLQ4cWmEYb9UNFAkMmbqcM/Dv84/OPwj8M/Dv84/OPwz4+Bf8aczh3yccjHIR+HfBzyccjHIR+HfJ458ql8HtvknENV4Yzhb4EiB3Uc1DlqjvezjcqJgF9BPLCasyvv8+fqOhb012dB3xv3HigSJweJxG6tc84xJX4qdXJsqW9zOpvW/6kcyqxe+LUtXG4qBDXytthBqSkHtH5N1qZEjQ9FKYN5iq5qeZUgQ/sB5YP2k28LDBlPj3xj4efJC176VLGBru9R980zaArvdQBYbn3ILaFlKskiDJWKRkmhUkibSKagkIie4InRuKT6mPiPSMM5lYqk2OUOMvRDv5YU+ch0SPASP4gMUx+1dq/dP6It3wresyqVZBHSZZMR9et1066Ot2XQ2fmmdfUeXAz7l6P371rtVv+qPzrvvzkfttqts+H50Pw8vLj4cDE8a7Vbo/dX/fPRWWt7zw7jdXeqqYQdXfVgFgIdk/WsjSpb57pcqlqzl8YawkCjYxK+KaxWRO/OWbwE3/xfXv7P36uO6wjNgoiKTYNvWZUOmoe22lZMZPpF7eJcl842FvSxcSH13o3mYanKUb1S+vdfWnt8KQVbB7LWTQ7d0VFfrCunpOv/LoLlRHBgfIeU/zVGlSnzBFMHNszqVx3VWpN8ye7qvUIx4uMej0KIUYnkzuaP4Jca0eB+t1UlNvW2Ivhc3opFdOdjwWQa1cEjoCwNw3MoQL6jAIVU6fwirSv+m3W8e4fB0wGPoqC2Itpx/t2H+6J/a7fAThEFX1DK7SCl+MolFUu2o2rH4eK3aOr4ZKKOtB3ygsmEx7L8yhmyyTnb+Sq8/MvLl62aevQ+AW4EH1NX6TZKCHicG1tk73epz7zeM/CvIgOzfPK3fVGvBYa6fdrsVIZCcLFF+c/blH9ImMG3MTehVsxv4dv/s/32WaqnwwgLGWpDZHgXSDTqgX6Hxj7Q+Awbg+puHo/mAJSNx+xfcW2Q73qpCNQGhfUbRgUT/RQk1effQIJGTK243zptLRmOigFmrZ4NZet9tf8a+d+M2tqy8aIS+0xF2DptWYxKk6CLeDQHqttKOD4hEyPJTD25/mSEMt0SPIUV07Mvkp0tAIzYMowKmQi+1Gqbf7y1p+b3W4WrFMQLjs1tVRRNBQy7j0AT6STNy6haePipy5MvTplFNAiRYSz4/8sfgOYLwXg4zqvuq5evuy8tO49onGvX2aHNwwqz5S9R+zXfeq0LpkTA1kwi8vGZokGYAaFKP4RKyb0AcWAWOrsM1iwms/yjz7r5dZ5idwq0jgA5NU79q9kxn1u2SavdOs2bt+xVCmxxuJyAV79+nVPJPorw2zf4+Y+UCb09/UAa9QptuvdMNKtaCQZxJgLPFL1cBLgFagnGgom50EfijBWihTvP6u8H0vLClG/1T4hlsESfzgZEWbwRb4rUFIk1Cwm2RxRTEKf92ZR/bPU9jyWq0HSL95QO+bvhJdzGlg9S5eAUUX2ZrK9f9RuX/IbF375lVCr4Gwj89u3/AzRCtqA= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the workflow launch associated with the given `workflow id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workflow-metrics.ParamsDetails.json b/platform-api-docs/docs/describe-workflow-metrics.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-metrics.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-workflow-metrics.RequestSchema.json b/platform-api-docs/docs/describe-workflow-metrics.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-metrics.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workflow-metrics.StatusCodes.json b/platform-api-docs/docs/describe-workflow-metrics.StatusCodes.json new file mode 100644 index 000000000..976819f75 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-metrics.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"metrics":{"type":"array","items":{"required":["process"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true},"process":{"maxLength":255,"type":"string"},"cpu":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"mem":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"vmem":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"time":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"reads":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"writes":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"cpuUsage":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"memUsage":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"timeUsage":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"}},"title":"WorkflowMetrics"}}},"title":"GetWorkflowMetricsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-workflow-metrics.api.mdx b/platform-api-docs/docs/describe-workflow-metrics.api.mdx index 0a653f2a0..b7c4726d0 100644 --- a/platform-api-docs/docs/describe-workflow-metrics.api.mdx +++ b/platform-api-docs/docs/describe-workflow-metrics.api.mdx @@ -5,9 +5,9 @@ description: "Get the execution metrics for the given Workflow ID" sidebar_label: "Get the execution metrics for the given Workflow ID" hide_title: true hide_table_of_contents: true -api: eJztWU1v2kAQ/SvWnloJQUKSSuXUpEmjqKkS5UM9RDkMZoBN7F2zuwYi5P/embUNNhBCeoUTeOftfL1Z2zxmwsHAis6TmGjz2o/0xIrnhtAJGnBSq6ue6IhztKGRXfxbQP6gMzK0oiESMBCjQ8MuZkLRBeFLV7S5IaSilQTckL73vKOEHdNi6S6w5E4NAtlD5WRfoiGowVEqDVJ4Z1JsCBsOMQbRmQn3lnCQfJPIskYtrk0gxEXgUYrmbW1kDwxUGiPVUo+9EksqhwNv6msTg8uXvh1T9GdO1SZaWbS8o31wwB/1eDe/aWuoyYtybIUkiWToG9x6sQyZrQbV3RcMHTfZMB1O5gHiovkLIBgDXKN0GPv1Re+eeHOI1pO62a/sbVNwQ6g0iqAbYU5M1phH4Nxgeo1qQFx32icnjWWqqAdJ+nGFEzCK8BtLXBkC6guoioWI7dYLoFGjT0bKLYGjwy1x7S1xR1smCNOtK7mGLkZrOuK9vG8cHW6wtTfYjt6zkdFJx3Mh7tDq1IR4Dg58JhjvWd851sd72neRdif5WbynfcdoNwg9u+d953ifGOJtT/zuEU+v8o8WBvt7/e5RTy92e+p3k3p+u9tzv4vcVwzLOmBWNV6iW7LfFfoY4wh4vE4hO4NewLIVWvcZqayqdMVo/WB+qHSVwI3FXxijzUrmR6uZ35RSaaC0CyCiuikfhlsMU3o7evPS6BmCQXOasjb29MyyYd0NtS1wQwxwSru8u0LoC2hevGUgx6iCuWh6dS74tLihZol2gL5Ollk7olUKsK3ZQorNWvFctrVoxqVmmxoaAzF0LrGdVgsS2QwjnfaaFkdUWFPqFfX03luC2wgcz3Lwk/HB6e2V4LLKqu+ZpLzh1drnPeeIpdbK110PopX8y6/ylLxMnO+mVH3ttxcEFVlw2I8S5HJliLYA83RB6KerXny1ZBowyTYO+2NhYF2DOpfHOWx+P2ke8FqirYvzG1ehRf8fn7U65q1yOHWtJAK64VEsn/Os4Hqh29PuTk14L+kmToaUHmNnsy5YfDRRlvFyLo7zEPSkZU2XJqkPkcWVROYH8iPpfG3Gr0hRltT5MUQpI/3MjMHIXFP+VC5f7orj/zXY+F/C2qTKR5J6q2ZTTbboZPZM6CH9vCVfnF8OOA1DTFxl68qNigubn8/LiwfCQv0ILI289742LeLNIx70KyrirszS8TUnmGX/AJClsj8= +api: eJztWU1v20gM/SsCT7vAwE6cdg86Nd10g6AtWqQtegh8oCXankSakWcoO4ag/15wJPkjdh13r/Ypscgh3+PjyMFLBYwTD/EDLKx7Gmd24WGowBbkkLU1dynEcEM+cXpEP9uUz8ROJx4UFOgwJyYnJSowmBPEq1J3KSjQBmIokKegIA2FCikMMXTlIs9Om0mkUzKsx5ocKHA0K7WjFGJ2JSnwyZRyhLgCXhbSpDkEda22+voCE1o3npXklns7h8TIlDk5nWz33umlDdMkhMbW5cjNo3/eQF0PBaovrPHk5cTg4kJ+bPf78hEUJNYwGZYoFkWmkzDg/qOXlGq3qR09UsIyZCdysG4a5O3w14noHApHzZSH5+vZPcjhhHwQ9XBdnR5DWIEpswxHGTXC1GrVQbDh8ycyE55CPHj7Vr2USkFSlK8zXKAz2kwOUtxZAsgJzUbElPlom8A4s8gCItdHJs4uj8wbHJl3dSRAfD6aySccUbZnIqHK74OzywOxwYHY1e9itQLWLHsB9+Rt6RK6QcaAhPKz6ien+vws+ynKzlq+i8+yn5jsjjD1Z91PTveF00xn4U9P+KQof3icnN/1pyd9TvlZ+tOUXv66O2t/itpvBF76gPVm8Jb4Rfy+9cckr1bwZp9D9h7TSGwr8vwnVtmm05WTD4v5qtPVJR4k/8E563aQX+0i/9JZpZGxHGGW2QWloZSnpHSal8EafU/oyF2X4o09DMU23C5zSxzxlCJ6pqQM5VqjLxpbFyITPScTrUzTuxuQ28JTKxbthAJPsVlj6HcGbL9aW7F1P1/Ztp7cvPNsS5dBDFPmwsf9Pha6l2S2THueZuSwp+2Oe/otRKKvGbLscvSv5EfXX+9AaHWsv4lIzcA3ua9mLh07r1U+j0ISqPaX/7pb8rjgME1txjYcbwVqUUjb1wAKXZ2Qb5NluzAJ27VNfpMy5aizYHuO7bt1QHwNcr7pc9m7vBj0LuRhYT3nzZurNaP/n6BbRFazYnrmfpGhNtIrgK5asdfGPSiIt5z3Tu+hgqn1LLlVNUJPP1xW1/K4ccdlC1LtxdRNIR5j5mkHyOpGvuad70X8RMsde36OWSmZYWnm6HRjKv8Rlr/u2/v/d3Twnwl7QXXfSWa5iWYTbDvJelgrmBKm5AK+JuE6SajgjaM7byohtrqgtx++gwLcvgMvdj5U3wurqpqM7/aJTF2vULJ8FoB1/QvBtLJk sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Get the execution metrics for the given Workflow ID id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workflow-progress.ParamsDetails.json b/platform-api-docs/docs/describe-workflow-progress.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-progress.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-workflow-progress.RequestSchema.json b/platform-api-docs/docs/describe-workflow-progress.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-progress.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workflow-progress.StatusCodes.json b/platform-api-docs/docs/describe-workflow-progress.StatusCodes.json new file mode 100644 index 000000000..d7b0f6de5 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-progress.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"}},"title":"GetProgressResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-workflow-progress.api.mdx b/platform-api-docs/docs/describe-workflow-progress.api.mdx index e78448390..3146499cb 100644 --- a/platform-api-docs/docs/describe-workflow-progress.api.mdx +++ b/platform-api-docs/docs/describe-workflow-progress.api.mdx @@ -5,9 +5,9 @@ description: "Retrieve the execution progress for the given Workflow ID" sidebar_label: "Retrieve the execution progress for the given Workflow ID" hide_title: true hide_table_of_contents: true -api: eJztWM1u4zYQfhWBpxZI43R3W6A+NXHSRdAuajjZ7iHIgZbGNhOJVEjKjmH43XeGFG3J1q4p9NbmZJqcb2Y4fxzNhlk+N2z4wFZKP89ytTLs8YypEjS3QsnbjA3ZNZhUiyl8qUnGWs01GMPOWMk1L8CCJh4bJvEPAgIvRJ8xIXGn5HaB68xxKokzbgZ+ibFayHkiMpBWzARoJNXwUgkNKN/qCs6YSRdQcDbcMLsuSYgHse32rCXXlDyFveCXCvS6U7IjTGRVgBZpW/aRLCEtzN3RTOmCW7/16weU/kiqmlJJA4YQ7y4u6Kct7+8/EZoq5CItnfKyzEXqLDx4MkSyORaqpk+QWjKyJn9Y4QWUwfonKVeH/sK9vVkfGJ8qbYFMlXIU7hZl9Zfi9epeoFXdilw94yJ3NGIulfYruRzZ17uVsCl5N0fkyBPT8hMUytme/txz80wHhducwMt+7QMJ+HONpeUOS38CtgSZkcvJ4jy7Wlswbo2B4FeVlP7cVNNCWH83U6UpQObWS5U3FV5pYcHzQTeeMHstPCYomgrE0QfVY7mHK8XR166LI65jIY44hFDkLWtXxVGHOIuj9sF0M5uJVIBM1w0Y5vi0jcKswN+ti+2+kIxbGGEAtq9dV6MGgOh+spRCCMq5sZ/LrB9oiWVV+OIQYQB4hbSySjfNy7XmlEUY5oXprJ0+uyMjoy4J0dSulPRx38TE6rKvI7GhFypGHH2jNMQBWqUlMsCb5TMOsi+l8fSjeA83ynYcYFe248n7qN94CiKDThl7nMZ4IMH20NNT9wh2D+gR7wj41DPk95DoqN9BRtifVEXdjnSbZ9IzQxDypW+SIOaf/nmCqNv+qUIu6Y4GPLTC5tBoQZ3ntu7NT7FTAjM+7rKOiul/o5eqr/zWVb11VW9d1fELVGfHce8U3zrR12epIfV60udsv2bqW/jY56YT36vh+h6HuMeok0OvpqyTQ782rZNF38atk0nfVq6TSa/m7psc/j/tXuMdH/s09c847SvL83F4zE9ye//ukJt7/K+55a2Dj2DD2aQe+uA5UXzoGvtc8SyhJgEMvXzR859mX1GgKD6H0y9pIOz8yAv632it9JHm7zsGVmEAmEhlE55jiwTesga/MjHp1m7edwVcg76sLAb9wyPNwtpsJu5pWkJiF5D4D1TiGUZYCfrAHc3FEmSymwfeXruOxi4UjR/n4G5LE8QhG4Sh1mCznzJuB+V+JGlAL8M8stI5YhbWlmY4GPBSnKe5qrJzAy94v3Oh2KHGd+4kGefcUoAkI6JPLse3jG4XLn9HvvJ2b5pgZ3qSyOo5Iv2fOiLc8Ys/Qug9rawzqpAz5eC1n2otSOwpBem6AsO8JqYg46kLsvblm1fGOBO5i/yZ+n1/0Hwc2c/nv/1yfuGyErvogrsYrees/8atrdvsDGbh1Q7KnAtJEp3mm9rl+9E0ooet0fLO6+iahev1H9hmM+UGPut8u6VtP/+lWMiE4VPXsM14buBIk116npoOd6r8DCjlYAC95HlFlC50llwLkt9Tlx8mdTH4MfnuuLxTqfDhItdNbZrK1qbcPiL1Al9j5EX6eYJL7IdL24AelS262C5PP97cIy1vZ8JB5DvunWqh3xzFvXoGib4LWlr6Twput18BGY9mTw== +api: eJztGMtu4zbwV4Q5tYAaZ7OLHnRq4qSLoF3USLLdQ+ADLY1tJhKpkCM7hqF/L4aUbDnWrin01uYkSpz3W7MFEgsLySOstXme53ptYRqDLtEIklrdZpDANdrUyBl+a0AmRi8MWgsxlMKIAgkN09iCEgVCsqN1m0EMUkECpaAlxJA5SiVThgRaepElI9UikhkqknOJBmIw+FJJgxkkZCqMwaZLLAQkW6BNyUw8EtR1fMDXliLFPeOXCs2ml7MDjFRVoJHpIe8jXlIRLtzVXJtCkP/06yeo6ymLakutLFrGuDg/58chv7/+gBhSrQgV8a0oy1ymzsKjJ8sg22OmevaEKbGRDfuDpGdQttY/Cbl+669k2zHrI4iZNoRsqlSkS38oqz+1aE4PskB/YlfPhcwdjFwobfxJrcb0er+WlLJ3cy2ysQfm4xcstLM9vzwI+8wXhft4hy/7sw8kFM8NLh93uPzS4paoMnY5W1xkVxtC685kpD9VSvl7W80KSV43W6UpYubOK513BV4bSejpTONTZm+YhwRFV4Aw+Fb0UOqtSmHwjevCgJtYCANuQyhQy8ZVYdBtnIVB+2C6mc9lKlGlmw6aqorZIdY814KcsmU1FCUThGOD4lDtphp1EBjuF+IUqmPIhaWvZTYMaYXGSl8cAgyAr5hWpE3XvMIYwVkkCQvbWzt9dgdGRlMSgqFdKRnivjsbKsu+joSGXlsxwuA7pSEM4aC0BAZ4t3yGoexLaTj8ONzDnbIdhrAr2+HgQ8TvtILAoNOWjtO4jkEhDZDTQw8Ido8wIN4V0peBIb9HCY76HcpYK1sVzTjSb567gRmikL4NTRKF9PfwPFFIt8NThV3SHw11DCQpx84I6jxXu56forVoJ8dT1lEx/W/MUo3K71PV+1T1PlUdd6AmO45np/DRif8+S4Opl5N/Z4cNU9/DD203vfiDBq4fUQhrRr0UBg1lvRSGjWm9JIYObr1Eho5yvUQGDXffpfD/Gfc6fXzi09S3cf6uSeSTtpmfpPbx4i011/yvBYmDi89I7d1ds/SBumaIT31rnyuRRTwkoKUh+5/uXFGgtWKBpztpC9j7k9fKf2OMNkeSf+xZWLULwEhpikSe6zV6y1pMKyNp4/Z9VygMmsuKlpA8TnkXdkjmzrWmFUa0xMj/oDLNdoUVzbVxVwu5QhXt9oG3126ioaXm9eMCnba8QUxg1C61Rtv9lrEelfuVpEWzaveRlckhgSVRaZPRSJTyLM11lZ1ZfEEjzqQ+2gzeu5tokgviAInGDB9dTm6BtWuVv2dfebt3TbAzPXNs94j8PnNAEDeH39vQe1qTM6pUc+3QGz81UjDbUwKyujJF2wBzkInUBdmh8l2VsRAyd5E/17/tL7rNET6cfTi/ODt3aaktFcIFabNo/Td+PVBnZzHCVxqVuZCKOTrRt43P97tpiCE52C3v3D6NYemG/UfYbmfC4leT1zV/9gtgDoZMWjFzE9tc5BaPJNnl56n1cK/Iz7g52kCvRF4xpIudlTCS+Q+U5ae7phr8HP1wX94rVPvnojZdabrCNqasp3UMSxQZGiefB7hMUyypg3pUt1ixXaJ+vnmAGMRhKrwJfUe9V6zt1kM86GdUdb2TkvidBazrfwD8gGZ0 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieve the execution progress for the given Workflow ID id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workflow-star.ParamsDetails.json b/platform-api-docs/docs/describe-workflow-star.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-star.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-workflow-star.RequestSchema.json b/platform-api-docs/docs/describe-workflow-star.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-star.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workflow-star.StatusCodes.json b/platform-api-docs/docs/describe-workflow-star.StatusCodes.json new file mode 100644 index 000000000..de1c78faf --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-star.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"}},"title":"CreateWorkflowStarResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/describe-workflow-star.api.mdx b/platform-api-docs/docs/describe-workflow-star.api.mdx index 064ed083b..9466f9ea4 100644 --- a/platform-api-docs/docs/describe-workflow-star.api.mdx +++ b/platform-api-docs/docs/describe-workflow-star.api.mdx @@ -5,9 +5,9 @@ description: "Confirms whether the given `workflowId` is starred." sidebar_label: "Check workflow star status" hide_title: true hide_table_of_contents: true -api: eJydVFFv0zAQ/iuWn0CqmgIDiTwxykATEkwbiIdp0lzn0nhLbM92Wqqo/507J1mateo0XtLG/u6+7+6+XMODWHqeXvO1cfd5adae30x4Bl46ZYMymqd8bnSuXOXZuoBQgGP4YEu1As1u+7Dz7JYpz3wQzkE25RNuLDhBGc4zzPElZlzAnw5/hUAEWeFEBQEcaWi4xhcED0kRokiCFaHgT3X1uZDVKb1kKgMdVK6AMjt4qBVK4WlwNUy4lwVUgqcNDxtLJG0Q324nI15vhYSB+KEGtznIHIFM1xU4Jcfce1xKB1jGq9y4SoT26MMJst+QVG+N9uAp4u1sRj9jvp/fMVQazKID3QprSyVjd5M7T5Bmn9Qs7kAGarKjWQTVEuw091AzeFChpKO5AxFG87rsdCKMgCezdweU9lNn2gQmSgzFGUT0yT76B2JyU+vsJeUNk73mFXgvlkCePV51Dzxa8plzZlwlXqI9C0MWXkJMS05MedK3MWmGhm4T39rag1v1nq5difgiBOvTJBFWTWVp6mzq4QFbNVVmz11X8YZdlCKQXdic8Oz04pyTWzzI2qmwuaKGtMV9BuHAndak7LE+Yuy9SO+LCMKT9s/X3oh36xCboHRuYnjXjE4F0T4nkMpVEnwHpkkKGSc5Ln63ZBymKuN3kJtPwwUKoc61PG+mH99PZ3RmjQ+ViEbovtV5AfKerYcVIBw9Qu2fym0Ga/3nKus6GuBvSGwpcDGgpFha0/lh2J8IT0f7K1oC51ZgCQRsmoXw8NuV2y0dtwuGjJIpLxYl+ToXpYcjVTyzfg7KvYfN3oZbibImZPTVSjhF/C/U8uqy+xxfs6P7+KCo7lDoza6aXbFdG7c3iC5AZJiL9LWAUynBhp3QvcVBhT1+wN/OfqHT/wGEKWrp +api: eJydVMtu2zAQ/BViTy0g2E4a9KBTUzctggJtkLToITAQWlpZTCRSWa7iGoL+vVhKiuzYcJBe/CCHO7PD4TbAeuUhvoW1o4escGsPiwhS9AmZio2zEMPc2cxQ6dU6R86RFOeoVuYJrbobjl2md8p45VkTYTqBCFyFpKXCZQoxfAkVl/inx9+wJoig0qRLZCTR0IDVJUIMY1GIwIiESnMOL3UNtZRnMnalTIqWTWZQKhM+1oYwhZipxgh8kmOpIW6AN5WQdIegbaMdXl/pBEfixxppc5A5AJWtSyST7HLvcRnLuApbmaNSc7f08QzadiFSfeWsRy8nTmcz+drl+/kdIkicZbQsu7qqCpMEd6f3XiDNPqlb3mPCYjLJXbDpCLbMPWQGsOFCluaEmnfu67rXCW0rwLPZhwNKh1tX1rHSReHWmEJAn+2jfzhWmatt+pb2xpu9hRK91yuUzB7vegAebfmCyO122UZQIudOIrzCUFaSGMN0sHHajIa2U9/F2iM9DZmuqYAYcubKx9OprswkKVydTjw+IumJcXvpugk76qrQLHFRc8Gr86tLkLR4TGoyvLkRQ7rmPqMmpPNalD33J4xDFuX/MoAg6n98HYJ4v+ZggrGZC8d7M3oVQvuaQGnXJOh7sNykTsJN7ja/3TKW2hThHWTu07jRRiDOdTwnk5PZ6WQmi5XzXOqQhP6xznNMHtR6nAGa5INr/1JvM2brP2dZbynjX55WhTZWJIXemj4Q4wCFCOKdARYysYggd54F2DRL7fE3FW0ry92EkaSkxutlIcHOdOHxSBevzJ+Dch9wszfinnRRCzIE60mTEf43anl33b/H9+roQD4oql/UdrOtZltsb2O7aCPIUadIQV8HOE8SrHjr6N7kkMaeX/C3i1/Qtv8Ad01rDg== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms whether the given `workflowId` is starred. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workflow-task.ParamsDetails.json b/platform-api-docs/docs/describe-workflow-task.ParamsDetails.json new file mode 100644 index 000000000..d3bbeebe2 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-task.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-workflow-task.RequestSchema.json b/platform-api-docs/docs/describe-workflow-task.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-task.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workflow-task.StatusCodes.json b/platform-api-docs/docs/describe-workflow-task.StatusCodes.json new file mode 100644 index 000000000..2513e1f58 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow-task.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"required":["status","taskId"],"type":"object","properties":{"hash":{"type":"string"},"name":{"type":"string"},"process":{"type":"string"},"tag":{"type":"string"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"module":{"type":"array","items":{"type":"string"}},"container":{"type":"string"},"attempt":{"type":"integer","format":"int32"},"script":{"type":"string"},"scratch":{"type":"string"},"workdir":{"type":"string"},"queue":{"type":"string"},"cpus":{"type":"integer","format":"int32"},"memory":{"type":"integer","format":"int64"},"disk":{"type":"integer","format":"int64"},"time":{"type":"integer","format":"int64"},"env":{"type":"string"},"executor":{"type":"string"},"machineType":{"type":"string"},"cloudZone":{"type":"string"},"priceModel":{"type":"string","enum":["standard","spot"],"x-enum-varnames":["standard","spot"],"title":"CloudPriceModel"},"cost":{"type":"number"},"errorAction":{"type":"string"},"exitStatus":{"type":"integer","format":"int32"},"duration":{"type":"integer","format":"int64"},"realtime":{"type":"integer","format":"int64"},"nativeId":{"type":"string"},"pcpu":{"type":"number","format":"double"},"pmem":{"type":"number","format":"double"},"rss":{"type":"integer","format":"int64"},"vmem":{"type":"integer","format":"int64"},"peakRss":{"type":"integer","format":"int64"},"peakVmem":{"type":"integer","format":"int64"},"rchar":{"type":"integer","format":"int64"},"wchar":{"type":"integer","format":"int64"},"syscr":{"type":"integer","format":"int64"},"syscw":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxt":{"type":"integer","format":"int64"},"invCtxt":{"type":"integer","format":"int64"},"exit":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64","nullable":true},"taskId":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["NEW","SUBMITTED","RUNNING","CACHED","COMPLETED","FAILED","ABORTED"],"title":"TaskStatus"},"dateCreated":{"type":"string","format":"date-time","nullable":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true}},"title":"Task"}},"title":"DescribeTaskResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-workflow-task.api.mdx b/platform-api-docs/docs/describe-workflow-task.api.mdx index 1d5e791a6..39b0b29ce 100644 --- a/platform-api-docs/docs/describe-workflow-task.api.mdx +++ b/platform-api-docs/docs/describe-workflow-task.api.mdx @@ -5,9 +5,9 @@ description: "Describe a task entity with the given ID" sidebar_label: "Describe a task entity with the given ID" hide_title: true hide_table_of_contents: true -api: eJylV99v2zYQ/lcEPm2AE2dtN6B+muOmnbE2CRJnBRbkgZbOFhNJVMiTHcPQ/747SrLlmonl7sky+fF4P7473q0FyrkVg3ux1OZpluilFQ89oXMwEpXOxpEYiE9gQ6Om8L2GTKR9Ej2RSyNTQDB8fi0y+kPgRg6d7AmV0UouMabvyEnJWSotNrICi0Zl80BFkKGaKTAENfBcKAN0N5oCesKGMaRSDNYCVzlfUh0SZdnb3Iuk1IE7We8gK1IwKjzyQpUhzB10pk0qsVr648OOCmy6zWUIWz2eCzArr/EO6NfmmNsfWHmb68yC5RPvzs74Z/e+q7/paKhJSoa8K/M8UaELcP/RMmS9f6mePkKIHGfDdEBVXcB+5t+ty+4pHBILS9A6CKTU20JiaWNPOHu1Jz0bdD4Ea717RGHvui2mqcL9rZYbI4lwgoouZTxKcwQ81GmeEP+7n0h1VCRtvDRGMj0UQuqzrazCJlVG0feZKJFO5niQK+/fOQMdJ/y+CinhQ39QmNeR8itABC/8EQvzwnbUK4VUU5p0ITylkqoI2AHq/N4NCtnCawW8QFig9hufyjCm0Ezcus8FiS6if3X2GqVVCN90BImPQUCloc6tLJKGKwqlOXJuvZzw5slCGk4X+woKFTLXxIiVuN7e5Thl2ywgYVNyC1trjDbDsCobXm8ovK2SvVtko6J6RzpGwYBMjghaRrIXXG297iUC7hvZTk1dTBOXlzkRsCPU2MOmV8otdoW+Bc1BPt10Fszof7oLN2EsTUfs8gisXVHNOAK77M6B6HyF0NUdS0PV85gDC52M8OVwzazQKlscgeYE6ZgaKuoik0heJIlk9rnepNw8sh09/2O27hWYy4vv9O/27vzbeDK5+ETfN3eXl+PLL/Q1Go7+ckujq2/XXy+q7c/D8Vf3MTy/uuGlVrHhFqsuEJz99PiNKJ4InhT1PpIecxNp8S6P/o+QcldB0V5omlveuKk7KQIw5IOvlzqXUcC9D1g8pqlqt0tUs62cw+E2qQF6G4PGgAuu2Xuav/d0gU1TH2QaA5lQ9036MNzSG0dZtHJ9/DlIA2ZYUAM9uH/gBnNXTOOwQAbMxIAbV1wFS4VxgDEEcyrJWTBmgtB0EGueIObgjOOmfCD6zYjQX2+HhbLPwvrritwlv2NgFs1sURh6I0WMmNtBvy9zdeqe1lMLz2TTqdJ7Lfat2wmuE4nMkMC9gsHweizYosbgW45P5eu22Rt3841NQ87/pw5EK9XH54Z7j0t0jlTZTLvjdWxqLfjaQwqyufRG2xrs2r7QEWvX+LbJxC2VuGyf6T+3G1zjyHPVPb+dfvz99My9G/Tqp9Lxsh5YjgjljvIb/yC8YD9PqD/lC5yi6zrM24mSTg92pkKs5sfBdlqIXUNyL9brqbRwZ5Ky5OVqemICUNPH+UxcmsnEwp4+mzw8NFt5FX+C1d74tpAJN7bC8YVaLVXVk6N0+eWmzvpfgzfnXa9SzYiQrdratJWtHcoT6E/p9Po8/BMK1cEsHwgZ0xPOAws5q9ochiHk2Dq2VyzZy5ty8eViQli5m4s/5J6T7lWJSOQQE/0EWVluNeT/rGBZ/gfMzb4c +api: eJylV91v2zgM/1cMPt0BbtN1wz346dKu2wW3dUU/bsAVfWBsNlFrS65EJw0C/+8HynY+FnVxdk9xJIr8kfxRIpfAOHGQ3MPc2OfH3MwdPMRgSrLIyuhRBgl8JJdaNabvrcgtumeIoUSLBTFZOb8EjQVBstIzyiAGpSGBEnkKMWReSylaIYFOV+TYKj2JVEaa1aMiCzFYeqmUpQwSthXF4NIpFQjJEnhRipHmENR1vLLL6J732BTcka4Ksio90KDSTBMv+mhsgdws/fFhC4K47kpMaY3jpSK7CDrvBcNoDrH+IOBdabQjJydOT07kZ9vet78hhtRoJs2yi2WZq9QnePDkRGS5a9SMnyhlybMVOrBqDEic5XcdsntwjFw5iLskPMR7lEzRTQPpjNtIBjZKa1JyLrjHOAmuu2pcKN7d2ghjhkxHrAry8oz2APHUFGVOHMD71onCZFW+KY/WotBDMRUh3+ombag02aCLyExFyXu58v7UO+g5EY5VapHTcFKE15kKA3ipqApnLC0r1xNXQYWxi16EjyFTDQF7iPq49xMlPQt6Qa+UVmzCzheYTpWmW78eCkFuquxfo9+itErpq8koDzGIdFW0taUztHKjuNKw1NbrkWwezdBKubg3pFixcA3OBcTV2pbnlNtkga6KMVnvrbXGDtPm2ghGQ/FNU+z9MptVzTvSMwuWMD8gaRpZzeS2DYY3LatdJzdL01Tj3NdlWVDRU9S6/a434GbbSn8mWhI+X/dWLNL/9Fdu0ynanrLzA2TdwqWHyM77cyA7WzD1DcfcKqZDDsxMfs6v++/MRlrp2QHSUiA9S0NlfXTGoKs8R2Gf703q1SPbM/I/VuvOBXN58R1iuLk7+zq6vb34CDFc311eji4/Qwznw/O//NL5t69XXy6a7U/D0Rf/MTz7di1LG5eNtFjtBSHVj0znlpApUKLBRzLgbo6O78rs/yiptwHC5kLX3MrGddtJQV2LyIdQL3WGWSS9Dzk+pKnabJcKcg4ntL9N6gSDjUHnwIXc2TvI3we6wK6pj7ThCPPczCnzqhyllVW88H38GaElO6x4Csn9gzSY22q6gEUYCRMjaVx5Ec0VTyOeUjRRM9LRSAhSEE+NTBAT8s5JU57AoBsRBsv1sFAPRNlg2ZC7lneM7KybLSqbQwJT5tIlgwGW6tg/rceOXsjisTI7LfaN34mucmRhSORfwWh4NQLxqHP4RvLTxHrT7VW4xWLXkMv/sReCuP341HHvac4+kEo/Gn+8zU2LQszuAyjuqpRcK+zbvtQTa9v5TZepQJX7an80f6435I4j6xo7747fnZwen/iHwzgu0BOznVgOyOUW+lWAmF55UOaotBjwSJdtntcjJcSQbI2F3AyQyXpcmPqO5B6WyzE6urN5XctyMz4JAzLlpKAzSB4xd7SDZ1WI+4arIPBnWuzMbzPMpbMFT5gZWtVcKAdh+e26Lfvfo58OvEFQ3YygF5toNsG2AZUR9JcwvT0Q/wKgNpn1Qx3DlDCTieV+2W4O05RK3ji2c1tKlFf3xeeLW4gBt4vxh+Lz2oOQlstG4tY8k67rNUL5LwDr+j/wS75B sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Describe a task entity with the given ID id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workflow.ParamsDetails.json b/platform-api-docs/docs/describe-workflow.ParamsDetails.json new file mode 100644 index 000000000..0a3f6a0b3 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Comma-separated list of attributes to retrieve. Returns an empty value for each attribute not specified.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","messages","minimal","pipelineVersion"],"x-enum-varnames":["optimized","labels","messages","minimal","pipelineVersion"],"title":"WorkflowQueryAttribute"}}}]} diff --git a/platform-api-docs/docs/describe-workflow.RequestSchema.json b/platform-api-docs/docs/describe-workflow.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workflow.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workflow.StatusCodes.json b/platform-api-docs/docs/describe-workflow.StatusCodes.json new file mode 100644 index 000000000..50cb3633f --- /dev/null +++ b/platform-api-docs/docs/describe-workflow.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"required":["commandLine","projectName","runName","sessionId","submit","userName","workDir"],"type":"object","properties":{"requiresAttention":{"type":"boolean"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"ownerId":{"type":"integer","format":"int64","readOnly":true},"repository":{"type":"string"},"id":{"maxLength":16,"type":"string"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"runName":{"maxLength":80,"type":"string"},"sessionId":{"maxLength":36,"type":"string"},"profile":{"maxLength":100,"type":"string"},"workDir":{"type":"string"},"commitId":{"maxLength":40,"type":"string"},"userName":{"maxLength":40,"type":"string"},"scriptId":{"maxLength":40,"type":"string"},"revision":{"maxLength":100,"type":"string"},"commandLine":{"maxLength":8096,"type":"string"},"projectName":{"maxLength":200,"type":"string"},"scriptName":{"maxLength":100,"type":"string"},"launchId":{"maxLength":22,"type":"string"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"maxLength":20,"type":"string"},"defaultBranch":{"maxLength":20,"type":"string"},"version":{"maxLength":20,"type":"string"},"homePage":{"maxLength":200,"type":"string"},"gitmodules":{"maxLength":150,"type":"string"},"description":{"maxLength":1024,"type":"string"},"name":{"maxLength":150,"type":"string"},"mainScript":{"maxLength":100,"type":"string"},"author":{"maxLength":150,"type":"string"},"icon":{"maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"maxLength":20,"type":"string"},"build":{"maxLength":10,"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"maxLength":50,"type":"string"},"cachedCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"ignoredCount":{"type":"integer","format":"int32"},"succeedCount":{"type":"integer","format":"int32"},"cachedCountFmt":{"type":"string"},"succeedCountFmt":{"type":"string"},"failedCountFmt":{"type":"string"},"ignoredCountFmt":{"type":"string"},"cachedPct":{"type":"number","format":"float"},"failedPct":{"type":"number","format":"float"},"succeedPct":{"type":"number","format":"float"},"ignoredPct":{"type":"number","format":"float"},"cachedDuration":{"type":"integer","format":"int64"},"failedDuration":{"type":"integer","format":"int64"},"succeedDuration":{"type":"integer","format":"int64"}},"title":"WfStats"},"fusion":{"type":"object","properties":{"enabled":{"type":"boolean"},"version":{"maxLength":20,"type":"string"}},"title":"WfFusionMeta"},"wave":{"type":"object","properties":{"enabled":{"type":"boolean"}},"title":"WfWaveMeta"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean","readOnly":true},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"},"logFile":{"maxLength":255,"type":"string"},"outFile":{"maxLength":255,"type":"string"},"operationId":{"maxLength":110,"type":"string"}},"title":"Workflow"},"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"},"platform":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"ComputePlatformDto"},"jobInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"operationId":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"exitCode":{"type":"integer","format":"int32"}},"title":"JobInfoDto"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"optimized":{"type":"boolean"},"messages":{"type":"array","items":{"type":"string"}}},"title":"DescribeWorkflowResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-workflow.api.mdx b/platform-api-docs/docs/describe-workflow.api.mdx index f0107a2e6..39bda149a 100644 --- a/platform-api-docs/docs/describe-workflow.api.mdx +++ b/platform-api-docs/docs/describe-workflow.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the workflow record associated with the g sidebar_label: "Describe workflow" hide_title: true hide_table_of_contents: true -api: eJztGl1z2zbyr3D41JtxbMdJOq2fzpbsjltb8fmjech4phC5khCTBAOAsn0e/ffbBUCJlEAJbO7uoc2TIHK/d7G7APc11myq4uPP8ZOQj5NMPKn4YS9OQSWSl5qLIj6Ob0BLDnNQkZ5BlIJmPFORmJi/NV4kIREyjZhSIuFMQxo9cT0zMFM+hyL6owa9SP/Yj/diUYJkxOIiRSZDw3IMnxwQApRMshw0SBLwNS7wDwKuqCAIJ/lKpmfxutA1nUih8MU04ikUmk84SASV8LXiEpCvlhXsxSqZQc7i49dYv5TExCLFi8Vei68qWQIrxl8rkC9ezgYwKqocJE/avDd48ULD1LyaCJkzbR/9+L7FnWmUaFxpUNuZD0SeszcKyHbkg4wrTa5a4UdaoK+sR/cj9G0lCxWxIoK81C/RnGUVRChJBCyZrfCiQuhIlZCQHin5D57LTKQo3IRlymdEJiUjCbmGXG0aFymggSj2BEqf838DGTZjY8hIyRyUYlOjb84LnrOMQoKXkPECfsegIIUxVp/fEJk3cybJVOqb6WmuM2gE0L/Izie1GdApiwcKIFWKQoFR6+jwkH7ajvj4G5JPBPq20PSWlWXGExPvB18UgbxuWkyMv0CiSS5Ju0Nzy6AOeVqvQvczkkdnF+klKmBxCHtEAYMSVoVboZTK7jJcV+OcE4NKgXTvifqQS6P7VjEca4XGoHi2OjiUsRAZsCJeIA/NdLXV37f3p1cXd3dnQ3x2cz8aXYx+wdXt/WBwdjY0T89PLi7NYnAyGpxd2vX96LfRx08jn5NuLU/kLp4KkJRRdu8vciNLPxbZi80DC3pQCsW1wJ21mQwwkg3dnD1fQjHFpHP89se9TShnZI8BlgKkuDnfYJCCM5jsAY5eLzNMi+EY9GeAumpIA5H24qLKcOuQkW2K3DBVxpS+L9P/LtE6attW/unQZ+VlWLeB3/lcgoE84dk63beHPsL1fvAFAO04rjd4vvfRWW6xAFibOcLoSphz5XbfTmWaKWLdqD93WGqZRdoIR14GVnIPuF+ejFVFMttQ9OjIK3sx4dNz9JsKryqLhWsclC+vsjTllLlYdt1IbS74LL87ePZsRnyNduQTUHp3vi6QBGWluqqs29GjawoTVmX6VDI0TwjCPJz2TORwjaUvyJ9TrnORVs7mTX9+8MvdKHpr/j9670EoPJHipZwzXtwa2kGBxSo9EzKIMk827fbhwwbgolFmJle180kF597dgdDDSeOKZxvVxQdIqRQrRl6G5v+WHqNadleovbukrQTVG+x87pDYeb7uDK+BE+wcIR2IqmhuFn8dfndEGBM8UvTD4NNCyH4oqkoS6IfS0MTp7qn2K6pdMA31ukCa+nTBWGmuk+ZbbKnGbeHRvUyvuAaDO0WC4Z3EwfBW+mFlD31BB6Bah55ITpNeWK1dcmt2BrGvVJtAxx6BgtqaZiPUaIiDs0BLhnPD+gpP26YpYXP4JjFatD8htZoySCnklT0ceaPOANxgY+xrUk0JoG7Ux9TT4Ln2oqu/olLV3XsVGmsC7Hh7Vkxds9PRq5y7RrCjN+lin/aLQXjm+nb9JLQt1eDBqsrBH0EmoJXyv8zE9Hyzt/VVNDwdVToctnk/065LnsLUjK/6uGr9PZVt0Xcccq8bGM3DLhtjAJojvU0ktCirS8Hc6s4eMXBFR3ybN+JlljK3JvOBfr594jqh6yJMS+nAAtPyCnJh7lPozx1Tj/bOgB7ewNfVWtHzEtijw6XlEpf+1LglFKktyrQJTl/s1Y29eVH2gF7Y9/a8aHVzqcus5yJrCvwkseW1dHYe1WvmofmyFiAMvha9VzYOpu5cFwbsYiEMuA6hQC2dq8Kg6zgLg7bBdDaZ8IRDkTRvG7ZV0LLqi9L/6P+njvbtKheUHiGptJA9T3ZmdwdGhksJwdAmlfRx340KlWWVR0JDr84YYfCN1BCG0EotgQHeTJ9hKKtUGg4/CPdwI22HISzTdjh4H/EbpSAw6ETrNsFtY3PC1D3ktNA9gt0i9Ih3RLjqGfIrlOCoX6IMRIG9ULnWbbXMc9NzhyDKp76bBHF+779PEOui/1Yhl/ijwdNYGc/Z5oraQlDXm13WRjL9a/RSTuXvXdX3rup7V7VZgdzu8B6QAwsKHehLCYmVs74aD68vXfih5caL36vh2kYhrBh5KfRqyrwU+rVpXhJ9Gzcvkb6tnJdIr+auk8Lfp91r1PFru01tGafnQpsPUraYB90XtamZ4j9k9kKvzJgm8N1XLtyTiBqfaLpveAb2k8C14zTUgvC+iPFFMRE9+W4z8doV1Iak+ZZry64xBHc3NzCjK/0s/atV0Kkr5DRszsDCjvxW3WsNFgUe92qMTppu6mX32fpbPdQRK5ioaI7I+wZjVVQy6bjq5GpoP4V2vn5Bnjzpen2BwspSZMx/Jf3nincjBi7JssOxiQETofWokZfXcuioxy1Hg9n6UNyNGzsiKAR77xs8OmVpRL0+fazsMYHUPB7U22pnQ9y9/xpKnNnvB2uSv9uU/GO9282sGctQYbAJUkFSYe18MXOAp8AkyJOKbqI/P9A0Vg56JmiIcApGRpoHPI4P6hvlg9fVzOCCTgMg5/VQYSUzBJ1pXarjgwNW8v0kE1W6r+ArCrPPRbw+YXdr3kR17osGBB+dXF/EJEot6S0Z1hqpKe/STsQxdjNzJmYMED6xi/M6CL88aWMBXidWZ1QnBbHdJSCpy7G0OGDzocR+s2sr31QZg4JnZp9PxD9XL5oNafx2/+cP+4em4uDJNWcmoNy4Yh24y/HQdSlfV5H5v5ovdZbW8KwPsCZysyGNyq8uRFZTrwh+3BgsfaAvUXQa/xy/vo6ZgnuZLRb02E5dUuSkXLmPbW7+sVO/HQOhXjkfAbmszZy6lBrHNBcazv7/OBK6RZXWAOtKkwf6I7kdCutl1R9uXMb6R7R11tcrU52Li5emNE2zu0hYPCD0DDt/+uyI8lmAEzx7l7qBupFbW2npl7O72E6oNKtEe8cb6l6xMAINxJ14hGKxWEqp6T8JuFj8Bw+imtY= +api: eJztGtty27j1Vzh4amcY23GSnVZPa8v2jru24vqyefB4ZiHySEJMAgwAynY1/PedA4ASKYISuGn70OZJFHnuODcAZ0U0nSsyeiQvQj7PMvGiyFNMUlCJZIVmgpMRuQUtGSxBRXoBUQqaskxFYmb+1niRhETINKJKiYRRDWn0wvTCwMzZEnj0ew16mf5+QGIiCpAUWVymZETODMspfHFAJCYFlTQHDRIFXBFOcyAjsqFCYsJQvoLqBdkWuqYTKS0Zn0csBa7ZjIEkMZHwrWQSUjLSsoSYqGQBOSWjFdFvBTKxSKSq4hZfVdAENoy/lSDfvJwNYMTLHCRL2rw7vBjXMDefZkLmVNtXP31scadaSzYtNajdzMciz+k7BWg7XIOMKY1LtcGPtIikW9GD6BZ0KbmKKI8gL/RbtKRZCdFMyAhostjgRVzoSBWQoB4prh+8FplIgYxmNFM+I1IpKUrINOSqa9yYAC9z9D1RaJazfwEaNqNTyFDJHJSic6NvzjjLaYYuwQrIGIffQCpU+Ckmr++QzLsllWgq9d30NNMZNBzon2jnk9oMpKqqJ3QgVQiuwKh1fHSEP+2F+PwriUkiuAau8Sstiowlxt8PvyoEWXUtJqZfIdEol8To0MwyqF0enzeu+0gSXGyeXjEOFgexJ+gwMZEld08KlLJRFhNVTnOGDEoF0n1H6mdMGt13iuFYqxONSjGrg0OZCpEB5aSKidJUlzvX++7h9Pry/v78jMTk9mEyuZz8QmJy9zAen5+fmbcXJ5dX5mF8MhmfX9nnh8mvk89fJr5FurM8q5iIFw4SM8r++MJlpOlnnr3ZPFDhi0IopoV88ySDmDBDN6evV8DnekFG73+Ku1DOyB4DrAVIqYZ3muXgDCYHgCciLzLQEI6Bf8YSMCEEIsWEl1lGp2hkmyI7psqo0g9F+u8lWntt28p/O/JZee3WbeAPviUppJixbJvu+yMf4ToefA6AEcd0h+dHH511iAXA2swRRlfCkikXfXuVaaaIbaP+vcdS6yzSRjj2MrCSe8D98mS05Mmio+jxsVd2PmPzC5aBCq8qVeUaB+XLqzRNGWYumt00UptzPsvvHl49wVjFJKeczUDp/fmaw6vGrFRXlW07enRNYUbLTJ9KypNFCMIynPZC5HBD52HrOWc6F2npbN5cz09+uRtFb2v9jz96ELjHU7yUc8r4naEd5Fi01AshgyizpGu3T586gFWjzMyu68VHFdzy7neEAYs0LVnWqS4+QEylStO8CM3/LT0mteyuUHujpK0E1ptSwz3L4SLfXgyvgROaLCAdi5I3g8Vfhz8cI8aMsmwYBptzIYehqDJJYBhKQxOnu6fab6j2wTTU6wNp6tMHY6W5SZpfeZlP28LPMkH1hmswuFMkGN5JHAxvpT8r7aYvaANU6zAQyWkyCKsVJXcmMpB9qdoEemIEOLY1zUao0RAHZ4GWDBeG9TVoapoSuoTvEqNF+wtdQk0ZpBTy2m6OvF5nAG6hEL4m1ZQA7EZ9TD0Nnmsv+vorLFX9vRfXlHHY8/Wcz12z09OrXLhGsKc36WOfDvNBeGX6bnsntCvVSFBlDn4PMg6tlP9jJuYX3d7WV9FiIkodDts8n2nXJU9hqrqbMtdOzmVb9D2b3JsGRnOzS6dCarOlt4kEH4rySlD3dG+3GElR4hbf5g2yzlLm1GQ51q93L0wneFyUCZqOLTA+XkMuzHkK/rmn6tmeGeDLW/i2eVb4vgD67HDxcY2Lf2rcAnhqizIGwembPbqxJy/KbtC5/W73i1Y3l7rM81JkTYFfJNNg6ezdqtfMQ/NlLUAYfC36oGwcTN0tXRiw84Uw4NqFArV0SxUGXftZGLR1pvPZjCUMeNI8bdhVQYtyKMrwrf+f2tq3q1xQeoSk1EIO3NmZ6A70DJcSgqFNKhmyfLcqVJZNHgl1vTpjhME3UkMYQiu1BDp4M32GoWxSaTj8OHyFG2k7DGGdtsPBh4jfKAWBTieUp3c2O0w9QE4LPcDZLcIAf+egrwe6/AYl2OvXKGPBVZkXW91Wyzy3AyOEg/4yNEg46N+GxwkHfTk8VHBJ/N7gaazMytnmCttCUDfdLquTTP83eimn8o+u6kdX9aOr6lYgFx3eDXJgQcENfSEhsXLWR+Ph9aUPP7TcePEHNVy7KIQVIy+FQU2Zl8KwNs1LYmjj5iUytJXzEhnU3PVS+P9p9xp1/MaGqS3j+F5ocyFli3nQeVGbmin+Z9Qe6BUZ1Qi+/8iFeRJR44qm/4RnbK8EbhynMy0Q76uYXvKZGMh3l4m3jqA6kuY7ji37xhDc2dzYjK4Ms/Q/rIJOXSHnYXMGFnbit2rcGiwK3O7VGL003dTL/r31965Qj6/ExMwReb9IUKKUSc9RJ1Nn9iq09/MbpzlL+j5fcg2yEBn1H0n/ueLd8IErtOzZ1PiA8dB61MjLaz10NOCUo8Fseyju1o0dIVQVk4++waNTmkbY6+Nl5YAJpOb2oA6rvQ1xf/w1lDi39wdbkn/oSv65jnYza0azTLyATZAKklIy/WbmAE+BSpAnJZ5EPz7hNFYOeiFwiHAORkacBxyRw/pE+XC1mRmszECUXNZDhaXMyIgstC7U6PCQFuwgyUSZHij4BpIeMNGZsLszX6I690VjhI9Obi4JilJLeoeGtUZqyru2E3KshwGNzxggEruHi9oJv75oYwFWJ1ZnVCcFst0nIKrLElAO2FyU2Du7tvJNlSGnLDNxPhM/bz40G1Ly/uD90fHBkSk5QumcGo9y84q1567nQ7fFXG1c8z81YOpMreFVHxYZZSYijc4r5yObsVcSk1FjsvQJr6JwO/5IVqspVfAgs6rC13bsEl0nZcrdtrkByF799kyEeuV8hrfO0KnLqYTgYGg4+//iTOgOVVoTrBtNnvCPZHYqbJBV/3LrUtZfo53Dvl6Z6mTM35rSNM3uPKF6wmtJoCneOz6uHMBJkkChG6id5NrKS7+c3xM7otIsE+2QN9S9Yq1WFuJePAOvqrWUGv+jgFX1B/H/mvs= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the workflow record associated with the given `workflow id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/describe-workspace.ParamsDetails.json b/platform-api-docs/docs/describe-workspace.ParamsDetails.json new file mode 100644 index 000000000..92b9288dd --- /dev/null +++ b/platform-api-docs/docs/describe-workspace.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/describe-workspace.RequestSchema.json b/platform-api-docs/docs/describe-workspace.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/describe-workspace.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/describe-workspace.StatusCodes.json b/platform-api-docs/docs/describe-workspace.StatusCodes.json new file mode 100644 index 000000000..d1c6f5092 --- /dev/null +++ b/platform-api-docs/docs/describe-workspace.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"description":"Workspace details including ID, name, full name, description, visibility, and timestamps.","required":["fullName","name","visibility"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true,"description":"Workspace numeric identifier."},"name":{"maxLength":40,"pattern":"^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$","type":"string","description":"Unique workspace name within the organization. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters."},"fullName":{"maxLength":100,"type":"string","description":"Full display name for the workspace. Maximum 100 characters."},"description":{"maxLength":1000,"type":"string","description":"Optional description of the workspace. Maximum 1000 characters."},"visibility":{"description":"Workspace visibility setting. Accepts `PRIVATE` (only participants can access) or `SHARED` (all organization members can view).","type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was last updated."}},"title":"Workspace"}},"title":"DescribeWorkspaceResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/describe-workspace.api.mdx b/platform-api-docs/docs/describe-workspace.api.mdx index e1f29ff58..a43461273 100644 --- a/platform-api-docs/docs/describe-workspace.api.mdx +++ b/platform-api-docs/docs/describe-workspace.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the workspace identified by the given `wo sidebar_label: "Describe workspace" hide_title: true hide_table_of_contents: true -api: eJy1Vm1v2zYQ/isEsQ8JoNhOmw2bgWFzm3QLuq1BXjpgbrbQ0tliIpEKSdlxNf333VEvlq0gaYv1QxyJuuM9d/fcS8GdWFg+nvKVNnc2EyFYfh3wCGxoZOakVnzMz8EZCUuwzMXAInBCJpbpuX9tFZmMQDk5lxCx2dp/W8glKHbTipxGNwMecJ2BEXT3aYS3H3tbM/izkUKJTBiRggND2Aqu8AUltVmgRsAlgcqEi/ku0ndmIZT86C9nKk/ByHCDy5BxA/e5NICWnckh4DaMIRV8XHC3zsiKVA4WYFB0rk0qXHX03REvy6CF0nHpSUCtU18BzTWp20wri0lDjRejEf3bichbVA013qIcfRVZlsjQB2h4a0mk6BvVs1sIHeXBUK6crAy0TvfNbPxs6CFVmOSRVAt2ehwwClvA5nmS1I8d9YAtpZUzmUi3DphQEXMyBetEmtntGE053fAHpSCoMhHwjS4R92kHZPQpkcWr0YqYJdBk5XNyWtbI0FAqHn4DtUBajI9GRGqHjKYb/p6Kg4+Tg78+fIiu934ad97+nR78g0c/do7294vD4OX35Te8dc9iPapFj2xXSt7n3YokIGwlXSyVr0fdKY8B+z23js2AvTg4GrEwxpILqeIChqE3zicC8I/0mUiyWDTudmVJKhSKEcUEmonXWQwKu4NhuYpQJNRIUjTjVoC9YKPqI9Wmcztah6PRc76+ISpF0maJWFd+Yha3GxJ6KB5kmqcM79u1vHXbrvFnrb/zDyLp0rjXELfs9wB0ePtENW2kmAXnEMuATcIQMmfZzdn56fvJ5ckN29MqWTNsmk6GMhMKP1JOBApau0+5uLn4dXJ+coyiAuPW5QFLIZ0hKK+xlLDaHzxCNMDcU/3VJvGkutDXnHRUKvz9xiMKsHDw2gD+douuvbCtOZI7oILvBfmy6QJshZTaGTYrgYir6304E2HdVRZ9TXNkguWVjQFNg9bzzejqnvYG23ndrVGK5I4e69evRMSo4SGUz2nc3R6JblixgOfbYSPYi1fXixNjtOkhf/nIpGmmOlMau0eS6BXiIXELYW480XGWvwJhwExyKrXpNQ0xHPSxpk1gAR4jzdExHyJJ7bDwM78cbtaTYdGZvSWn282yWRRyk6Bq7Fxmx8OhyOQgTHQeDSzcI7iB1L2sX/gv7CwRjjjCXpM8m5ydcoLWIL+gQFdB6+Jv40YWeT296X3mhfCkenjTsO925XxEpJprr14HuUZBZp8DSO5KjEMt7Ptu6Bmy7XzXZSSJTPx8m+ufNx+oC2HkKjuHgx++HYzoLNPWpcITrN52GiZvCmIXZrGh6v++LtYxdvDghtjucdlCkN7ZoibLlFZDi6LjZkXsrLN42t3WMKsxOkhKRTETFq5MUpZ0jEVniKP4uBRGVgsAkgqnDD0jQ+cisbvrQNfzvfO6DPfZJ2yij/pVHwq1pt1GJDm94eMdrNsNmPbQLwL13Db6BYi6oS2vUTwGgWPfB66SqMZVR7fXybaawC8nlygrtutrp5787Y/iwpR6iUt9B6osW5iO3glgWf4HGI99+A== +api: eJy1Vm1v2zYQ/ivEYR8SgLGdNBgGAUOXtukWbH1BmnbAXG85S2eLLUUqJBXX1fTfh6NkW7aDpC3WTxLJe3nu/WoIOPeQjGFh3UdfYkoeJhIy8qlTZVDWQAKXFJyiW/Ii5CQyCqi0F3YWj2tGoTIyQc0UZWK6jG9zdUtGXK9JLrLrAUiwJTlk2RcZJPAs6prSnysqkFCiw4ICOcZWg8GCIAHr5hcZSFAMqsSQwy7SV26ORn2OwoWpCnIq3eByrNzRTaUcZZAEV5EEn+ZUICQ1hGXJWpQJNCcHEmbWFRjaqx9PoWnkGkrPpHsBrY36DmgmzO5Lazx55jgZjfiz45HfQUJqTSAT+BXLUqs0Omj4wTNJva/UTj9QGjgOjmMVVKtgbfS+mo2dq/RQJtVVpsxcXDyTgt0mxazSuvvtsUtxq7yaKq3CUgo0mQiqIB+wKP22j8bAEl5yCGQbCQkbXk7c+w1Q2Zd4VoKptMapplVUviamTYcsqaHAT3+QmYccktMRJ3UI5FjC32M8+nx29Nf799nk4HHSO/07PvpncvD4597V4WF9LB/91PwAa/N8cMrM95LtrVE3Vb8iGYhYqJArE+vR9spjIF5UPogpiZOj05FIc3SYcsVJ4QO6EANBJov8AnWZ48rcPi1TpWgEpxgqI/JlmZPxwjpRmYycT60jL6YUFkSmxxo9tQ7ntreOR6OHbH3OqZQpX2pctnbOrNtuSAPxAj+poirE8Wi0q3lL2q7yB7W/ij+o+2m81xC39O8B6OXtPdW0oRKeQlBmPhBnaUpl8OL69eXFu7Or82txYI1eihJdUKkq0QQfY4JpSt4fciyu3/x2dnn+7FocoNZbeSAKKqbkWo5bRYvDwR2JRqYquP46lSChFRhrTgUuFXi3sYgdjIGeOsJA/aJbC1zXHNMdccHvOflq1QXEIiezM2wW6EXaio/u1OjD2zL7nupYhahaHQOeBmvLN6Orf7s32C67bg1Nw3Snd/XrJ5gJbnjkw9c07n6PLMh7nNPD7XBFuOevvhXnzlm3h/zRHZNmNdWFsUGg1nZBWRTlKa1cTPRxDU8IHbmzikttPOEhVlDILW8Cc4oYeY4mMLRu7od1nPnNcLOeDOve7G2Apbvb1aJQOQ0J5CGUPhkOsVSDVNsqG3i6IYcDZfei/ia+iNcaA+eIeMr04uz1BTC0FfI37OjWaX38a7+xRuimN5+nkQhk9/N8lX0fFiF6RJmZjeydkzsUrPYhgGyuSsl3xLHvpjFDto3vm0wFKh3n28z+snngLkTOt3qOB8ejk8GIL0vrQ4Exw7p1Z5XKm4rYxVlvcvV/3xc7Jwf6FIalRmUYZLS27rJlzLuhBwnJakfs7bMSkv66NpGQWx+Yqa6n6Omt003D1zcVOU7SiYRbdKrdAMY1ZMrzfwbJDLXf3Qf6lh9cdnV4KL5gFb3Tru4SzZKXG9QVn0DCR1quV2BeRL8J1EPr6Dcg6ru2mTQScsKMXHRcS9HOqx7vXivb6gK/nl+BBNwusJ2CitLvxFXXLcWV/UimadYwA58ZYNP8BwNYfh0= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the workspace identified by the given `workspaceId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/download-avatar.ParamsDetails.json b/platform-api-docs/docs/download-avatar.ParamsDetails.json new file mode 100644 index 000000000..5ce54d63f --- /dev/null +++ b/platform-api-docs/docs/download-avatar.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"avatarId","in":"path","description":"Avatar string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/download-avatar.RequestSchema.json b/platform-api-docs/docs/download-avatar.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/download-avatar.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/download-avatar.StatusCodes.json b/platform-api-docs/docs/download-avatar.StatusCodes.json new file mode 100644 index 000000000..ca45e3c2a --- /dev/null +++ b/platform-api-docs/docs/download-avatar.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not found element"}}} diff --git a/platform-api-docs/docs/download-avatar.api.mdx b/platform-api-docs/docs/download-avatar.api.mdx index 3924e69c9..e209c7535 100644 --- a/platform-api-docs/docs/download-avatar.api.mdx +++ b/platform-api-docs/docs/download-avatar.api.mdx @@ -5,9 +5,9 @@ description: "Download the avatar image" sidebar_label: "Download the avatar image" hide_title: true hide_table_of_contents: true -api: eJyVVE1v1DAQ/SuWTyBFuwXKgZzYQkEVElRtOVV7mE1mN24d27WdllWU/86M89FddiniFMd+M+/NzLNbGWETZH4r4REi+CCXmbQOPURlzUUpc/nZPhltoVwkgMykAw81RvQc10pDPwTr4ykik8rQv4NY0brEUHjlOBtt9jlEiF6ZjVAlmqjWCjmrx4dGeSTG6BvMZCgqrEHmrYxbxwR9kOy6JYODsyZg4PO3Jyf82Wf68Y1yFtZEouBTcE6rIlU1vwsMaf9Kkcm19TVQnFwpA35LpF2XydNjRGdQCtaOIf4P43O5t7LGEGCD3PpBiF3dYcH5nOdhRNVXOgKPNIVCVdS8de699VdDgybl7460aByzMDYK0No+kZ6EPj1EfyfM2jamFKix5ho5ccCi8SpukxPOEDz6RUODz2+XPKf9FKOTRKxQ9H4RquaCMiotVpbttsFUN7snl/PBlfN2tFcnmdQ/ju5rvCZcFaML+XwOTs0KbZtyFvCBqpspe+DB63QiLjVEHrP4xHixuLyQrHgs6Jon1Xd9t6yp8cwoB5fy/yqBaKdffBkNdPfUN0qZtU3hw5QGFUz7L4FcriowDGC2GBTJYvvF75ZMLlN8xrQfnw9ICHeu53kz+/B+dsJ7zoZYQ3LocJtfGtWe2qkhEX/FudNAl58yJmXtMMbnxyWT+fROULMr4uXjtl1BwJ9edx1v02Xy7ChaPoJXsOKO0axLFXhNLlmDDnigZLp88tXVcL1eixeenKPKh00wW8n0uuE/Wt7jdveV65aErRBKysTa+uNFUaCLO4EHjwB7bPL61/MbwsK+s/5wUsp+VBR1LSFu7D2arps0Rv5ngV33G7MQA1o= +api: eJyVVMFu2zAM/RWBpw0QkrTryaelWzcUA7ai7U5BDozNxGptSZXodoGhfx9oO26yZB12siVSfO+RT2qBcRMhWwA+I2OIsNTgPAVk4+x1ARl8di+2cljMuwTQ4DFgTUxBzrVgsSbIhvPXBWgwFjLwyCVoKCjmwXipBhn0NVTkYOxGmYIsm7UhqRroqTGBCsg4NKQh5iXVCFkLvPUC0B+ClJaSHL2zkaLEz2cz+Rwi/fgGGnJnmSxLFL2vTN6pmj5ESWn/CqFh7UKNDBmsjMWwhZRS0nBxCugSCyXcKfL/IL7KXUBNMeKGpPUDEbd6oFzq+SDDYNMr3SWeaIoGNlzJ1lUILtwODRqZfzjRot2YlXWssKrcCxXQZV8cZ393rNausYWiimrRKIUj5U0wvO2ccEkYKMwbLiFbLGVOhyV2TlJckur9okwtgjTUxKUTu22o0y3uyWA6uHLa7uyVQEDD8859Taggg5LZx2w6RW8meeWaYhLpiQJOjDvy4F0XUTcVsoxZfZJ8Nb+5BmG8E3Qnk+q7vi9rbLwgwuBSWa+6JNDDz5edgR5e+kYZu3bd8WFKAwuB/RdBkWtyikOyWAzzzmKH4vclU41GYgL78TWQNEjnepyzydnsfDKTTe8i19hZdLjOb83qgO7YEaZfPPUVGisVO2rtMMfX10VDNj4USw2liyzhtl1hpJ+hSkm2nxoKYqmlhmcMBlfSskULhYnyX0C2xirSEZPx9sG72+F+vVdvvDknmQ+baLcg8FUjK9DwSNv9Zy4tk4aSsKDQcevD8zwnz3sHj14BMdlo9q9X96ABD631h5W66idJtW2fce8eyaY0cmRZC8GUfgNZQgN/ sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Download the avatar image id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/download-data-link.ParamsDetails.json b/platform-api-docs/docs/download-data-link.ParamsDetails.json new file mode 100644 index 000000000..1118cd2d3 --- /dev/null +++ b/platform-api-docs/docs/download-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"filePath","in":"path","description":"Resource path of the file to download.","required":true,"schema":{"type":"string"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier.","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/download-data-link.RequestSchema.json b/platform-api-docs/docs/download-data-link.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/download-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/download-data-link.StatusCodes.json b/platform-api-docs/docs/download-data-link.StatusCodes.json new file mode 100644 index 000000000..b9d241c97 --- /dev/null +++ b/platform-api-docs/docs/download-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/download-data-link.api.mdx b/platform-api-docs/docs/download-data-link.api.mdx index 1da5d3554..5f7306252 100644 --- a/platform-api-docs/docs/download-data-link.api.mdx +++ b/platform-api-docs/docs/download-data-link.api.mdx @@ -5,9 +5,9 @@ description: "Downloads the content at the given `filePath` in the data-link ass sidebar_label: "Download data-link file at path" hide_title: true hide_table_of_contents: true -api: eJzNVt1u0zAUfhXLVyCVdsBAIlfsh6EJBNM2xMVUaW5y2nhN7cx2VqooEg/BE/IknOP8lmbttgvEbjrb3/H3nV8n507MLA+ueCSceJFINbd8POAR2NDI1EmteMCP9VIlWkSWuRhYqJUD5ZhwfjmTd6DY9VQmcCZcfM2k8vvNhUxYq0MpHERsKV3ctSLQZ8ScRtdDPuA6BSOI9DTq0B5XIASkwogFODCkOecKFwhsb0GIJMUpKuEbbjSKrDNSzZiM0A85lWAQa+A2kwaQ2JkMBtyGMSwED3LuVimxlEa8KAYNce30VtoTBDE6YU6zqPLpiYQh4kmzSGzr7G0GZrVBe9RCe/19CN1Sm7lNRQi7yL7XQKayBRgZ7uCSWEIzfzTVZiFcufV2H9nHFBmbamXBksWrvT36Wef7+glNq0KkU5GmiQx96YxuLEHyex3scE6kEuhNgX8Dvt9HdCiic8wTWPcYwja1V3wB1ooZUFdVOvTkBkK6LzVU8E6WjtbAvoxwJ11CWx+M0ea8ik8j/HVPhOpWYkpjryaJXqIej97fRH/R7kRnKmK/f/5iTdaZNqxTcf6mKcEG7ODslEXSikmCXY3x9E3dGA7Ish0AuPD139j/r7HEQwthZqRb+flyCMKAOciwq4OrMZUmDp9Y03CagWelhg/4qJ2eo7ydRsWo0+4WzF09tzKToFXsXGqD0UikchgmOouGFm4xa0OpNxrswp+ws0Q4ql52RHjKAidVtegLiloZga70JgjEWLcjrScehDvlPyd1X9wsnY+UVFPtzauIVSqIdpdAcleGYCswpVuEPt3rznddxozLxI+CqX7fHqAQilzJ83L47s1wj/ZSbd1C+GqpxlX9YHRKjyY0vVR9kzlvi/DfPXFVJhz8cKM0EThT0RUfkryqprW3eMCDtdetKSjMeowBIHieT4SFbyYpCtouJzSVWd2gPJhi+8IW93c9Fr2q57DqeZLuRJIRltM78nAFO16QLQLWH6mWfkwLI4n/kdF4dl7NnOds+zdDr6pqU6hVV06ttpPNxwWoI+q+L4onyGm+YIoxYmMQETpG0SqPD8IQUtcx3JjVa0Px44dLxIr1ofPXkPG394rCOvaISz0HhbVca3S0JoFF8QefbLM9 +api: eJzNVttuGzcQ/RVinlpgIzmp0Yd9inOFkSI1nBR9MAR4tDvS0lqRa3LWqrAg0I/oF/ZLgqH2pkq17DwUfbKXnOE5czujBhiXHtIbyJHxRanNysMsgZx85nTF2hpI4Z3dmNJi7hUXpDJrmAwr5Pi51A9k1O1Cl3SFXNwqbeJ5/6BC722mkSlXG83F2EuMftFmdZnfTiABW5FDAb3MR7DvWiNIoEKHa2JywrkBg2uCFIZXIAEtjCvkAg7C6Bl5dtoslc7JsF5ocgLu6L7WjnJI2dWUgM8KWiOkDfC2EpidF4SQ9Mhd1I/iXpO3tctIya2yi5gA8VRsVd4G+b0MMkcxCiz9EP59TW57wOPtYHo8A0/B21i38hVmdArt985QmXpNTmenwLRhWpKDBBbWrZF3Rz+fQwgzyY2vrPHkxePV2Zn82Qf89ZM823anXGNVlTqL/TS982LT/GuII9C5Nui2EEIICZwfQ3qDuZJakednQQ71vYE1eY9LkmFrmdj5HWUsTe5kDljvYu0Mj1UFWHMpR++ds+66TVFP/acjSeomTBnLCsvSbiifQDQ/PzT/bPmDrU2u/v7zL9WXXlmnRn0Xn1qIWaIuri5Vrj3OS8rVwrrY671jIp6DMFi3G4ne/3+bzZCAp6x2mrdReN4QOnIXNReQ3sykP9fEhRXVWlJEFSFIYTrI6rQZZCpMu7GfNp2EBJkJcg+dttWuhBQK5sqn0ylWepKVts4nnu7J4UTbg4n7Em/UVYkszazeir1UBIRgx/+LJHCXjHEUfT4EsRtP+Z5HI0jafz50Y3K34Zg0bRY2urfJa1kI7CmCEq7OyLfGUnnMYuX3gx+HTGvUZZSGhX09XIQEJHM7nJeTl2evJmdyWFnPa4yd0wpYt1VGfRi1GFkdU+9maMj/bg+2pWD6g6dVidpIKDEnTdtZews7gXRvBXbNJRf9hpolUFjP4to0c/T0mytDkOOdfkvPdZML6QJLT4+k4uQuORrCirZHVtYDlrXYgqyZp1M4tWAeYbC/xAb8mXw4LQSemY8frls1+lGd+JlxlFZ7iGY75tPRHRX3eSkasXryj5Dv4Nf3WJiFBArCnFzM3+76Isuo4pHjga7vCejH918hAdxXpX+oUHz9KKmm2Vl8tSsyIfQcWb6FYAjfAIVdybE= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Downloads the content at the given `filePath` in the data-link associated with t id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/download-dataset-v-2.ParamsDetails.json b/platform-api-docs/docs/download-dataset-v-2.ParamsDetails.json new file mode 100644 index 000000000..e271cdd8c --- /dev/null +++ b/platform-api-docs/docs/download-dataset-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Dataset version number.","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File name for the downloaded dataset content. Must match the original uploaded filename.","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/download-dataset-v-2.RequestSchema.json b/platform-api-docs/docs/download-dataset-v-2.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/download-dataset-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/download-dataset-v-2.StatusCodes.json b/platform-api-docs/docs/download-dataset-v-2.StatusCodes.json new file mode 100644 index 000000000..37a1b4e41 --- /dev/null +++ b/platform-api-docs/docs/download-dataset-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/download-dataset-v-2.api.mdx b/platform-api-docs/docs/download-dataset-v-2.api.mdx index 61d12c7fc..cbff5ddd5 100644 --- a/platform-api-docs/docs/download-dataset-v-2.api.mdx +++ b/platform-api-docs/docs/download-dataset-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Downloads the content of the dataset version identified by the giv sidebar_label: "Download dataset content" hide_title: true hide_table_of_contents: true -api: eJzNVdtOGzEQ/RXLT60UZSmllbpPhQIVqkpRoe0DihRnd5IYNvZie0Oj1f57Z7x27uWSqhJICNY+4zlnrjV3YmR5es1z4YQFZ3mvw3OwmZGlk1rxlB/re1VokVvmxsAyrRwox/TQfwYzNgVjEc5kjpdyKCFng5lHjOQUFOsH4FneZ0LlrB8M+l12haD+UBZwLibQZ5PKOjYRLht7c23kSCpRsKokEvguQRVCu7zDdQlGEM+zfInpcevr5z4iSmEQ69Abqqw5GSLyXptbW4oM0K7DJcm8q8DM+Lr4XxHIVDUBI7OFQkMEbDaGieBpzd2spJclhmcEBq+G2qCM9uj9AW+aztz9PBjReSnceMN3kMGsM1KN1hwbuKukAZTtTAVbiLRWK25DzJ/kNCYUZQ929xjT+qDLUwQxMmAYsraqQiIx27HAQt112dfn1MfTOfcIbEutLFi639/boz+rTL99wTcDE7oVZVnIzBdgcmMJUv/VxVJBDJAw1lqDPx1+sM3RkcgZcQfrnuNxIfeaT8BaMQLq50BED24go/dKQ33jZKs0ArclkjvpCjo6MUab7yFAc+Zvt4QodiRT2jFRFPoe+Xj0wSb6HDFDXan8parESwtZZaSb+flxBMKAOaywjNPrHlUNDpexpukzAu+VKjzlSZynST1v9iaZJnXoqyZRSR27o6FBAmYah1RlCnxi7Fxp0yQRpexmha7yroU7DG5X6o0WuvQ37KIQjqqMfSI8O7w440QxKrikELbhWNYxjwh5jDONvgcehCftP6exfm/unQ+bVEPtzUP4Agty+xhBkiszsAFMuReZz/2q+GXJmH5Z+Hk61B8XF0gkDraUv+l+eNfdo7NSWzcRvnTCMIrrYX2mrJOtF6X4opdfyJqD3y4pC4EDFmX78NWhDJfWeoeny1tnSgeLfUC/6XxYY8mMMXpkX9cDtPlhiqah43ZJUo3m0opBQU04FIWFB0L42ArdKuMWZhtreiqKipC+pqfCSCLwTDKvvofh8Zo9uF63kgqHQs2W2USyi/DSAvwnSpvLdwc+Mbs7s/mPe3kHOfPqbHqIHQO+aXzy2+vDLIPSLRlu7JCVYf355AqxYnX+rc07//pWUtgVHnGlb0E1zZyjo28i2DR/ABeL73g= +api: eJzNVd9v3DYM/lcEPq2AcU7TYA9+Wrq2Q1CsK9qsfQgOOJ5Nn5XYkiPJlx0M/e8DZdn3c2mTYkAfDj5LpPl95EeyB4crC9kNFOjQkrMwT6AgmxvZOqkVZPBGP6haY2GFq0jkWjlSTugyvEY3sSZjpVZCFqScLCUVYrkJFiu5JiUW0fCqWAhUhVhEh8VMXFckFqWs6QM2tBBNZ51o0OVVcNdGrqTCWnQtg6BCsKnChmaQgG7JIOO8KnaQvhlifTmHBFo02JAjwyx7YEfI4EGbO9tiTlcFJCCZ5n1HZgOH5L+OhkJ1DRmZbxkaBmDzihqErAe3afnLUjlakYEESm0adMPRrxfgfTKFn5IxBm/RVUexIw1hnZFqdRDY0H0nDRWQOdPRCSCD117YmPPvCjoWVHXN8vkRx7I+GvKdrEmwgyi1GVQVC0nFJLCou5n48yn6+H7Mcza2rVaWLN+fn53xYx/pX+8hgYiEb7Fta5kHAaa3lk36/wyxI4ilVGg24L33CVycCvQaC8HYybqnRNzSvYGGrMUVcT9HIHp5Szl/rzXcN04OTEfDU4UEJ13NR2+N0eZTTNCE/NWJFI0dKZR2AutaP1ABwfri2PqDdqLUnSp+VpY+AUt5Z6TbhPnxmtCQuexcBdnNnFXTkKs0T58Vhais8AzScZ6m/dTsPl2nfewrn6q0H7vD8yAhsx6HVGdqyKByrrVZmmIrZ3mtu2Jm6Z4MzqQ+aqHP4UZ8rNGxysTvbC8uP14BQxwZfOYUDunY5TFlhCOOM43fl8EIkvjn3ajf2wcX0iZVqYN7TF9EwWG/BZDpypxsNObaYx5qv09+lzI1KOswT0v92/bCJ9Ngy+Dl7OXZ+eyMD1ttXYNBO3EajfvhcKgcou23Wvypt18sm6N/XNrWKBXTDvnrow539noC2e7aWfPBdiHwL5um9TyBSlvH/n2/REt/m9p7Ph62JIu0kBaXNXdhibWlR1L4rR16ksYdbY729Brrji2DqNdoJAN4IphfPsXp8UI8ul9PgoqHqDa7aEaw2/TyBvwhSMfb9xl4xuo+G83/uJifQWdSp5/7BCrCgkwo/nB9mefUuh3HoyWyN63/eHsNCeD+ADwYeOHrJ0H1/WBxre9IeT9hdPzOAL3/Fx+o750= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Downloads the content of the dataset version identified by the given `datasetId` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/download-dataset.ParamsDetails.json b/platform-api-docs/docs/download-dataset.ParamsDetails.json new file mode 100644 index 000000000..b841a9610 --- /dev/null +++ b/platform-api-docs/docs/download-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Version number to download","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"path","description":"File name for the downloaded dataset content","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/download-dataset.RequestSchema.json b/platform-api-docs/docs/download-dataset.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/download-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/download-dataset.StatusCodes.json b/platform-api-docs/docs/download-dataset.StatusCodes.json new file mode 100644 index 000000000..37a1b4e41 --- /dev/null +++ b/platform-api-docs/docs/download-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/download-dataset.api.mdx b/platform-api-docs/docs/download-dataset.api.mdx index 090e58922..df4aa6938 100644 --- a/platform-api-docs/docs/download-dataset.api.mdx +++ b/platform-api-docs/docs/download-dataset.api.mdx @@ -5,9 +5,9 @@ description: "Downloads the content of the dataset identified by the given `data sidebar_label: "Download dataset content" hide_title: true hide_table_of_contents: true -api: eJzNVd9r2zAQ/leEnjYIcbd1g/lp7dqOMuhK220PIRDFPidqHcmV5GTB+H/vnSw7SZulJDDYQ4h+fKf77vzdXcWdmFgeD3gqnLDgLB/2eAo2MbJwUise8zO9ULkWqWVuCizRyoFyTGd+G8yYTPFQZhJSNl76m4mcg2KjALhMR0yolI3mYCy+O+rzHtcFGEFeLtM1P2eNBd4XwogZOLRAhhVXuEHcQpsHW4gE0KrHJVEshJvy57x/tzimyhkYmaxIGgQbeCylAfTsTAk9bpMpzASPK+6WBfmRGOjEQzNtZsI1R5+OeV33OjJdeDuphJCYdUaqyZ48GqMNryGJO33+ajAU/BgMc5qlIcEHOs1kDle03OX1AkGMDBgmrVFI8IrKaMUSNLQXjyGBbaGVBUv374+O6G/T+4/v+Gb7Ot6Koshl4iUW3VuCVH91sfaZx1IJs0SnGD4/3uboVKSMuIN1+3hchTvgM7BWTIDqLRDR43tIvO4NVYaTTaQtcNvH4U66nI7OjdHmJiSoY/5hS4rammNKOybyXC+Qj0cfv0RfISbTpUr/1yjx0kJSGumWvkecgjBgTkqUZjwYkmqwgUw19ZdJ6Cl0xaOui9ioWusoddQ2wqjqaruO5lEVaq6OVFS1pVBzcm/mbYcqTY5vT50rbBxFopD9JNdl2rfwiFnvS/2iXm79DbvOhSP5sa+EZyfXl5y4t6HdUm6bPK0H2KWKPPJQPbQfexCeNIuLVtj3C+fzKVWmvXnIa2BBbl8jSOFKzFoAkyhE4kWxGfx6yKgLmfv2mekvqwsk0jaymL/rf/7YP6KzQls3E15TofO0k2FLA9kgW600+g+nVsi5gz8uKnKBvRBJ++CroK7BakZZNIg3J1Y3afFmfXzM6WDV2ekXdz0XxTDFvNDbVTVGm58mr2s6xiZkSPu4nAsjxZi+KGoxlZbWqPxM5BZ2pOrNTSjYt+yVmbk19HAo1JKCEHlJO1w+wPLZtKZhchCtXfPzAE6rrB/MaOd0PYBS+90PJrTn4D2AYqfFeojYKeDLxiutuT5JEijcmuGLIbHRjb+d3yFWbPaxZ33Lv76VFNaAR9zpB1B13XF0tCeCdf0EwZrBOg== +api: eJzNVcFu2zgQ/RViTluAsNI22INOm27bRVCgW7Td9mAYCC2ObCYSqZAjZw2B/16MRMl24nURAwX2YFgkh3pvRm/edEBqFSCfg1akAlKAhQSNofCmIeMs5PDWPdjKKR0ErVEUzhJaEq7sl+maMBotmdKgFsttf7IyG7TiJgVc6xuhrBY3G/TBOHszAwmuQa8Y5Vrv4bwdboCERnlVI6Fnhh1YVSPk8OD8XWhUgdcaJBim2Chaw2Pe38c4YdsavSl2JD1I8HjfGo8acvItSgjFGmsFeQe0bRjHWMJVH1o6Xysatn6/hBjlRGZK7ySVlJII5I1dPZPHcOkANRXxJOa3IYaTX6IX5IROBT4TtDQVfuTHU6jvTYWCL4jS+UEhCRX1JJakoWfxWHBwaJwNGPj81cUF/x2i//0BJIxvzztQTVOZopdYdhs4pPtPiL3PvDRW+S3EGKOEy2NAb5QWzB0DPQdxl+4cagxBrZD7LRFxy1sset177gwyQ6Zj4LGPA2So4q133jv/ORVoYv76SInGnhPWkVBV5R5QQx99+TT6oyNRutbq/2uWUULAovWGtr1HvEHl0V+1tIZ8vmDV1Ehrx/6ySp7CR5BNLhKybs9RYjYaYdZNvR2zTdalnouZzbqxFSIwvN+MDtX6CnJYEzUhzzLVmFlRuVbPAt6jVzPjnvTLl/5EfKoUsfzEnxwvrj5dA3MfU/vCtR3qtJ/gVCpGhNQ9vF72QSDTw/tR2LcP1NfT2NL111NdEwuG/RlBTtcUGFIwi0IVvSgOk99PGWtlqt4+S/fH7iDKychyeDl7efFqdsGbjQtUq15UyXrG0XDEQQ7YdjuR/sKxlYpO+C9lTaWMZdJ99l2S13w3pAJIyA9H1jRqJeT782PDGztr518+me5CwtoF4nd33VIF/MdXMfL2fYuexb+QsFHeqCV/0nkH2gR+1pCXqgp4olS/fU4d+0L8ZGgeTT1tKrvlJFTV8gok3OH20bjmaXIWrVMD9AxOu6qfzejkeD2D0vjdzyb0zMl7BsVJi3ERJaxRafS90objq6LAhvYuPpkSB3b817uvIEEdGtkj4+rffpRU1w0RX90d2hgnjsRrJhjjD6kQwV8= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Downloads the content of the dataset identified by the given `datasetId` and `ve id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/download-workflow-log.ParamsDetails.json b/platform-api-docs/docs/download-workflow-log.ParamsDetails.json new file mode 100644 index 000000000..b895da36b --- /dev/null +++ b/platform-api-docs/docs/download-workflow-log.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"fileName","in":"query","description":"Filename to download","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/download-workflow-log.RequestSchema.json b/platform-api-docs/docs/download-workflow-log.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/download-workflow-log.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/download-workflow-log.StatusCodes.json b/platform-api-docs/docs/download-workflow-log.StatusCodes.json new file mode 100644 index 000000000..6899f28ae --- /dev/null +++ b/platform-api-docs/docs/download-workflow-log.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/download-workflow-log.api.mdx b/platform-api-docs/docs/download-workflow-log.api.mdx index 63700c073..7ff365846 100644 --- a/platform-api-docs/docs/download-workflow-log.api.mdx +++ b/platform-api-docs/docs/download-workflow-log.api.mdx @@ -5,9 +5,9 @@ description: "Downloads the workflow files for the Nextflow main job associated sidebar_label: "Download workflow files" hide_title: true hide_table_of_contents: true -api: eJy1VU1v2zAM/SuCThsQJN3WDVhOa7d2KDZ0xdqhhyJAFZuJlSqSKsnNAsP/faRsx3aSfh2WSyLpUe+RfGIKHsTc8/ENXxl3N1Nm5flkwFPwiZM2SKP5mH8zK62MSD0LGbAGyGZSgWcz4+L2OfwNcXsppGYLM2XCe5NIESBlKxmyiJrLB9DstrnjLL0d8gE3FpwgsrO0Q3ddg36aOWKscGIJARypLbjGBWLbixAiSawVIePbGTRXMR+c1HMmU9BBziQ4hDq4z6UDpA4uhwH3SQZLwccFD2tLJFUQL8vBhpdyP6efNet9Dm69Q3uKKApgwbC0zoq/jIAS81Yk0Ga2n+O6ATKdL8HJpJ/cDpfUAebxCDu3FKHa+nSI7BOqhbdGe/AU8f7ggL76fL9+YGhi8BYd6FRYq2QSuzdaeIIUjybY4ZxKLTCbEj8DfriP6FikjFoDPryGse3mDV+C92IO5OhaiJkuIKH7rCPTBVll2gD3tYQHGRRtnThn3O+6QBvlH/aUqLEz0yYwodB4qIfgHpLcybCOFj4G4cAd5ejX8c2Eqo/+zgw9gTlEjWTlMR81Jh8Vrd3LUddQ4B6ah5E7hTFZCNaPRyNh5TBRJk+HHu5R1VCaHQddxhN2oUSg9rCvhGdHF2ecNDWSL6nCVbW6wjcFI8bGb7SeRhDuVD9Om8YvViGWQuqZieF1dWsVRPucQEpXJjh7KjBZQyTRGv3kuymjO6SKXp+ZL+0BCqHKVTzvhp8/Dg9ozxofliI6q36PzVDaGn/bWovWqP9/bNaVD3jFyCqMJ+mxBEXtnXasI3zcG5Yb+2CPM0yXwEUxFR7+OFWWtF0NHDJVKr2YKnpUM6E8PJH0IyNvr9Q7WPdH6YNQOcE4DcKXcz4zAp/g7k/Zln5CCyeJ/5X5v/ldz5+37Mk/nb2i6k2h1101XbF1+8oJojMQKd5F+irAUZKADZ3QnUnZGzLfT64QK/rPeOvZxtv3ykKvRMSVuQONfmlUBlqTwLL8B3oU50Q= +api: eJy1VU1v2zAM/SsCTxtgJO027ODT2n2h2LAVbYceigBjbCZWK0uuRDcNDP33gYqdjzZru8NOsShK75F8eumAcR4gv4KF8zcz4xYBJhmUFAqvG9bOQg6f3MIah2VQXJEaEtVMGwpq5nwK/6B7TuEatVXXbqowBFdoZCrVQnOVsub6jqz6PdxxUv4eQQauIY8CdlJuwV32Sd/dHDJo0GNNTF7YdmCxJshhcxFkoIVsg1zBwwqGq1Rgr+1c6ZIs65kmDxl4um21pxJy9i1lEIqKaoS8A142ArI6BDFma1yp/Yd89qi3LfnlI9gv2pAcUOxU2VcFLwOQwkKDBW0q249xOSQq29bkdbFb3CMsbZnmaWvmfI28Cr1/BzFOpBehcTZQkBNvDg7kZxfv5zfIoHCWybLsYtMYXaTpja+DpHR/LXALc6ot+iXEGGMG7/YBHWOpZDQU+F8QN9O8gppCwDmJonsibnpNhdzXeBEd61WlQ+K+kQBrNhL67L3zZ32D1szf7mnRIGdlHSs0xi2oTFcFKlqveZkkfEzoyR+1XEF+NZHu18SVkycwp8RRpJzDeBD5uNvIPY63BUX+bngYrTeQQ8XchHw8xkaPCuPachToljyOtHukoPO0o04NsoxHfZR8dXR6AsJpoHwuHV51a5v4umGCOOhN1tOUBFn/8WUY/PWCUyu0nbl0vO9uz0JgnyMo5eqCQp8s0sAiSWO3+O2SqUZtktZn7sNmI2YgnVvhHI4OD96MDiTYuMA1Jmn1D3JwpQf+95Bst1Hq//fNvvVM9zxuDGor1FMPul48G1+HDPIdt1zrZ5JB5QJLctdNMdAvb2KU8MpxRFWlDjg18qpmaAI9UfRfPG8v1Rta7nrpHZpW0kCc8OWYz3jgE9i7NruBn8jCa8H/x/pfnfUG9Fo9+a+zl1QfRLvcZrNNth9fnMQMKsKSfOK3SjgqCmp46+gjq9xxma+fLyAD3H3HD95tun0vra5bZVy4G7IxrlmyrIVgjH8Atx3naQ== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Downloads the workflow files for the Nextflow main job associated with the given id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/download-workflow-task-log.ParamsDetails.json b/platform-api-docs/docs/download-workflow-task-log.ParamsDetails.json new file mode 100644 index 000000000..110f217e1 --- /dev/null +++ b/platform-api-docs/docs/download-workflow-task-log.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"fileName","in":"query","description":"Filename to download","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/download-workflow-task-log.RequestSchema.json b/platform-api-docs/docs/download-workflow-task-log.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/download-workflow-task-log.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/download-workflow-task-log.StatusCodes.json b/platform-api-docs/docs/download-workflow-task-log.StatusCodes.json new file mode 100644 index 000000000..6899f28ae --- /dev/null +++ b/platform-api-docs/docs/download-workflow-task-log.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/download-workflow-task-log.api.mdx b/platform-api-docs/docs/download-workflow-task-log.api.mdx index e4a22909b..0cfceabe3 100644 --- a/platform-api-docs/docs/download-workflow-task-log.api.mdx +++ b/platform-api-docs/docs/download-workflow-task-log.api.mdx @@ -5,9 +5,9 @@ description: "Downloads the workflow files of the task identified by the given ` sidebar_label: "Download workflow task files" hide_title: true hide_table_of_contents: true -api: eJytVVFP2zAQ/iuWnzapatjGJi1Pgw0mtGlDwMQDqoSbXFpTNw62A6ui/PfdOQ5JIHR0Wl+a2N/5vjt/96XiTiwsj6/4vTarTOl7y2cTnoJNjCyc1DmP+Rd9nystUsvcElgLZJlUYJnO/KoTdsVkCrmTmYSUzTd+eSHvIGfXtHuSXk/5hOsCjKCDT9Le0Zfh0AsEftcLxBXCiDU4MMSu4jm+IL5NjsETLolcIdySP2bcHsesMzJfdMQMQg3cltIApnemhAm3yRLWgscVd5uCkjRBvK4nD3mbArbmJOosL9dgZLJjQpk7WHhops1auGbpw/6AArX7Bz0GErclmM0TFseIogDmNEtDc/nLaqTe2kIk0BU6nuOyBY6Xu0t5M+qOLXRuwVLE2709+hvm+/kNQxONp+SOdkVRKJl4EUU3liDVswX2cs5lLrCaGn8Tvj+W6FCkjC4LrNslY3e/V3wN1ooF0BAFInp+AwmdVxjSvpNNpS1w7Eq4k07R0pEx2pyFBj0wfzfSonaqWK4dEwq1j3wIbiEpjXQbP0WHIAyYgxLlG1/NqPs4YktNk7gAz5GUHfOonbOo6iaujlpBRVUzDzXdNpi7dkhLozB46Vxh4ygShZwmSpfp1MIt0ptK/URK536HnSrh6J7YZ8Kzg9MTTuRa7ufU6qZt/QoeOkcZW+HR+9yDcKV5OG4VcHPvfE9knmkfHtocWFDavxGkcmWCvteASSMi8RoZFt8vGWUilRd9pj91G0iEOtfkeTP9+H66R2uFtm4tvMTCYLYm2Vmvd1vvv48JV51s/69vh1Y7+O2iQgm0B+Tqa66CarpvCMLjgVP3nCgOVorXu8RKKayq5sLCL6PqmpYb0yE9pdKKuaLByoSysKXUZ2xvlPQKNkM7vROqJBgnM3x5zr/Y4JbcQ6ft0s/oxUjKv2P9r86CB71mW799o6TCosg3fTZ9suEid+tPj9Pz38Z/IBQEVM8QuQSR4jnUrGbzIEmgcL2wJ9Y9cL2vRxeIFUM7eWQf/vRRSihcj7jQK8jrumNI70Swrv8AAtg9mw== +api: eJytVVFP2zAQ/ivWPW1S1BaG9pCnwQZTtWlDjIkHVAk3ubamjh1sh66K/N+nc5wmhVLotKck57O/7z7ffanB8bmF9BZW2ixnUq8sTBLI0WZGlE5oBSl80SslNc8tcwtkbSKbCYmW6VmIOm6XTOSonJgJzNl0HcJz8YiK3dHqOL8bQAK6RMPp4HHeO/omHnrN7fK7nkMCJTe8QIeG2NWgeIGQbliOc0hAELmSuwU8Zdwex6wzQs07YgYSMPhQCYM5pM5UmIDNFlhwSGtw65JAmk3gfbLBbQrYi0nUmaoKNCI7EFAoh/OQOtOm4K4JfTzZokBy/6DXSOKhQrN+xuJCSKQNzGmWR3HhbTWStrbkGXaF7sa4aRN3l3tIeRNSx5ZaWbS043g0osc23s9vkECmlUPlaJWXpRRZaKLhvaWU+sUCe5hTobhZg/feJ3CyC+iM54wuC607BLG731so0Fo+RxqiSERP7zGj80pDve9EU2mbuOtKwAknKXRujDZXUaAN8w87JGqniintGJdSrzAPR1nMKiPcOkzRGXKD5rRyC0hvJ6R+gW6haRLnGDhSZ6cwbOdsWHcT54dtQw3rZh483Taax3ZIKyMhhYVzpU2HQ16KQSZ1lQ8sPqDhA6GftdKvsMIuJXd0T+wz5bPTyzEQuZb7L5K6ka1fwUY5Qmwbj76nIQmS+HLRdsD9ygVNhJrpsD3KHFkQ7GsEqVyRoY3J1CM8Cz2yXXy/ZCy4kKHpZ/pTt+ATIOUanKPB0eh4MKJgqa0reOixOJmtS3beG+w2GPBTxnXXt//XuKPWDv+4YSm5UMQ1FF3Htul+IpBAumXVPStKo5dOElho62hbXU+5xd9Gek/hxnWooXJh+VTSZM24tLin1Bd8byfpJa63/fSRy4rSgNzw7Ziv+OAe7G2r7eAn9GEE4R9Y/7uraELv2d6f305SMcjVus+mTzZe5GH69Di9/HP8B0KxgfzEJ7BAnqMJYjWLp1mGpette+bdW7b39fwaEuDbfvLEP8LpOynVdZNxrZeovO8Y0jcR9P4vfQk9wA== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Downloads the workflow files of the task identified by the given `taskId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/explore-data-link-1.api.mdx b/platform-api-docs/docs/explore-data-link-1.api.mdx deleted file mode 100644 index ae211d7c6..000000000 --- a/platform-api-docs/docs/explore-data-link-1.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: explore-data-link-1 -title: "Explore data-link path" -description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." -sidebar_label: "Explore data-link path" -hide_title: true -hide_table_of_contents: true -api: eJzNV9tu20YQ/ZUFnxJApZzELRA91Re5EOo4huOiD4ZRrcihtPaSy+wuLSsCgX5Ev7Bf0pnlXVIo2UCLPknkzsw5Mzs3rj3L58Yb3Xkht/wHKZJH490PvBBMoEVqhUq8kXcDVgt4AsPsAligEguJZSpyj7Ui48aoQHALIVsKu3Cnc/EECZuS0CXKTMLpgHHbPkq5XUx9b+CpFDQnxEmImOPnVCoN56XiH+9QIuWax2BBE+O1l+ADSja2UUQQXzLpbTpxXvM06E0yZyJEL0QkQKOshq+Z0IDIVmcw8EywgJh7o7VnVymhFEpeng9q4BLm+5BnZaTKw9dgLJV+NCkPoPHuawZ6tYX1eyXIkiwGLYKuf1tYAqnN3VGkdMxt8eqn4w56gGzJCJdmH/5ZI7ozwIc4a4DrYNGPc60hEs+sEKUcbPKvTMwDwRJ4ttd8DrfqEZJ+TCfCMoOJbRWLwAZFcpMJvNw5EA9hITYHYpPOF/EN+mGvsngGurZN2BpsphOGleJwfTaJmIpjYbHosLBYCBHPpGUxfxZxFrMnLjNgwpSKEPqH58KH98j5ntLWpCoxYEjj/dER/XSJfv4VVavo4ylPUykCV8vDB0Mi621QNXuAgC4r1VT5VhQASou5SLi8pprZCuJmiE65AVdeDJkzLmXtKCvsG9eKRNJtVb6XD0oCpgXCteZ0DcVV7qVanG4G4xbfVr2RDPlsjAzwwqYXk8vxlCn69/nyfHzjut6mf4DlS/24EMEXpEUt2Qoroexjrt2hbcIiV4q02hesK5SqmEVCAlGJlAxBu3gYSsgDGsSmWUrkjlmM9mxlwfjsokYwmJ1yyVeGTY+mDi4WMdyWEezn/WnyacxsK6yEMmABl0Em3biZrRjHnFl9o7ZT88DqhMSgDZ9dZZgaUcPGp3LcGVKi1oU/oazodpqiHt8QikHksDL7tpptJoWAOl/oktP52+03e50ueo5doMGAY0Ch7j80RsDY73Sg0lcRsUSxGCdoSZbjP/7EheQzCbvdL8fVTVnvKENSx7sq/pSHNwWNl1R+MwDvvBiMQd4us3urrBLc1VBrF8ZaK71F/MOOVlUtGRgeSw1DLZGPkz7elr5S9kJleL9///kXq0cx1U1rMjpLEYkN2Mn1hIXCUIxDl290SbXigDSbLKr1/q8xpKYAQaaFXbmF6xSHLuiTjDrz3T3NBtzGForWtTk4VNe0vWGzTA7XzXqWD2daLQ0M1ySX0yQC/VRtc5mWqLqwNjWj4ZCnwg+kykLfwFe8Ml+o7cbjTtg19gBqUeyM5OkKPKJWMf9CoSvC0OZfR4IQq6FIzzMnhG+KPxdV83tYWhcukUTKqZdhK1kQ7D6C5K4IsGUUwnTnPHB33nW+7TJeu5Cu90bq5+YAiVDkCpx3/scf/SN6lypjY+5Splw1yj26lXa7VtV1k4D/0bZfRt9iAxumkuMahPRdGNZlGnW+SQbeqLPnF5lEr50w3vcCXSel9XqGS8FvWuY5vS5WK0qwqi69UYRVCz0R2LNL76T+CKutdd1tX/jWo9XvcPh9q3QP/ubC/koGBy3ZPTTqRf6V+C9auHt4bO74r6Tzby3iPcxbXwgN6Xt60IJYvzCj39yUY+Mt6/8O3kmpWo+TVZtORbVVly8La4vUxpfyK1g4zfwe5RbAcRdzASqOToIAUttS2pqwnVH2y/gWZXl3SmxMBWd9JyFsP07CpVye1/ysS0EkmOf/ADN9BzA= -sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/explore-data-link-tree.ParamsDetails.json b/platform-api-docs/docs/explore-data-link-tree.ParamsDetails.json new file mode 100644 index 000000000..8e05622e0 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-tree.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier. Required for accessing private data-links.","schema":{"type":"string"}},{"name":"paths","in":"query","description":"List of paths to explore. Returns all files within the specified paths, including sub-paths.","schema":{"type":"array","items":{"type":"object"}}}]} diff --git a/platform-api-docs/docs/explore-data-link-tree.RequestSchema.json b/platform-api-docs/docs/explore-data-link-tree.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-tree.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/explore-data-link-tree.StatusCodes.json b/platform-api-docs/docs/explore-data-link-tree.StatusCodes.json new file mode 100644 index 000000000..bc80dc8e3 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-tree.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"required":["path","size"],"type":"object","properties":{"path":{"type":"string","description":"Path to the item from the data-link root (resource path)."},"size":{"type":"integer","format":"int64","description":"Size of the file in bytes. For folders, always `0`."}},"title":"DataLinkSimpleItem"},"description":"Array of simple data-link items containing file paths and sizes."}},"title":"DataLinkContentTreeListResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/explore-data-link-tree.api.mdx b/platform-api-docs/docs/explore-data-link-tree.api.mdx index 6a5ea53a6..7b3cfef85 100644 --- a/platform-api-docs/docs/explore-data-link-tree.api.mdx +++ b/platform-api-docs/docs/explore-data-link-tree.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves a list of all files in the data-link associated with the sidebar_label: "Explore data-link tree" hide_title: true hide_table_of_contents: true -api: eJzVVsFu4zYQ/RWCp13AsdM2LVCfms0mRdBFN0iy6CEwEFoa2UxoUSFH9noNAf2IfmG/pDOUZEmWkKSLFmhPtqRHvseZN8PZSVQLL6d3MlaojoxOH72cjWQMPnI6Q21TOZXXgE7DGrxQwmiPwiZCGSMSbeidTgUuQew3EMp7G2mFEIuNxmX4utBrSMU9gz4Q5jK+H9HCyOSxThfNRj6fH2UKl34sPnlIcuKwTriSn5GRXWUGkOi0gwit2wqPLo8wd+DHciRtBk6x7suYlJ9/zox18L6ivXUAhMmUUyvaxPHJdzKlB8I22gii+dysRB4G4/3+nETMknQMKepEg2N+B085SSNykgUj6aMlrJSc7iRuM6YpV8miGO2ZN9Y9+kxF0FA/5eC2Pe7faqBI8xU4HbXJxccAU4Zl9Gh1irAAR58ooiuF5asfTjpCIhLO+ynjX5Jy1kAHAiGuqzCE/KkoAu8Zkjm9Vtgyix8UOxCj4IrnJX2orBmgAq2AMvushvyR+pZp2ZiVcX0GEauOy4VtXzZ2HFKpnFOsQiOsfOu9nT+QNUl9MWM/+MymHgLg2+Nj/unK/vgL7RFZyk+K/FVlmdFR8PDkwTNk1+Ju/HVXERNJl5gM7rgMUJesh/p6utt7Vp73+gu8vHMA99J2mJcrxU3AhmAzp0icXR30DGctijcULJs7sjdv/HYsi0rIK2x8SHpD69gMTMMp5+4y3yI1CXFBlkysian+R2SJjdp6cX98P2a/SdRooCpz7gY3mhvOJclmNV2OUw4kk/gAah0nhFZwUpVO6w5XGVOlseBT+WHCs9IJ3KrY0NeVf9hOhD4ZctA7FXO9gcevddKK6lMtXpHxGjhUq/ujnDtnXU/4dwPWr5u1SCn9VJ12Q3oC+qSP/tXihc0pen/+/ofY90xB2Wz1rbBTwrCROL26pHvCq7mpGhGbYb9wxCublNED56dZ/1+NJRcFRLnTuA3X1ztQDtxpzqV4N+OeQ3fb0vL1t4DAGqpUTpqmO9k1l10xmTu78XCE5eXowa3rmzF3hhYuETM/nUxUpseRsXk89vBEiRtr2y+78EVcGYVcoOKM8ZwIycJq3TccuDIIbfX7ODBj3XH5eR5A9Kb8c1GX/sMGQ7B0mtiwvApapYJpXxLIx9V0PVXgULJRyHj38O0jU9K1CZ0nsT81H0gIR67k+Wb84/fjY36XWY8rFQxT3WXVVNIyXxX7jtRdY7//1QRW5RDhM04yQ/2PgxCCWV8YnWlzJKedyavtRrLMkqLHK3a7ufLwyZmi4NflBMAerQtcThMqf3gmiK+fngaP8Ajb3qy2ViZnpORJ5fVK/snh6Rmth+PcV6r9l+eqZw5QD32N8Bk/OM3K/2b239RRfSteGOEHBdWzU7pt66mFthxczAi9BEXjRVBYAk4pixm2lvbuk07j/vn8lrCq2xUPumDYfVAW1UpA3NpHSKleapXIzyywKP4CkPrgAQ== +api: eJzVVttu20YQ/ZXFPCUALTmp0Qc91XHswmjQGLaDPhgCvFoOpbWXXHp2aEcRCPQj+oX9kmKWpEhdYLtBC7RPEsmze87OnJmdFbCeB5jcQKpZHzhb3AeYJpBiMGRLtr6ACVwik8VHDEorZwMrnyntnMqsw6BsoXiBar2B0iF4YzVjqp4sL+LXuX3EQt0K6JMt7s/T20TZwrgqtcW83yhUs4NS8yKM1JeAWeVU5klRwy9I4/PSIaNKLaFhT0sVmCrDFWEYQQK+RNKi+zyFCZx+LZ0n/NjSXhMiJFBq0jkykpx8BYXOESbQa4MErJxblMB2MD6uzxmYRJJNsWCbWSThJ3yoLGEKE6YKEwhmgbmGyQp4WQpNswrqOlkzP3m6D6U22FM/VEjLHe7fOqAqqhzJmiG5+hxh2omMHVpbMM6RIIHMU665efXj0YYQQxj30y68JOWkh+4JhLpswxDzp43BEARSkn3UPDBL2Ct2T4yiK56X9Km1ZoQq9gqb7IsarqgIA9OKMVvjhhKNqE6bhUNf9nbcp1ITaVFhGfMweO9nd2gY6rqeih9C6YuAEfD+8FB+NmV//gUSML5gLFi+6rJ01kQPj++CQFYD7t5fNy3xNNkiTqAkKQO2Deu2vh3dwz1bzwf7DV/eOYJ30radlwstTcDHYAunysjnWz2DvGf1hjD4igzGTLwdQd0KeYWNt0mv7DcUMwiNpFy6y2zJGEbqzJPKvEuRQqK0e9LLoG4Pb0fiN2DLDtsyl25wZaXhnDPmomaT41gCKSQhggbHiaFVklRti67DtcbURarkVGE/4UnjBGlVYujL1j9ipzqBo30O+qBTqTcM/L1OyjEEPX9FxjvgvlpdH+WUyNOO8B/2WL9r1qrwLNXpnzCFiD7aRf/q+cxXRar+/P0Pte6ZypMa9K24UyawRB1fnKvUBj1zbSMSM6wXJrKyT5mnmJ9+/X81llIUaCqyvIzX1wfUhHRcSSneTKXn5MgLL9ffHCNrrFIY9013vOovu3o8I/8U8ICbyzEgPXY3Y0UOJrBgLsNkPNalHRnnq3QU8AFJj6zfLbv4RV04zVKg6kTwkggQYZ3uKwlcE4Sh+nUchLHruPI8iyBI2j9nXenfPXEMli0yH5e3QWtVCO1LAuW41mBowbFkTcz45uGHR8ZcWxc7T+Z/6j/UCUjkGp53o3eH70eH8rL0gXMdHdNeZu1YMnBfG/wNravef/+rEaxNIuNXHpdO20KCEKPZ3Rgb42YCk43Ra2jHaQILH1hWrFYzHfALubqW180IICbtKhwmmXYBnwni68envUe4x+XOsPaoXSVIkFHl9Ur+yenpGa3b89x3qv2XB6tnDtBNfb3wqTyQFeV/M/tvuqi+VS/M8HsFdcNTsRzq6YQOHFxP6wQWqFOkqLABHBuDJQ+W7lwoG53759NrSEBvtsWtNhh33ytrtWoQ1/4ei7peq2R5FoF1/ReA/OAm sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves a list of all files in the data-link associated with the given `dataLi id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/explore-data-link-with-path.ParamsDetails.json b/platform-api-docs/docs/explore-data-link-with-path.ParamsDetails.json new file mode 100644 index 000000000..6788533b5 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-with-path.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","description":"Content path","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier","schema":{"type":"string"}},{"name":"search","in":"query","description":"Prefix search of data-link content","schema":{"type":"string"}},{"name":"nextPageToken","in":"query","description":"Token used to fetch the next page of items","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Number of items to return per page. If ommitted, a default maximum value is returned.","schema":{"type":"integer","format":"int32"}}]} diff --git a/platform-api-docs/docs/explore-data-link-with-path.RequestSchema.json b/platform-api-docs/docs/explore-data-link-with-path.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-with-path.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/explore-data-link-with-path.StatusCodes.json b/platform-api-docs/docs/explore-data-link-with-path.StatusCodes.json new file mode 100644 index 000000000..0bc530ac6 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-with-path.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"originalPath":{"type":"string","description":"Base path for all returned objects within the data-link."},"objects":{"type":"array","items":{"type":"object","properties":{"type":{"description":"Type of the item. Either `FILE` or `FOLDER`.","type":"string","enum":["FOLDER","FILE"],"title":"DataLinkItemType"},"name":{"type":"string","description":"Name of the file or folder."},"size":{"type":"integer","format":"int64","description":"Size of the file in bytes. For folders, always `0`."},"mimeType":{"type":"string","description":"MIME type of the file, calculated by analyzing the file extension. Null for folders."}},"title":"DataLinkItem"},"description":"Array of data-link items (files and folders) at the specified path."},"nextPageToken":{"type":"string","description":"Token that can be used to request the next page of items. Null if no more items are available."}},"title":"DataLinkContentResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/explore-data-link-with-path.api.mdx b/platform-api-docs/docs/explore-data-link-with-path.api.mdx new file mode 100644 index 000000000..c24601366 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link-with-path.api.mdx @@ -0,0 +1,66 @@ +--- +id: explore-data-link-with-path +title: "Explore data-link path" +description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." +sidebar_label: "Explore data-link path" +hide_title: true +hide_table_of_contents: true +api: eJzNV9tu2zgQ/RWCTy2gtdML9sFPmybOItg2DdIs+lAY8FgaWWwoUiVHSVxDQD9iv3C/ZDHUxZbt2k6AXeyTLXGG58xweGa0lARzL0dfZAIEv2hl7rycRDJBHztVkLJGjuQNklN4j15QhiK2htCQsGl47BwFeG9jBYSJeFCUhdW5ukcjpmz0Xpm7y2QaCaD1pQIomw5kJG2BDhjxMpEjOX4stHV43jh+VpRdA2UykgU4yJHQMe+lNJCjHMkVgoykYtZFbd4P5bxj68kpMxcqQUMqVehkJB1+K5XDRI7IlRhJH2eYgxwtJS0KRqmdZFVFHXAD83PIsyZfzeJzMB6su/MFxLiK7luJbrGF9bk1FKbM0am4H98WljKE87CUWpcD1a9+fdtDjx2GTUD7Q/hnK9OdCT4mWI/g4mw/zrXDVD2K2pQrcVWFTXkeCWbwka5hjrf2Ds1+zGAiSo+JICtSpLgucd5CFDBH5qEIc38kNvt8Ut9xP+xVmc/QdXsztkMqnREFuoA7EJepsHmuiDCJBIgEUyg1iRweVV7m4h50iUL5xhGTwfG18Oa1rKoJl60vrPHo2eP1yQn/9Il+/ENGss3+aCmhKLSKw40efvVsstwGtbOvGPNhFY7vP6kawDo1VwZ0uPJbSdxM0TvwGK6XSK0ToHUXqKj390GQlOkL1kBWUUPAr4GAc8DHUB/lQar16mYybhcFtgrJGw3EWFGGTkwvLt+Pp8Lyv4/vz8c3Qfs240NT5qzKtYmMJHuxMJMijY2OBbkjzBmLQ6nL6lCyriDvmKVKI1NJrU7QhXx4LsgjBGJzWy7k3rbKiNmC0A/ERYfgIwH6ARZeTE+mAS5XOd42GdzP+8Plh7GgtbQySiRi0HGpQ9OZLQQY0IvvLDsdD3wkNF5ZMxBXpdahRBo2A76OO1PK1Prwp1wVfaWp7+MLRvECTNJu+7LtcL7AmJUvCcUZ4u3rzcGga82hDEjEYMQMO/3hNoKefqJATawqFcaK3DpsyIJDAfegNMw07g6/aVc3zX2XVcVWb3fd+HeQ3NQ0nnLzVw3wi8zRe5hjqOy9t6w13CWoXQhj56zbIv5mh1S1o4Ywllgw7AMmMli/3ba+snRhS5OIv3/8JbpWzPdmrTOGnVI2i8Tp9aVIlOccJ6He+JA6x4g9V1XU+f1fc8iigHHpFC3CwPUOwaE7LVmZv0y4N+RImeWhbY4BNYi2HK5GyuFyNZ5Vw5mzDx6HS7aruBOhu2+nudJpOZIZUeFHwyEUahBrWyYDj9/QwUDZbeEJK+JaA7FEiTO25yOQTK1l/olTV6dhnX+XCUZsmyI/z4KRjJo/F634fX2gkC5lUhvcm7Q1LBj2EEEOV8XoG2M+c4jDmfeDXw8Zc1A6aG9qf1stVJHkzNU4rwavTl4PTvhlYT3lEGqmmTWacXqt7nbNqstVBf5HQ3+TfsJHGhYalGH6IQ/Lpo56nyaRHPUG/bqU+HUwnkQys57Yabmcgcc/na4qfl3PVlxh7cWUoxS0xz0ZODBM76R+h4uteT2MX3IkJc9+x8MfmqX34G9O7M9kcNSUvYdGN8k/E/9JE/ceHptD/jPp/FuT+B7ma58IK9ITfnCKWT+xol/cNH3jpdj/IbyTUjsfm8U6nZbq2r18WlrXSG18Kj+DRfCsJlUkM4QEXUhQvXQax1jQmtNWi+31st/HtzKS0G8TG20h7L6T0HJZW4SSq6qOH4USrCZVVf0DMrEJ7g== +sidebar_class_name: "get api-method" +info_path: platform-api//seqera-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. + + + Request + + + + + + + + + + + + + diff --git a/platform-api-docs/docs/explore-data-link.ParamsDetails.json b/platform-api-docs/docs/explore-data-link.ParamsDetails.json new file mode 100644 index 000000000..cc2c070c6 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier.","schema":{"type":"string"}},{"name":"search","in":"query","description":"Prefix search of data-link content.","schema":{"type":"string"}},{"name":"nextPageToken","in":"query","description":"Token used to fetch the next page of items.","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Number of items to return per page. If omitted, a default maximum value is returned.","schema":{"type":"integer","format":"int32"}}]} diff --git a/platform-api-docs/docs/explore-data-link.RequestSchema.json b/platform-api-docs/docs/explore-data-link.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/explore-data-link.StatusCodes.json b/platform-api-docs/docs/explore-data-link.StatusCodes.json new file mode 100644 index 000000000..0bc530ac6 --- /dev/null +++ b/platform-api-docs/docs/explore-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"originalPath":{"type":"string","description":"Base path for all returned objects within the data-link."},"objects":{"type":"array","items":{"type":"object","properties":{"type":{"description":"Type of the item. Either `FILE` or `FOLDER`.","type":"string","enum":["FOLDER","FILE"],"title":"DataLinkItemType"},"name":{"type":"string","description":"Name of the file or folder."},"size":{"type":"integer","format":"int64","description":"Size of the file in bytes. For folders, always `0`."},"mimeType":{"type":"string","description":"MIME type of the file, calculated by analyzing the file extension. Null for folders."}},"title":"DataLinkItem"},"description":"Array of data-link items (files and folders) at the specified path."},"nextPageToken":{"type":"string","description":"Token that can be used to request the next page of items. Null if no more items are available."}},"title":"DataLinkContentResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/explore-data-link.api.mdx b/platform-api-docs/docs/explore-data-link.api.mdx index 3e20d4d38..a8155936c 100644 --- a/platform-api-docs/docs/explore-data-link.api.mdx +++ b/platform-api-docs/docs/explore-data-link.api.mdx @@ -1,13 +1,13 @@ --- id: explore-data-link -title: "Explore data-link path" -description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." -sidebar_label: "Explore data-link path" +title: "Explore data-link" +description: "Retrieves the content of the data-link associated with the given `dataLinkId`." +sidebar_label: "Explore data-link" hide_title: true hide_table_of_contents: true -api: eJzNV9tu4zYQ/RWCT7uAK6e7aYH1U3NxCqPZbJBN0YcggGlpZDOhRIWk4ngNA/2IfmG/pDPU3fbaToAWfbIlzsw5M5ybltyJqeWDOx4JJ35QMn20/L7HI7ChkZmTOuUDfgPOSHgGy9wMWKhTB6ljOvaPtSIT1upQCgcRm0s386dT+QwpG5PQJcqMonGPCdc+yoSbjQPe4zoDIwhxFCHm8CVT2sB5qYjnmTAiAQeG+C55ig8o11hGEUlsySBfd+G8ZmnRl3TKZIQ+yFiCQVkDT7k0gLjO5NDjNpxBIvhgyd0iI5RCia9WvRq4hPk+5FkZp/LwLRhzbR5tJkJovHvKwSw2sP6oBFmaJ2Bk2PVvA0sitak/irVJhCte/XzcQQ+RLRkRyu7DP2tEtwb4EGctCBPOduNcG4jlCytEKQOb7CvT8kCwFF7ctZjCrX6EdDemF2G5xbR2msXgwiK1yQRe7hSIh3SQ2AOxSeer/Aa7Ya/yZAKmtk3YBlxuUoZ14nEDNoqZTqTDisOqYhHEIleOJeJFJnnCnoXKgUlb6kEUHJ4KHz8g5XvKWpvp1IIljQ9HR/TT5fnlN1Stgo+nIsuUDH0h9x8siSw3QfXkAUK6q8xQ2TtZAGgjpzIV6ppKZiOG6xE6FRZ8dTFkzoRStaOssG99H5Jpt08FfNUrCdgWiDBG0C0UN7mXanG6HoxbfFs1RjIUsCEywPsaX4wuh2Om6d+Xy/PhjW956/4BVi8140IEX5AW9WMnnYKyjfluh7YJi1wpsmpfsK5QqmIWSwVEJdYqAuPjYSkfD+gP62YpjztmMdqThQMbsIsawWJ2qrlYWDY+Gnu4RCZwW0ZwN+/Po89D5lphJZQeC4UKc+VnzWTBBObM4ht1nZoHFiekFm0E7CrH1IgbNgFV49aQErUu/AllRbfRFOX4jlAsIkeV2ffVYLMZhNT4Ip+c3t9uu9nrdNFy3AwNhgIDCnX7oSkC1n2nAZW+ypilmiU4PkuyAv+JZyGVmCjY7n45rW7KekcZkjreVvGnIropaLym8pv5d8cTsBZ5+8zeWWWV4LZ+WrswNEabDeIft7SqasPA8DhqGHqOfLz08ab0lXYXOsf7/fvPv1g9ialuWoPRW4pJrMdOrkcskpZiHPl8o0uqFXuk2WRRrfd/jSE1BQhzI93C71unOHPBnOTUme/uaTbgMjbTtKtNwaP6ps37zSbZXzbb2ao/MXpuaehZMM/VFpcbhToz5zI76PdFJoNQ6TwKLDzhXQVSb3Ycf8KusfipN7EzkqfYc+JUUf5KMSv8bxOvQ0CI1TSk54kXwjfFn4uq6z3MnY+TTGPt1ct4lSwIdh9BcleG2CsKYbpsEfrL7jrfdhnvWyrfdGP9S3OARChyBc6PwaefgiN6l2nrEuFzpVwxyu25lW/bVtRlk3n/0Y5fRt9h5+pnSuD6g/R9GJZl/nS+RHp80NnvyxTCe56hyyS8XE5wC/jdqNWKXherFCVWVYh8EGOZwg7P9+zOWyk/wmJjPffrFr7ltOodDr9vdd6Bv76gv5HBQUv1Dhr14v5G/Fct2Dt4rO/0b6TzLy3eO4i3Pggazvf0YCSRfmVCv7spx8R7tvuzdyulah1OF206FdVWOb4uqi1Sax/Gb2DhNVf3KDcDgbuXD1BxdBKGkLmW0sZE7YyuX4e3KCu6w2FtGHjrWwlh9/ESPuOwA1X8nM9AJLha/QOtPQCb +api: eJzNV9tu20YQ/ZXFPCUAKzlO0Ac91bHlwmjiGI6LPgQCPCKH0sbLXWZ3aFsRCOQj+oX9kmKWFHWtZBst0CdL4uycM8OZs8dzYJwEGHyBDBl/MtreBRglkFFIvS5ZOwsDuCb2mu4pKJ6SSp1lsqxcHr92BxWG4FKNTJl60DyNTyf6nqy6laAP2t5dZLc9SMCV5FGSX2QwgOFjaZynszYGEijRY0FMXqjNwWJBMIBlEkhAC7ESeQqbbM86QoG9thOlM7Ksc01esD19q7SnDAbsK0ogpFMqEAZz4FkpMM0pqOukQ35w/i6UmNIS+ltFfraF/cciUNmqIK/TDfAtMG2ZJuQhgdz5Arn56ed3a/Cpp5gFTThE4HQZurv8p5QbCH063Q905SnXj6oJlVlYzkE7IE9Fs/TIVzihG3dHdj9oDFFVoEyxUzlx2kyZpFAlTkiIaKYiPBVcDn3W32k/7mVVjMl3yQXcE1feqpJ8BO6pi1y5QjNTlihUGeVYGVYFPuqiKtQ9moqUDu05yp4xDW+Poa5HMrmhdDZQkBPHR0fyZ53np98ggbb98hTL0ug0blr/a5CQ+TaoG3+llGXrvOwl6wbAeT3RFs2V7NhWDzc79B4DKVlHlTuv0JiuUNXkD1ETtF3XjB7USUsgrICg9yhvIXb7MNXm6WYzbmYlLURKEvXUUPOUvLo9v/gwvFVOPn36cDa8jpq0WR/ZqhBhbEIgATkl2siaDbU6E+WIqRAsKaWZqkPNusSiY5ZrQ0IldyaTDa0TCDKPT5CIzbQyx2tptVXjGVPoqfMOISQKzQPOgro9uo1whS7opu3gft4fLz4OFa+0VVASlaJJKxN1fzxTaNHMvovwdDzokckG7WxPXVbGxBFp2fRkG3e2VKitw5/IVKxLTbOOrwQlKLTZIu1rhRzxQ0mpaF8WhzPWu643B4tuNIenyCpFq8bU6Y/cJBT4nxSoqVXnyjpVOE8tWfSk8B61wbGh3eWfNht83e471LVEvdu18e8xu25oPGfzl3fgFygoBJxQnOy9W7YI3KWnXQlD753fIv52h1QtLICyjkUw3ANlEKPfbUdfOj53lc3UXz/+VN1tLHuzcjfGTLmEJerk6kJlOkiPszhv8pK6g4mcXE5Rd+7/2kMRBUorr3kWDdF7Qk/+pBJl/jKSu6EgnjoxUxOKqFG0ob90df350j7V/bF3D0EuvUD+fmGzKm9gAFPmMgz6fSx1LzWuynqBvpHHnnbbihOfqCuDLNqkTiVeeg/CaUH5s/SsqX+VeNcCQVzchvJ9HIMgaT+cL1Tv6wPHPmmbu3i87VfLQmAPEZRydUqhDZaXjWl82evFr5ZMBWoTRTd3vywf1AlI5xqcN703R8e9I/mxdIELjMPSeozW3y4HbpPmfDl1/77XbpvM9Mj90qC2QjJWO2/HZM38JzBY89ntpIwSmLrAEjyfjzHQ797UtfzcOCaZn8W+wSBHE2hPkYds8k7OdzTbsuLRVsEAQCzd0/EPuuQ9BDbN+AspPM0/7+HRmfQXEniel95DZNO/v5DPf+Sx9xBf8f5LziP54rWQfuZQv7pub4TX6sC/oDs5Layvna3yWXBd2cl6VCcwJczIR4ZNwEmaUskrR7dur7Vr4tfhDSSA60K8Ibwx+05a83kTEV95XXcsOY5AParr+m/FMaVm sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,11 +18,12 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; @@ -31,41 +32,35 @@ import Heading from "@theme/Heading"; path={"/data-links/{dataLinkId}/browse"} context={"endpoint"} > - + -Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`. +Retrieves the content of the data-link associated with the given `dataLinkId`. + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/extend-data-studio-lifespan.ParamsDetails.json b/platform-api-docs/docs/extend-data-studio-lifespan.ParamsDetails.json new file mode 100644 index 000000000..441fc913a --- /dev/null +++ b/platform-api-docs/docs/extend-data-studio-lifespan.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the lifespan is extended in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/extend-data-studio-lifespan.RequestSchema.json b/platform-api-docs/docs/extend-data-studio-lifespan.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/extend-data-studio-lifespan.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/extend-data-studio-lifespan.StatusCodes.json b/platform-api-docs/docs/extend-data-studio-lifespan.StatusCodes.json new file mode 100644 index 000000000..817aff9dd --- /dev/null +++ b/platform-api-docs/docs/extend-data-studio-lifespan.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Studio session string identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier. Null if the Studio belongs to the user context."},"parentCheckpoint":{"description":"Information about the parent checkpoint if this Studio was created from an existing checkpoint.","type":"object","properties":{"checkpointId":{"type":"integer","format":"int64"},"checkpointName":{"type":"string"},"sessionId":{"type":"string"},"studioName":{"type":"string"}},"title":"DataStudioDto.ParentCheckpoint"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo","description":"Studio creator user information."},"name":{"type":"string","description":"Studio name."},"description":{"type":"string","description":"Studio description."},"studioUrl":{"type":"string","description":"URL to access the running Studio session."},"computeEnv":{"description":"Compute environment information where the Studio runs.","type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"},{"properties":{"credentialsId":{"type":"string"},"workDir":{"type":"string"}}}],"title":"DataStudioComputeEnvDto"},"template":{"description":"Container image template information for the Studio environment.","type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"configuration":{"description":"Studio resource allocation and environment configuration.","type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was last updated."},"lastStarted":{"type":"string","format":"date-time","description":"Timestamp when the Studio session was last started."},"effectiveLifespanHours":{"type":"integer","format":"int32","description":"Total accumulated lifespan hours for the Studio session, including any extensions."},"activeConnections":{"type":"array","items":{"required":["lastActive"],"type":"object","allOf":[{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},{"properties":{"lastActive":{"type":"string","format":"date-time"}}}],"title":"ActiveConnection"},"description":"Array of currently active user connections to the Studio session."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"},"waveBuildUrl":{"type":"string"},"baseImage":{"type":"string"},"customImage":{"type":"boolean"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session."},"mountedDataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}},"progress":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","in-progress","succeeded","errored"],"title":"DataStudioProgressStep.Status"},"message":{"type":"string","description":"Human-readable message describing the current progress step."},"warnings":{"type":"array","items":{"type":"string"}}},"title":"DataStudioProgressStep"},"description":"Studio session startup progress information, including build status and checkpoint mounting progress."},"labels":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"},"description":"Array of resource labels applied to the Studio."}},"title":"DataStudioDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the Studio is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx b/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx index 3458e5f29..7b437f306 100644 --- a/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx +++ b/platform-api-docs/docs/extend-data-studio-lifespan.api.mdx @@ -5,9 +5,9 @@ description: "Extends the lifespan of the given Studio session ID. Append `?work sidebar_label: "ExtendDataStudioLifespan" hide_title: true hide_table_of_contents: true -api: eJzdWulvG7kV/1eI+ZINIMnO0aJroGgV29kV6tiCbCcFgiCiZiiJ8VwhOXJUQ//7vsdjhppDR5Ogi37SaHi8g793Dp8CRRcyOPsYSFVEPJPBp14QMRkKniuepcFZcPlNsTSSRC0ZifmcyZymJJvr/wu+Yim51UuJZFLCEjK6GJBhnsMiMv3HYyYeYEXIRtHfp0RlhOntGrtRtwtP4blcRcIsVbBkEPSCLGeCIlOjqGTrgipqFl7ZzWBiTgVNmGICBXsKUvgDCyx7sLgXcBQsp2oZ1KWtySKV4OmC8Iilis85E8iIYF8LLhhwoUTBeoEMlyyhwdlToNa5JqVXBZtNr6Tu6cHR/1owsW4w8KEUPS0SJnjoEycflqDvLOFKsai3rUQurW5ZhErEsUIy4WuwwSiHoQUTMDTPREKVefXX18D6J5RT5lkKqsAVL09P8Web2Zt/wVJNIFU4SvM85qE+pJMvEqc8NYlmsy8sVHhOAo9UcUOgOp+GIo8/pE1vS+MHSHzcOVwXcUy4MQLLzYzFWbqQiPGm7jcalbD+fMnChzzjRl/bJEep4QllorOsUHojs46E5UJDF47bEn6kkoSCUYAEmYssIQAG9o1LhUqpliEAdp9ANfcwlYFQ1ZJrjfOGCfR2nSuOahk6FsO44irGV5WhX6hsMK7rEmaiwnGPyjo/BnQFy5BzQCCP0fDQ+nCmpvhpn0b4oXoot2yT0RBvG7H87ZT8HrZGZHRZgT76TBjA8QpCGnRpK08dO+FkvWpr9MDF3stBdbD3okXw+g73kyu0GhqGABWNeVGkKaJ329D1vmGW5IVil+mqaUDnZoywdMVFliZoN55GyOOSCebbLNCRbXZB4/hmroPHEfiojrVd6+gDYqqQndZBwRatCvfBcF5KfzEDQwgwwtSMGKCPforGssPk0DFe8FbUoddvWpxHVJMMFEtQEtZ2AqmiPEUkJnQBurYzt44BnvxD8E5rv48SLM8kB7yv9+Oqzky1liDkHBuORw0vHh6CeYtYfzXBlYaQxT9VhWzbikFAQeckGGA50QFbE8jhBTpxnPINROaoEYpeC1Ba5HkmcBBO6Fsft+ivqECgye/aq3na7yFvAilvDf942ll2gBHfwSztQQiqFaYSOLgVx2xktjbxqlTVL2ywGPTIsy9FvoY07Rk8CuMv8HElwyxiz54POgLAnUOf9gbpnC8Kkxc24ejMnMmsEBDKwa6z0AZYSEJ9P7G1034cLvICfxKe8gSP87S3O0y8etnQ2HWRzACbkPz+Nr6XjjfQl0VWm/P7kVTPD6WasMTa2/cQHiZZAXoGwmY/TFLf8TeHcYBLEQEeDqkQFNNnDrBqsbN6GAuGOB/JR7BPP+bpA1Qqkuitq5S5hbiHkrYslkYRRxI0Hm8hpBkVIGekMwSzKRs62PNBCSbOcQl5YGuw97jAdJALCfypHRwDliN6uc12Qr9dsXQBJc/Zy9PXf+vt950RBWLhA3pOmbMQMt+w8t9hIRWkmnaCBGbA4cVxQ5Fbzh1Yc+XK72CQ8sdheYnbtaiDPHJI1CHMQ3oOm4EHKIBtECMEZtdQOWR5DuJDwUqMemGv6ekUhIhQWhCsSGMO9RYI5ljv8kvnW74I8QcbnJvEvM1/lsLhvL4CF910qvAS9JrkmLps6dVL+o1eqVT3efTTaOH+pDAESoIQI8TPIFgeniMsDSFjjvM5GB5fsas6lI6Fz10GkMW0s0iKmPpHbPFUS1QsWz1ARxjDG0hQabo2VTcOSM0f1cwBGFJkE97u8ll+sYKSDvXitsKkSkn/bwucZjLrqeQwjG2nsMPaUewICmEhsKQEn2DOr6zf3SnuiE4m1dMi7O9ylGlhzd8a+nULMNMHZJzBfwwE2kvJMzLVrotF0x4+gnWASvDZVk7mtXFu+DyHAzKTZwWPI/tWP781Q17K08hUHQHsfZn9sZlkt3ePJtkUIhP6ydFxj4ZMR/r6Ywk0XXOVzAJBCQGrFayVDz0UbYazCaOyvWpwCjyfXF6M7m4/T+6vP9/c38HI1ejt5e14eP358t/jEYzCq9vxzd3nyeX51fDd8G50c90lSkmwPQzdVmjEYo+u2BtUT2slDhNmVLJR0qUSE+br4zPI9RnV5sTlWPDVtsrccN3YRnOiMx+SpfHaNybXwgjB81qTc+bWyAKZ7vleQfq207EeX7fXub0o08Rmf5H8xlJsRmNxA/qLQCJX7oiern56xJTzPV1olAUI9pyPaMxc63rKtBmrtNWWT7MifIA0EHd6fnzb5qL616Bg+5sY/sp3UqdO/YhDdbZiwvUavU591XgYmHaGkXnC5vu5mfgKKuNuSdwPuThwPxkR3Vcua8mpfHV2cpKs+0Yr6N0Wsv6G/gfeQLxHHA1C1x2YGu0ZBut+uUIBjg/IeRknbBkt0Y1qArs8qJnS4f2qQd+aEeJ3uN1Go1djqyVuxFkRldhram5Abks+6aPUesmyRcyMPgpRPXwGuQQt//ZD3FoHEvYVwG4bb1ODaND3ToGBFvwzpDB7wR3dryHk/hk66OR9Mvj/VZtKxk4VOzpmjWJGK8nM7jSnaSH74FdV/wXKzAp0GP1HyFBfAEDIO0gTZvgtwNqFzJKywyEM4D0DODTl09madgXeGR+XtHWJXDHT8X3keA9Ut/AdqPSoh1sI/R9jZtMc9HjdlR96EqklVTpWlR1rLn2Lu0xytdYoyYtZzEPPiRq96bdDvZjrhsDe0PlhyeAEaraNn/zMXjptddtBzauW+PWofl5LHsH/A6i957ARj7la2wSUzGMKRTIE8ClGcDCQLSbMxiYgRGxOi1hBKQV124qzR7mnHQqxP7qBhMC1RRq9986ZDjfvh1cjTKBG1+apBQEDlwE2Pm+bgZYQeE6xaUCmes8pdjWnlsAUnCrTGUr5xpSwVMos5Dot8PFCBWzMYuYq2M4ctPHpHZNdYqdrQPEUCgAe+YiqYnVjqBXvuodvrHcBMfo7sqj9LW68BGDe8LRfEgQ0FIBWFm1l9K3Z7tiuuVUsHxyQxdc1+HuR0LSPwNFtNKdKM2nm0glb/BHHIaAeyJn0WWA1coiSqo8o+wRpuplm1SdUkVf8eF9P/FRI1z3ORDEqex+JdbKMk9wmtmszY63hqd6c/G8S6V39g85PYrqg7fgeZnLCrsLjwniazuE10ORh1/AImBV5Ftc6Zt6c49t3/tFfoabdR7quqFLWBeZciL4/Ue+Ed/UbjSHj2Ou2uxlvaDSBVAMSmOCIOxp+duKsbG9C0l1Ue4xrZzaxV0pKxl+1XCpx93xImin9eeDROs7Xp6+b068z9RawHvUabUSITLjDHEfRf5fjw/EIB6GWQchHZdZcFjODP6vK9H0KcFcQmnWIfMMguIhhgW39j58wuiWQKGR4QSrP9MnrW05nwYm933XyVN7H2JzE1Z0pycTKXZgqsFUQLJXKsYKiOR/odGtgkq0Bb7mKoEfI2H7eJibhBjXrgOs4vtUVmxbf57vUAFIM7C0lbYt6EvZ39MNbZ3BfHpVWE3cdN6suywWS3ccgisshYbKTdS0Y6rPeFt4X2XY5Ndl/VgPow8wnUxh7Mfj1L4NTneSB+iH24Jb2Cpi5sUbQgB1CvUtrteK9RN+f5/6dPSX8e5LHUDrrvrBpKxmUVbcIe8GZf9+uBBqgYYm4hKlPT9g6uRfxZoOvzW04hJ8zy+BsDtlT/UOZr5qfeVeuVdoHBizW7vLZABZoqLsPdkcK8svE+pDnzQZwywXEVt5cQE/XPlOO5+o0Np+wFICMCAs34NKMYzWSK29lw+dtOZfxzS12Mem2AdcM1k/it9mCs9cz7rIHlsL5Oy4V/kcON5s/APmk5cY= +api: eJzdWltv2zoS/isEX3oKyE56wWJhYLHrJuk5xqaJESftAkVQ09LYZiORKkk59Qb+74shRYmW5Eu2LfZgnyyLlxnOfHMVn6hhC00Hn6k2RcKlpvcRTUDHiueGS0EH9OK7AZFoYpZAUj4HnTNB5Nz+X/AVCDKxS4kGrbkUZHTeJ8M8B5GQ6d8fpXrQOYthlPxtSowkYLdr7cb8LlwQRqpVJJbCwHfTpxGVOSiGTI2Siq1zZphbeFluRiOaM8UyMKDwYE9UsAzogJbsjRIaUY4Hy5lZ0uZpG2fRRnGxIDwBYficg0JGFHwruIKEDowqIKI6XkLG6OCJmnVuSdlVdLOJKuqBHDz9bwWodYuBT9XRRZGB4nFInHxagiAy48ZAEm0LketStpCgEHGs0KBCCbYY5cLAAhSN6FyqjBn36i9v6WZzj+fUuRQaNK54fXqKP9vMXv+TRtQSEAZHWZ6nPLZKOvmqccpTm6icfYXYoJ4UqtRwR6DWT0uQz1fSJtqS+BEnfp4eroo0JdwZQcnNDFIpFhox3pb9xqIShDlbQvyQS+7ktU1yJBxPeCY2k4WxG7l1JK4WOrpce8KPTJNYATOQkLmSGWGCwHeuDQqlXoYA2K+Beu5xIttEwZIri/OWCUT79Iqj9gw7Fm8iarhJ8VVt6OdG9sdNWW4iigLHPWrr/EzZihmGnEPGeIqGh9aHMy3F+0MS4cfKodqy64yOeNdIyd/ek99pUIiMXVZgVS+VAxyvIWRBJzp52rETTrartkaPXBy87NeKvVMdB2/ucHdziVbD4hi0izOqEALRu23odt9YZnlh4EKs2gZ05sYIiBVXUmRoN4FEyOMSFIQ2qwqhu+yCpen13AaPZ+CjVmu31NEHpMwgO52DChadAg/BcFad/nx2biTFCNMwYgXWT7FU7zA5dIznvBN16PXbFhcQtSSpgQxPAl0aEIZxgUjM2AKIn7mlhrlUoRICbR32UQpyqbmRan0YV01m6rUEIefZ8DxaePH4GMyXiA1XE1zpCJX4Z6bQXVuBKDJ0TgpimWU2YFsCuYIYnThO+Z6D4igRhl6rELrIc6lw8D6i33u4RW/FFAJN/9BebW1/BIXGNnH8o7alPMKIb6VMrQchKNZ1DiRXcsUxG5mtXbyqRPUb9Bf9iLz4WuRrA+pFRF4o5y/wcaVjmcCLl/0dAeDWo896AzHni8LlhW04ejMHLQsVA2FpKuMywIpky09s7XQYh4u8wJ+MC56hOk+j/WHizeuWxK6KbAYKk9/fx3fa8waJR1aX8/uZVM+OpZpBVtrbjxAeZrIQBgm7/TBJ/cDfHccBLkUEBDhkSjFMn7mBrMPOmmGMDnE+kk+YYb2UiwcyOtfEbl2nzB3EA5R0ZbEsSTiSYOl4CyHtqFCkKZshmF3ZsIO9EJQrpjguIQ+w7q1YWmA6yJUmGswejmMpEnaxzXbGvl+CWJglHbw+ffvX6LDvTBjJWfyAnlPnEPN5mdlbxxkX2sjMT9CEC21YmrYEueXcNxH15cofslD652F5idt1iIM88jTFME9mMJcKCCuMxDAUszRdE21knnOx6JMhceKVczI9nRIuEjwtaFKIlGccEeJZ3+WXzrZ8EeKPGThziXmX/6wOh/N6hmfQdqo8A21YlmPqsiXXIOl3cmXa3OXJL6OF+5PCEagITgxTv4JgpTxPWDtCzhznc4gNX8FlE0rPhc+tNCzFtLPIipSFKi7x1EhUSrYiwkWcFgkmqEysXdWNA9ryxyxzZ1IIZFMKvc9nhcUKnnRoF3cVJnVK+n9b4LST2UAkx2FsO4UdNlSxJyjEhcKSMl0Tp7+qfvda3BOdXKpnj3C4y1GlhQ1/6+g3LcBN75Ox1JpjILBeSg/I1LouSKYRPjKFxT4+l5WTe+2cGz7PGU/d5FnB06R8a5/fu6Eg5Wllqp4A9r7c/thMKrf3jy7ZVEoq++Tp+EdHZkf6+nMJtF1zncxmoDVbdMO49qHHos1xdgNMd1cNXoBnNxfno9vJl5u7qy/Xd7c0opej9xeT8fDqy8W/xqObi3Ma0cn4+vbLzcXZ5fDD8HZ0fbXrKBXB7jA0qdGIxR5bwTsUT2clvonojGkYZbtE4sJ8c3wmZQrMmhPXY8VX2yLzw01jG82JzXyIFOk6NCbfwoiZ8Cbnza2VBYLt+V5y8bDXsT6/bm9ye16lie3+IvkdBDajsbhhGhIihS93VGSrn4i4cj6yhUZVgGDP+RmNmStbT7k2Y522luXTrIgfwNia6+Xz2zbn9b8WhbK/ieGveqdt6tRLuI7lCpTvNQad+rrx0HftDHfmG5gf5uYmFFAVdyviYcjFgbubEbF95aqWnOo3g5OTbN1zUkHvttDNN+zfg5MTFseIo37suwNTJz3HYNMv1yjA8T45q+JEWUZrdKOWwD4P6qbs8H71YGjNCPFb3G5j0Wux1RE3UlkkFfbakuuTScUne9RWLlIuUnDyKFT98AWEUaz624txaxtI4BsoVjbepg7RU/1m74HZo6YRdaQwe8Ed/a8j5P85OujkQzL4/02XSMZeFHs6Zq1ixgrJzd5pTtNC94Bp03uFZ4YCHUbvEbR5NX3ZJx/YmszwW0BpF1pmVYdDOcAHBnBsymezNesKAh0/L2nbdeSamR3fR57vgZoWvgeVAfV4C6H/Y8xs2oMBr/vyw+BEZsmMjVVVx5rr0OIustysLUryYpbyOHCiTm727dAu5rYhcDB0flqCWULDtvGTn9vLpq1+O/LIzRK/HjX1teRJAuIIah+55jOecrMuE1AyT9miT0ZzMsUIPo22mXAbu4CQwJwVqSEp14asODzqA+1QBSy5Funat0VavfedMz1uPg4vR5hAja7cUwcC+j4DbH3edgMdIfCMYdOATO2eU+xqTksC0z6ZgM1QqjeuhGVay5jbtCDEC1NAEkjBV7A7c9DWp3dMdkk53QKKixVLeRIiqo7VraFOvNsevrPehQL9A1nU4RY3XgJwb7joVQQjqos4Bki2MvrObHdcrpkYyPtHZPFNCf5RZEz0EDi2jeZF6SbNfDpRFn/Ec0g0knPps8Jq5Bgh1R9RDh2k7WbaVZ8yRV7zE3w9CVMhW/d4E8WoHHwktskyTvKblF2bGXSGp2Zz8r9JpPf1D3Z+ErMF7Y7vYS4n3FV4nDtPs3N4LVjG413DI2FA5TJtdMyCOc9v34Wqv0RJ+490u6JKVRc4vRB7f6LZCd/Vb3SGjGNvu+5mvGPJDXwrQJvn3NEIsxNvZQcTkt1FdcC4dWY35ZWSivE3HZdK/D0fIqSxnwceS8f59vRte/qVNO9lIZKo1Ubk2u4wx1H039X4cDzCwYRrhHxSZc1VMdP/s4rM3qeIC8XN2obId8AUqGGBbf3P9xjdMjBLiRekcmk1b285DehJeb/r5Km6j7E5Ses7UxrUyl+YKrBVQJfG5FhBsZz3bbrVd8lWn3dcRbAjZFx+3iYu4R6ORzbgeo4ntmKzxw/5riSAFP0tJWuLdhL2d+zDe29wXx+NFRP3HbdSXCUXSPYQg3hcHoMuJ9taMLa63j58eOSyy2nJ/qMeQB/mPpnSAX3Vf3X6un9qszypTcYsVso7YO7KGkEL9hANbq01qvcKfn+eC3ilmvDvSZ4ybr1k4fpKDmb1NcKIDsILdxXS7iO6RGAOPtOnJ+yd3Kl0s8HX7joc4s/bJR3MWaqbX8pC0fzKy3Kdp32AdesyXxnBqMW6/2L3zIP8dlM6kZftDnDHDcRO3nxEF+uQKc9zrY3NPdYCwGzl9vmpHMdyJDfBypbT2/Iu4+sJtjHZtgU3LDbM4rfZenpyM27lA4jNpuLS4H/kcLP5DzZ35es= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Extends the lifespan of the given Studio session ID. Append `?workspaceId=` to e id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/find-data-studios-workspace-settings.ParamsDetails.json b/platform-api-docs/docs/find-data-studios-workspace-settings.ParamsDetails.json new file mode 100644 index 000000000..92b9288dd --- /dev/null +++ b/platform-api-docs/docs/find-data-studios-workspace-settings.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/find-data-studios-workspace-settings.RequestSchema.json b/platform-api-docs/docs/find-data-studios-workspace-settings.RequestSchema.json new file mode 100644 index 000000000..eccf3cbfe --- /dev/null +++ b/platform-api-docs/docs/find-data-studios-workspace-settings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Workspace update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"description":{"type":"string"},"visibility":{"type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"}},"title":"UpdateWorkspaceRequest"}}}}} diff --git a/platform-api-docs/docs/find-data-studios-workspace-settings.StatusCodes.json b/platform-api-docs/docs/find-data-studios-workspace-settings.StatusCodes.json new file mode 100644 index 000000000..7f9963d69 --- /dev/null +++ b/platform-api-docs/docs/find-data-studios-workspace-settings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"integer","format":"int64"},"wspId":{"type":"integer","format":"int64"},"lifespanHours":{"type":"integer","format":"int32"},"containerRepository":{"type":"string","nullable":true,"description":"Custom container repository for Studios in this workspace. Can be `null`."}},"title":"DataStudioWorkspaceSettingsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx b/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx index 0e061822c..3ed38f5a6 100644 --- a/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx +++ b/platform-api-docs/docs/find-data-studios-workspace-settings.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the Studios configuration settings for the workspace ide sidebar_label: "Describe workspace Studios settings" hide_title: true hide_table_of_contents: true -api: eJzVVttuGzcQ/RWCTw2gat0kLRA9RbaVxijQGJKTPggGTO2OVrQpckNypSiL/ffOcK+6xDaMFmhfhNVwOJczM4dTcC9Sx0dzvjX2wWUiBsdvBzwBF1uZeWk0H/EpeCthA475FbCZzxNpHIuNXso0t4K0mAPvpU4dWxob1FqDTCagvVxKSNhiF85SuQHN7lqVq+Ru2NptLaEDb41iCSxFrjzbCJVD5aDRldp5oTFoFlsQHj1IjR6k69wP+YCbDKowrxJM54PUyaXwojbyV6M5qx3jhUxYsQYPlrApuMY/eNHYFA0MuCRQMuFX/BCpTzYVWn6vINH5GqyMu/wtxWLhay4tYCDe5jDgLl7BWvBRwf0uIy9Se0jBoipmuha+Ev32lpfloA2lB92jAbXJ/QvR3FbXwflzk+zozo9851mCxWG1Ntqi0mIYdEdkmZJxQCy6d3SxOI7CLO4hpouZpVp6iW06asBotRy2qU55ibHmSv35o8O9KE+cb6STC6mk3x0fDzggkDQw19OrL+ObCUpmH8fTySWNjZdekfKXzgIWrRV/DjC0sExrOMqSlCy4zGhXJfb67OwYz09//HPIVa38nDIP+NZlz9ZVcol5CP3R5NY9eefNa7pDKQmpwU4hM056Y08Cr7GmYkFAVq26D85F7rxZs9YWNltj7IAxDvmBXQjNFsDuyMHdcK9iHU0cscS0rlddvrenKnYukpc0fTeUc74G50QKobserWijeNzRvXwm1hp7FPmbE73WMCbTxjOhlNliPEH73bH2ZV6lAwwUrCnH/2i2eOggzm2YbST2cxAW7DhH5hzNb4nRkPVXhl6JFIJXItURj3BeXFSEqSmj7q2Mih4Rl1HzdEWu6jZO7uymeUZyq9DWyvvMjaJIZHIYK5MnQwdfEe2hNEf0PQsn7FoJT3PDLkifja+vOMXapDIjLCtc+gm10JBHXnM7/V8EJZRUHx+aibzf+oAf1WjaMfvkm1hnCjrC7Way49lOtp9BK+6zakueJb1dSxNirYtWp0w5PoUGYSvp8a+Uw+zHoeP2ke7ji00nVWCfpXnfHRDtY5kqP78M3/06PCMZUohfC91L/TJEtOjvN4eLy2HcRTcL//9Vqm4pD998lCmkWoIpwF3UwzKnx4VAGDX7Um+3ROn+6tIDrRka7OwV4k6WimIhHHy2qixJjC1Jb8McPzfCyuo1wMFKpKNvHNulUO7wbejj/9O0ZptX7Bm72slka6HQO+pqAhL/4ecD7NodkTa1FwX11L72goj6eJe3qL4CkeD4E3CVxkUVyc83ZKezcETblFV1YxzHkPlHdftc+vvkhtim3hLXJqErVmxpAcXfEKwJwAQSC7KCK6HTPJA8r0wSN4l9ajugspDUSTiwk4LGjXkAjd3UoOPpP+FSln8DGRaRpg== +api: eJzVVttu4zYQ/RVinlpAtbPZRYHqqbltNyjQDZzs9sEwEFoay0woUiFH9rqC/r0YSpbkyyZB0ALtm0QO53Jm5sxUQDLzEE9hbd2jL2SCHmYRpOgTpwpS1kAMEySncIVe0BLFLZWpsl4k1ixUVjrJUsIjkTKZFwvrglinUKgUDamFwlTMN+EuUys04r4TuU7vR53eTlNiDTmrRYoLWWoSK6lLbAxsZZXxJE2CXiQOJWEqlBG0VL43P4IIbIGNm9cpxPBRmfRSkmyV/LmVvG0NQwSFdDJHQsfYVGBkjhCDddl1ChEoBqWQtIR9pD67TBr1VwOJKXN0Kunjd+yLw6dSOUwhJldiBD5ZYi4hroA2BVtRhjBDBxEsrMslNUc/f4C6jjpXBtA961AX3L/gzax5jp7ObbrhN9+zXRapJBStNETAqUVD/EYWhVZJQGz84PlhdeiFnT9gwg8Lx7kkhZ5vGzA6KU9OmQzqCBal1n9873LHyyP3K+XVXGlFm8PrCNCUOTfMzeT669ndFURw++lscnXJbUOKNAt/7TXUdX/8JcDQwTJp4ahrFnLoC2t8E9jpyckhnp9//+eQa0r5NWmOYO2LV8tqtUBfSPPJls6/+Ob9Kb/hkKQy6CZYWK/IuqPAm1JrOWcgm1LdBeei9GRz0ekSrlO2xxj7/CAupBFzFPds4H60k7GeJg5YYtLmq03fh2MZO5fpW4q+b8op5Oi9zDBU17MZ3QoeVvQgnivnrDvw/P2RWtsypjCWhNTarjGFIP3LofRl2YSDAjXmHON/NNo6Ao9J6UJvTys4R+nQnZW0hHg6Y0bLkZaWp0SGwSqTagxj6zI/rkLX1ON+Vo6rARHX4+3oGvum2oDNudV2jJROQwxLosLH47Es1CjRtkxHHp/QyZGyB/R9G27EjZbEfSMuWF6c3VwD+7oN5ZaxbHAZBtRBwxah5Xb+nwchiNqPj9uOfFhTwI9zNOmZ/eqbzAuNPeH2PdnzbH+2G0F3PGTVjjxrnl0LG3xtk9aGzDG+hAZjq3j4N8Kh95NQcbtID/HFXCod2Gdhf+0vmPbR+cbOu9G7k9PRCR8W1lMuzSD2y+DSfLjg7G8u+45XfTP8/3eptqYIv9G40FIZhingXbXdMuXpwiDE24VpsFxGEO/uLgPQtl0zi2BpPbGmqppLj1+crms+fiqRh8N0FsFKOtWMg2kFqfL8nUK8kNrvD4ch/j9MWrr5UbxiWTsabHsozYbLmoGEGCCCR9x0SyKvam9y6qWF7Q0eDfGuZ3UES5QpugBcI3HRePLTHevpNRzwNkfVvDhLEizoWdkhmf52dcd0066JuU35iZNr3kDlunHWBmACi4WzCrQ0WRlYHhqVTE5yl9v2uCwEdRSOqmok7uwjmrru0CH+Z1zq+m/ddJHL sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the Studios configuration settings for the workspace identified by the id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/finish-data-link-upload-1.api.mdx b/platform-api-docs/docs/finish-data-link-upload-1.api.mdx deleted file mode 100644 index 9a56668da..000000000 --- a/platform-api-docs/docs/finish-data-link-upload-1.api.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: finish-data-link-upload-1 -title: "Finish data-link file upload to given path" -description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." -sidebar_label: "Finish data-link file upload to given path" -hide_title: true -hide_table_of_contents: true -api: eJztV8luIzcQ/RWCpzEgSxrbCRABAeIVMDDxCF4wB0OIqG62mjZFtkm2NRqhgXxEvjBfkiqyNy2RbJ9yCDDwqMliLa8eq4pL6tjU0sEjjZljh1KoZ0tHHRpzGxmROaEVHdAroYRNSZ5JzWKiE8JILU4SIXmH2IxHIlkINYVNXCIZcyn5NI6FGcKv8UGX3KfCEvineMStZWZBEm3I6bc7cnfcKLRw6AI+vsDvodGvIubmVza34wPiNKhWTIofHKzYPEI9SS6DweBeh4BONtHGEaYql0WCH9wY2JszS7iKdK4cNzwm87Q53HI/t/6jVvFw+4UkRs+ISzkZ98LqGDTFmRbKdWmH6owbhpBdxzVoVSQPXv6PzyCWMcNmHIwj7kuq4APE41IQznaoQNQRQLqeiosad+sMegjwKCcSwQ3IGv6SCwiKDpzJeYfaKOUzRgdL6hYZWgmHaFF0GsMhQTutogCij7HDjoMk4A6Bszxy2iw+aDsCeXSfSdvE/ZJzr3DVhfNGdGvobzE31+bZZizi+4x9qwSJymfciGiPLSAAn/otYPSMubD08wlYHwVkALQzHS/wTKRBWjn8ybJMishj2XuyaHq5qVxPngBkJI5BhjnBLe4GBiLV1kNejyZwj1xfEGatmCpPeq4IEBTwdAjlLJdOHAIzXcX35mp2ydeJYwKP7bgAxHCbaWV5lxYAA1yhGw/6PudQCksKag060Q4c93pCdap1MGMYZks4PrP7IcJ4bvLZBDKzL1fHR2iO37PpVgpRJ5zkNZaX4BfKr4Zyit5hLJegxjZgI5ScRSnx+E4WdcnLPY2byAm4jyWtSy5RHNVgvTTc5QYVCeWFK6RJygEtY0M22xXMGyrva2b4YekI1DC7u4hBTHPh0kuslC0gJlpLztRG8q4keqhiz2GwDI6AZtMOqV1qqxrcJdcJGWOZGHfasnMhJZnwUL55HMQSuPH/IhfpWSY5Sq7kqKq5oQL/jtQeAiAhdbfhMsKBYr1m+YUArafPUb+P/23rhetlnYBsnReA6YN3vPBeHfWPNu3eaFIpBZGTba6dNdG9w4MGg0c6w7485TgB7L5ZleDOu+JZdFuBEmI76R9vOv61apxEaWjbUuo5+OOlT7Yh4a6AUjH5+8+/SF3Sse232onXlKBYh5wOr6FTWTaR5WVEKtUH/cDQjDPw4SeX+vx/FUvYtDyCEuIWfo4448xwc5pD+x48jrDvwJCRahxFMu0p4Vv7gPaaUau3bMaOoiwHvcQzHLbCYFBgw+PmtZpXciNBSepcZge9HstEN5I6j7uWv0AWu0JvVIk7v0OGkjksueQc5TErFL2sgrhDFAMi7VBqUNBi1Xt9TfJCsBJ+XFXF/GnuPHKYndum815+Z1gsVjtn05SahtWslaPxah/pV12iztJopWaWhUSoRHvny/yVGGDQ++BBsAW0gVIYycciT75V6NuAA/+E9J0s0b81G+AI5i3Y+dz95aduH9eQDzPmuVtORuWEvzrVV+UWGslUvEKL2TYbtuaZ/98Jb3snlIR2/LvrZRImK8yJz+2yvKMrz7EOHaw8DoJKz1mE2++XMzxQMcW7DgqWywmz/MHIosDlMOcimatKSAe+s+5I576Re2scz3yxZbB/ZTJHWYrT+Ns92DOH73BgddRvzI/wwwi0/040Pt2Wxf2A7H6EbfWqGmDVou1O5W0rv+8DqOXUW95oH3GtpFYxAtEwcHrgwu558OTwHnU0pze6JEYVTpzCZczcTtl26xp+vbvHGl++nWY6xjOGzfHFCX+9p9oj41uHX1tSydQ0902VBp3YEdhqQ1lrID6qrVjAVfIS9/qZq6KooXH4jcAUxT9jmARC -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/finish-data-link-upload-with-path.ParamsDetails.json b/platform-api-docs/docs/finish-data-link-upload-with-path.ParamsDetails.json new file mode 100644 index 000000000..3adf09021 --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload-with-path.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier","required":true,"schema":{"type":"string"}},{"name":"dirPath","in":"path","description":"Path to the destination directory","required":true,"schema":{"type":"string"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/finish-data-link-upload-with-path.RequestSchema.json b/platform-api-docs/docs/finish-data-link-upload-with-path.RequestSchema.json new file mode 100644 index 000000000..e936cee81 --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload-with-path.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","description":"Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the `/upload` endpoint response."},"fileName":{"type":"string","description":"Name of the uploaded file."},"tags":{"type":"array","items":{"type":"object","properties":{"partNumber":{"type":"integer","format":"int32"},"eTag":{"type":"string"}},"title":"UploadEtag"},"description":"Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the `/upload` endpoint."},"withError":{"type":"boolean","description":"Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed."}},"title":"DataLinkFinishMultiPartUploadRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/finish-data-link-upload-with-path.StatusCodes.json b/platform-api-docs/docs/finish-data-link-upload-with-path.StatusCodes.json new file mode 100644 index 000000000..34fb7e3c2 --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload-with-path.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"FinishDataLinkUploadWithPath 200 response.","content":{"application/json":{"schema":{"type":"object"}}}},"202":{"description":"No content"},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/finish-data-link-upload-with-path.api.mdx b/platform-api-docs/docs/finish-data-link-upload-with-path.api.mdx new file mode 100644 index 000000000..8d4c673de --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload-with-path.api.mdx @@ -0,0 +1,66 @@ +--- +id: finish-data-link-upload-with-path +title: "Finish data-link file upload to given path" +description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." +sidebar_label: "Finish data-link file upload to given path" +hide_title: true +hide_table_of_contents: true +api: eJztV81u2zgQfpUBTy2g2G4a7MHAApumCRCg2wb5QQ+BAY+lkcVGIlWSius1BOxD7BPukyyGlCyp8dpJTnvYky1yOD/fDL8ZboTDpRXTe5Ggw6NcqgcrZpFIyMZGlk5qJabiQippM6jKXGMCOgWErTikMqcIbEmxTNdSLQH9EpToMngzT6S5QpfN347gNpMWpAVFMVmLZg2pNnD69QZu3ncKLbyZf0SHn6R6uDL6USZkfsWVnb8FpyGVCnP5BwGCrWLWk1Z5MBjci0AbwIU2DlC1LsuUP8gYbWCFFkjFulKODCWwyrrDPfcr6z+2Ku6uP0FqdAEuI5iPw+ocSCWllsqNRCR0SQYZsstkC1obyZ2X/ypdxmiISJRosCBHhtHfCIUFianPAotfJiISkrEvg/gwIR+36Ftn2E+ZkHIylWREJAx9r6ShREydqSgSNs6oQDHdCLcu2Uo4JOo66gyHNO21ygKcA0YgIeuk8tFCIg3FTpv1K23Hhrz7mNsu7u8VeYVDF8460Z2hP8fcSpsHW2JMh4x9bQVBVQUZGR+wJZWjpd9KtSnQhaVfTkRdzwIyZN0Hnaz5TKyVI+X4L5ZlLmOP5fibZdObp8r14hvFjgvHcJ05SZZ3Qx1ywf0c8s/RhAqEy4+A1sql8qVPCqSSTqJjKIsqd/KoROPaqu8u6Ai+LBxKPrbnGoAhW2plaSTqSPBF+uxBP+QcSzGxsNagk+3IPOgJHLXVgcYgZ0s6KuxhiDiez1WxIHMwV++P2Rzd4nJnCQknXU5bLM8dLll+GMope8exnN/i0nZgM5SEcQYe38V6S3yVL+MuciiNZmIbwTmLsxpmTUOuMqxIKi/cIg0ZYULGhmz2ecwbau5raeioceTu+pPdT2V1JFbSZefMlz0gFlrnhOpJ8i5y9lAlvobVkh1xGZl+SH3CbZl4BJcpzJkm5lFfdiXzHBYUSJySIJZibv9FLtZFmRNLDnLUMm/g4d+5tK/QuJC663AZRc0nhpzlFwK0vnyOJxP+2dURd5M7HE8mvXsQvfaq196548nxU/OfNbRK60ic7PLwQxfkCzzooLgXBTfpJfE4sP+CtYJ7r4wvpusGlSa2k8n7p45/absoKO0A81yvKAlhnuxCwl3oSiXw959/wZbZeQbodRWvKWWxCE6vLiGRFhd5cye5orYH/fTQzTbahDFme/6/imUdCUtxZaRb+3HiA6Ehc1q5TEzvZ9x+CnKZ5rmk1L4kfIefinE3d4033fRRN6wwTn2hjzfNfFBz3yPz2I4tlcnFVGTOlXY6HmMpR3Guq2Rk6TsZHEn9hCxu/A5c5eiYeeGM5Tkrgr1sg7hhFAMi/VC2oLDFtgV7avJCImr+XLSc/m3lPHKcneuuAZ//QOaMYQPtelPXt7q1Zk4etpNJ2yy2WZoNqLPhE6lS7Z1v8tdgwEEfgofBljHZRpiLD2NffEPo+4BTgTL3DS3Vv3UbdSQ4b8HOu9G7yfFowotcEAX64m0mpGbeH874Le06DUv5SAp2zYi9ueb/V8PzXg1NRTv64cZljlJxTnxyN80lHTzOIjEdPBKCSl+0DLffb2b5WSQyvuzTe7HZLNDSncnrmpfDvMvV3FKhmPoOuyedh0bvnXE80HrHgP+IecWygqfy53twYB7f48Bw5O/Mz/jDSLb/QjTeXDfs/hb2P8Z2etUOsmrdd6f1tpfflwHUc+o5b7XXuNaUVj2rIxEGTw9c2D0Lnhzdso7u9JM2yVGFE6dxTKXbK9vvXVdfbm6Z5Js3VKETPmNwxS9PXAVPtUfG9w6/thE5qmXlu6oIOrkl4LCj/NRBfFQ7sdhsgsStfiBV11toHH8zMHX9D2stCcc= +sidebar_class_name: "post api-method" +info_path: platform-api//seqera-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. + + + Request + + + + + + + + + + + + + diff --git a/platform-api-docs/docs/finish-data-link-upload.ParamsDetails.json b/platform-api-docs/docs/finish-data-link-upload.ParamsDetails.json new file mode 100644 index 000000000..5e7babb9b --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier.","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/finish-data-link-upload.RequestSchema.json b/platform-api-docs/docs/finish-data-link-upload.RequestSchema.json new file mode 100644 index 000000000..e936cee81 --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","description":"Upload ID assigned when initiating multi-part upload for AWS S3. Obtained from the `/upload` endpoint response."},"fileName":{"type":"string","description":"Name of the uploaded file."},"tags":{"type":"array","items":{"type":"object","properties":{"partNumber":{"type":"integer","format":"int32"},"eTag":{"type":"string"}},"title":"UploadEtag"},"description":"Array of ETags assigned for each part by AWS S3 during the upload process. Each ETag is returned in the response headers when uploading a part to the pre-signed URLs from the `/upload` endpoint."},"withError":{"type":"boolean","description":"Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed."}},"title":"DataLinkFinishMultiPartUploadRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/finish-data-link-upload.StatusCodes.json b/platform-api-docs/docs/finish-data-link-upload.StatusCodes.json new file mode 100644 index 000000000..37985fa57 --- /dev/null +++ b/platform-api-docs/docs/finish-data-link-upload.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"FinishDataLinkUpload 200 response","content":{"application/json":{"schema":{"type":"object"}}}},"202":{"description":"No content"},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/finish-data-link-upload.api.mdx b/platform-api-docs/docs/finish-data-link-upload.api.mdx index e41fd4ecb..dc99543ab 100644 --- a/platform-api-docs/docs/finish-data-link-upload.api.mdx +++ b/platform-api-docs/docs/finish-data-link-upload.api.mdx @@ -1,13 +1,13 @@ --- id: finish-data-link-upload -title: "Finish data-link file upload to given path" -description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." -sidebar_label: "Finish data-link file upload to given path" +title: "Finish data-link file upload" +description: "Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." +sidebar_label: "Finish data-link file upload" hide_title: true hide_table_of_contents: true -api: eJztV1trKzcQ/itCTyfg2G6SFmooNFcInCYhF85DMFje1XqVaKWNpI2PjzH0R/QX9pd0Rtpr7NpJnvpQOOR4pU9z+WY0M1pSx2aWjh5pzBzbl0I9Wzru0ZjbyIjcCa3oiF4IJWxKilxqFhOdEEZqOEmE5D1icx6JZCHUDDZxieTMpeTLJBbmBn5N9vrkPhWWwD/FI24tMwuSaEOOv92Ru8NGoIVDZ/DxFX7fGP0qYm5+Y3M72SNOg2jFpPjBQYstIpSTFDIoDOb1CMhkU20cYaoyWST4wY2BvTmzhKtIF8pxw2MyT5vDLfML6z9qEQ+3X0lidEZcyslkEFYnICnOtVCuT3tU59wwpOwyrkmrPHnweADlzLCMg2pkfUkVfAA4LmGXCBHIOdJH3wbirGbdOoP2ATnKiURwA1jDXwoBLtGRMwXvURulPGN0tKRukaOWcIiuVr1GcQjPVq0IQO7Rc9hxEALcIXCWR06bxSd1R4BH85m0jd8vBfcCuyacNtCNrr9H3VybZ5uziO9S9q0CElVk3Ihohy4IP5/5LcjnjLmw9MsRaB8HZoC0Ex0v8EykAa0c/mR5LkXkuRw8WVS9XBeup09AMiaOwfxyglvcDfmHifbW5bfehMwjl2eEWStmyqc8VwTSE/h0SGVWSCf2ITNdle3NxeyT66ljAo9tSX9iuM21srxPV0ADXKArT/ou4xCFBQWlBpmoB457OaE21TKYMQyjJRzP7G6K0J+rIptCZHbF6vAA1fF7NtuYQtQJJ3nN5TnYhfiuK8doHfpyDmJsQzZSyVmUEs/vdFEXvMKnceM5AfOxoPXJOcJRDFZLw11hUJBQHlwxTVIObBkbotmuX15ReV9zw/dLQ6CC2e0lDHyaC5eeY51sETHVWnKm1oJ3IdFCFfscBs1gCEg2bZfahbaqwH1ymZAJlolJr42dCynJlIfizeMAS+DG/wsu0lkuOSI7Maoqbqi/f2Bq3wAhIXS34TLCgdXbmuUXArU+fQ6GQ/xvUyfsFnUCyDoqQNInb/jK23QwPFjXeqVJJRQgR5sMO2l8+4AFDQOPNMOePOPY/bffqwq49ab4HLqtSAm+HQ0P1w2/rpomURpatpR6DvZ49NEmJtwFJFRM/v7zL1IXdGz5rWbiJSUI65Hjm0voU5ZNZXkVMZHqg35YaEYZ+PBTS33+v8olbFoeQQFxCz9FnHBmuDkuoHmPHsfYdWDESDWOIbn2KeEb+4gOmjFrsGyGjlVZDAaJz29scty8VjNKYSQcTZ3L7WgwYLnoR1IXcd/yF4hdX+i1ynDnd8iNZA7LLDlFPMaCom2V6XfIXeCh7UBNBWqs+q2vQx4EK+HHRVXAn+bO84UxuW267fl3hgWi2y2bRtQ0qWatHIa7vWNYdYY6NuNOnSyLh1CJ9saXUSs5QKd30YNkCyj9JRhTjkU+5brUtwmHrBPSd69E/95sgCEYt6Dnp/6vP/eHuIZZkDGfseU0VM703Tm+KrHQPGbiFdrKpnmwNcP8/zJ438ugTGjHv7tBLmGawpj42C7Lm9l5gPXoqPMgKKrHQ3k9If9SvNZwarmcMssfjFytcDkMtJjBVdGjI99Ct8Rw12y90fhnvtgwwb8yWSCW4tj9fgt2DNxbDOjO9I36MX4Ygfo/yMaX27KO75Htr62NVlWTqlq0zamsbQX1YwS1jHrPY+wzppXvwNUYoGGy9MSF3dNgyf49ymhOrzVE9CqcOIYbmLut2HaXurm+u8fCXj6SMh3jGcPm+LSEv95S7Znx/cKvLalkalb4/kmDTGwDrNtF3nQN79VGLuAqecS9fuYKrlNFjcNvJGa1+gcs8vuq +api: eJztV81u20YQfpXBnhKAlhTH6EFAgTqJDRhIE8M/yMEQ4BE5FDde7jK7yyiqQCAP0SfskxSzyx/JUqWkpx56kricnZ9vZr4ZroXHhRPTB5GhxxMl9ZMTs0Rk5FIrKy+NFlNxKbV0BdSVMpiByQGhF4dcKhrBXSEdSAeaUnIO7QpyY+H80y3cvh6EHbx4fIce30v9dG3NV5mR/RWX7vEleAO51KjkHwQIrk5ZT16roL81nYCxgHNjPaDu3JE5P5C1xsISHZBOTa09WcpgWQyXpV4AttpceOhV3N+8h9yaEnxB8DiOp49AOquM1H4kEmEqsshwXGU9IF0k90FeJKJCiyV5sozoWmgsSUwDsix2xSKS8azQF+I5yO96RJ237J/MSHuZS7LsgKUvtbSUiam3NSXCpQWVKKZr4VcVm4m3RNMkveXUUtCByg3Gv9RkVzvW3w6i++3/iL2lsU+uwpSOWfvUCYKuS7IyPWZMak8LsiIRubEl+nj0y5lomlnEhpx/Y7IV30mN9qQ9/8WqUjINiRt/dmx7vavczD9T6jl/ltPsJTl+G8uA8/085ufhxAKAq3eAzsmFDpVHGqSWXqJnMMtaeXlSofVd0Q39MYKPc4+Srx2oQrDkKqMdjUSTCK7jDwH1Y86xFPcsa4062Q43LeuJ7d/rQGuR0yU9le44RBzPh7qckz2aq9enbI7ucLG3hoSXXlGP5YXHBctvh3LO3nEsF3e4cAPYDCVhWkDAd77qeacOhTxEDpU1zCsjuGBxVsOkZcnXlhVJHYQ7pKEgzMi6mM1NGgmGvAnSlaWT1pH7m/fuMJM0iVhKX1wwXW0AMTdGEeqd5F0q9lBnoYb1gh3xBdnNkDb5riPCEVzl8MhE8Zhsyi6lUjCnyKGURbEclfsHudSUlSKW3MpRR3yRBn/n0r5G62PqbmIzioZvbLNWOIjQhvI5nUz4Z9+w2eZWOJ1M+qyI5N92eBN8Op2c7lr9YKBT2iTibJ9jb4bYfsKDAYEHUfJoXBAP2MN91Qke7JRQQzcdKDG2s8nrXcc/drMLtPGASpklZTHMs31I+EtT6wz++v4n9IzOk3djnARNOYslcH59BZl0OFdtK3Ih9RfDzB62hf7e6L8KYpMIR2ltpV+FKf6G0JI9r30hpg8zHjcl+cLwGlCZUAthnE/FeFhzxuth6DctC4zzUNg83ch+7XaE2ioxFYX3lZuOx1jJUapMnY0cfSGLI2l2KOE2vIFrhZ75Fd6yPCdBsG+d67eMXcRhM4AeCrbYDdpAQEFIJO2fy465Py99wItzcjOM2YtvyMywPSaHCTRMp+GsXTS3h8akGwl9bmZbBNmyhtS5Cc63WWsx4KCPwcNgy5RcK8wlh2kouW3oNwGnEqUKYys3vw0vmkRw3qKdV6NXk9PRhA+5DEoMJdsuQu3CvL0kt+T63OONfeX/RbvvaU/f/LhSKDUjHFK1bhtt61slEdOt/brHuO22WSIK7tLpg1iv5+jo3qqm4eO4mXJBduQlpmEUHsjP0S15r/dPtNqzjH9FVbOs4AX6x104tjof8GB7PR/sz/jBSnbgJ/F4cdMS80s48vmy161u6dSrTX86dzfy2syaRMRlLHgYBd5GP07uWM2gYGeUMMDxxnmaUuUPym7y+/XH2zumxPa7ojQZ37G45O8xXEZnTcAlMG04WwuFelGHySOiTiZQ3ObfZ3wbotoLx3odJe7ME+mm6dHx/MzANM3fnil9Mg== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,11 +18,12 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; @@ -31,41 +32,35 @@ import Heading from "@theme/Heading"; path={"/data-links/{dataLinkId}/upload/finish"} context={"endpoint"} > - + -Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. +Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint. + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/ga-4-gh-run-cancel.ParamsDetails.json b/platform-api-docs/docs/ga-4-gh-run-cancel.ParamsDetails.json new file mode 100644 index 000000000..bf4813a8f --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-cancel.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"run_id","in":"path","description":"Run string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/ga-4-gh-run-cancel.RequestSchema.json b/platform-api-docs/docs/ga-4-gh-run-cancel.RequestSchema.json new file mode 100644 index 000000000..6672aa144 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-cancel.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","title":"EmptyBodyRequest"}}}}} diff --git a/platform-api-docs/docs/ga-4-gh-run-cancel.StatusCodes.json b/platform-api-docs/docs/ga-4-gh-run-cancel.StatusCodes.json new file mode 100644 index 000000000..421f3d0c7 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-cancel.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"run_id":{"type":"string"}},"title":"RunId"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"status_code":{"type":"integer","format":"int32"}},"title":"WesErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx b/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx index e96f147bd..0f216d2bf 100644 --- a/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx +++ b/platform-api-docs/docs/ga-4-gh-run-cancel.api.mdx @@ -5,9 +5,9 @@ description: "Uses the GA4GH workflow execution service API to cancel the run as sidebar_label: "GA4GH: Cancel run" hide_title: true hide_table_of_contents: true -api: eJy9VMtu2zAQ/BWCpxZwrbx6qE91gjQNekjgJOghMJK1tJaYSCJDUnYMQf/eXVKO83BToCiqg0SRy93h7HBa6SF3cnQtczjICzkdyAxdapXxStdyJK8cOuELFCfjg5PvYqnt/bzUS4GPmDYcIxzahUpRjM9PhdcihTrFMmyxTS3AOZ0q8JiJpfJFmM/VAmtxS8s3KrsdyoHUBi1wttOMap4wlElTH4VUtGzAQoUeLSNtZU0/FBb307JioAZ8IV+jpyTCeavqXKgMa6/mCi1FWXxolEUq5m2DA+nSAiuQo1b6leHccZPsumkMRucPdbbiiFTXnlLxEIwpVRqAJ3eOK7ZvU+nZHaaeinrlS544roxfcbZJTExVuo7LOKNropv37u3s8Oflac5+UJa/Lm8ss+xVLNCTt+XEG6DEHvUjojvYBugQMtGz8++QVS7fAot65ME37ibVGT5bV1QzDz2da1uBj1P7ey8O8hPdsbXaTnqKn860v4XktRRFrb2AksSOWchGCiw069PocN6guJFMws1JluiSxW5CvLqkjex2SbpWMF+StXwbW9K2wnvjRkkCRg3TUjfZ0OEDlR4q/UbGF2FFnJfg+ZTiiOP5wknWp6ObaJVfXTDBkcNDBIt23DDAJ6q4ouy1zv+zEEQzcfBtzd/d0ofzcuMmG+0fP0JlmM624ys31yF1z3CPkCH9CXzvF64PZtVAGlTzkpjndJBwVBlaO9dfNwsEhFmNdXaHXz4Pd3iO+1NBEF1vFcG8RiIaCvvSa5TPrvV/sry+KR4ffWJKIA8j5IGBtlfW2pMHkrRF78UuOxfpiz6jJ/PrJUY6KFiWtKttZ+DwypZdx9PUQEvGdU3DBVgFM24YyTBTjsck6DmUDt8h5MOkt8uP4neGuvU0/STUK0YPZcN/NLzH1ca+uylFFggZ5WFYcfEoFv90ySk2m9/4SjdY7xinKRr/buz02R0+P7u4ZOn3pl4FV5EWlswxvQNQHciIfslzrSyhzhvIOTbm5OcX5G1+NQ== +api: eJy9VMFu2zgQ/RViTluAayVpTjptEqRpsYcGToseAqOdSGOJqUQq5NCKIejfi6HkOGm8XaBYrC+mhsOZN4+PbwDGKkB+CxWeVjWsNJQUCm86Ns5CDp8DBcU1qauz06v3qnf++7pxvaJHKqLkqEB+YwpSZ9cfFDtVoC2oSUd8tApDcIVBplL1husUr8yGrPrmo/1qym8L0OA68ijVPpSQw5VAWUZ7kUqBhg49tsTkBekAFluCHKbzoMEI0A65hp/RL6NVgb2xlTIlWTZrQx40eHqIxlMJOftIGkJRU4uQD8DbTmpPh2AcV1MyBT535VYyCmeZLMsSu64xRQKe3QfpOLwu5e7uqWDQwIYbCVy2HW+l2nIqDOM4jtImdM4GCnL25OhI/l5O8/Fv0L/fvvPCMpupwUzegYn3QJdR7mNCd3oI0DmWambnv0PWhuoALA2BkWP4WriSnu0by1SlO1073yJPobcnLwb5QuHSe+eXM8VPM709QPJOiso6Vtg0rqcyVWuJayf67FyaNykuhyy9nKynkG2OMx9tyIaJ3TErdgqWR7KTb/QN5FAzdyHPMuzMomhcLBeBHsjjwrhXMr5JO+q6QZYp1YXky4MD0WegInrD2xsheOLwnNCTP4sC8Ikq6Qiz1uX7LiWBnhfvdvzd95zmlYtb7rV/+YhtJ3QOozy5tUulZ4ZnhALp38DPfhHmZFENFkk1L4l5Tge1aJp0tWv3135j1CCsTn2OF8dHJ4sjCcoFtZhUN3tFcq9cTY4ixvQzzGfv+n/yvPlWmB456xo0VpAnCoZZWjtT1tBTAA2bY7GuaGWdP7nfrLGVhlp0md/CMNxhoM++GUcJP0TyW8hvVxo26A3eyY3dDlCaIOsS8jU2gX5ByB/L2S/fqH9y1IPTzEG0W0GPTZQv0PCdtnv/HlejhpqwJJ9gTZsXU/M/P0mJ/eFXxjLq3YmzoqCOf5m7evaIrz/efBLtz67eJlsBj71wjP0E1CUyJsOU2AAN2ipiJblTTfn9AOnvflo= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Uses the GA4GH workflow execution service API to cancel the run associated with id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/ga-4-gh-run-create.RequestSchema.json b/platform-api-docs/docs/ga-4-gh-run-create.RequestSchema.json new file mode 100644 index 000000000..27030709f --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-create.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Run request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow_params":{"type":"string"},"workflow_type":{"type":"string"},"workflow_type_version":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"workflow_engine_parameters":{"type":"object","additionalProperties":{"type":"string"}},"workflow_url":{"type":"string"}},"title":"RunRequest"}},"multipart/form-data":{"schema":{"type":"object","properties":{"workflow_params":{"type":"string"},"workflow_type":{"type":"string"},"workflow_type_version":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"workflow_engine_parameters":{"type":"object","additionalProperties":{"type":"string"}},"workflow_url":{"type":"string"}},"title":"RunRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/ga-4-gh-run-create.StatusCodes.json b/platform-api-docs/docs/ga-4-gh-run-create.StatusCodes.json new file mode 100644 index 000000000..421f3d0c7 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-create.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"run_id":{"type":"string"}},"title":"RunId"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"status_code":{"type":"integer","format":"int32"}},"title":"WesErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/ga-4-gh-run-create.api.mdx b/platform-api-docs/docs/ga-4-gh-run-create.api.mdx index 3d48619eb..1928803c7 100644 --- a/platform-api-docs/docs/ga-4-gh-run-create.api.mdx +++ b/platform-api-docs/docs/ga-4-gh-run-create.api.mdx @@ -5,9 +5,9 @@ description: "Uses the GA4GH workflow execution service API to launch a new run. sidebar_label: "GA4GH: Launch run" hide_title: true hide_table_of_contents: true -api: eJztVsFu2zgQ/RWCZ9dK2uxhfdokyKbBLtAgSdFDEDhjcWwxlUiWpOx4Df17ZyjZcmwX6SFYoEBvEvlm+GbmzZArGWEW5OhezuBkVsiHgVQYcq9d1NbIkfwcMIhYoLg8Pbn8KBbWf52WdiHwGfOaMSKgn+scxen1lYhWlFCbvBAgDC6Er81Q3NQmCPDYbaES2iSXNZkmj8EBOcitifgcxWQpFE6hLuNQ3G0ckg0YYf0MjP4P0sl7pgNC5WWtMLl/3OxfqUe2f1yzH6OZaYNjBx4qjOjD4yGaCx2L5Kk/yHldgV/SgZWrIwo0c+2tqdD8iHdyAkLp6RQ9ww6Y7vDuEBdm/jPE5UBahz6l5EpRyS65khTNuUeISNsev9UY4plVSzla7RSYgKIDEDQl0kSGgXOlzpPb7CkwdiUD5aUC/opLh2RtJ0+Ys6HzTCJqDLy74ZuIhi2DEL02M9kMeky78xpiPKdodUtjD9mKeJ8VKKU5ACivX/DbcbB91l6G38hv7cvDiKhjiW0hbro68HJFOtLEImZT66t3CiL8rsD/WIGm7RvtkXoq+hrTQnDWhPak90dH+9306Z+3ayIanmOtXqVMPd8kuieHCJ2Bevv2rsLsoAhChFiHcW7Vtpw0nTlDT15YyRDbpQ/vXwTyBcOF99bfdCnexPThQJLX404YGwWUVFxUbdNgLCzPQGdTvA5iQX9ZutyyBYZsfpxRXgPt8b2VxHW/kkkasojRhVGWgdPDvLS1Ggb8RkcNtZW79+Jt2hHXJUSOSpwznu9A2Tyw77z2Oi5vOaFtzs6Q7hZ/WjOhTWr4RKaSYPQ/SSBaaT/+XufradEOBS7UTT/NL56hciUe7Pd1Wfba/AcbfXf3gK6pX2vOvSbbkoQ2U5sC7urc5Y0T9VpKu4dF6MCsXciTdl+Wa7tIJF9dJoFN7V/9BhHpwzse/vnH8IjXWCUVJOkbSAVIr5yR+Le9u0kpuyxXfQ/9fhv9Cm+jTvScgsyVoA0XvrsK2vGwfvuSipEHw/yY30w8JKiTCx4kBFmtJhDwsy+bhpepBT09pu7pcw5ew4TFff9ArgsERS3MU+UrEkSet3p5d8dEGF7WTOjQ/d4M1kaneY4ubsH3xjWPmc24u/50e8dTo3vhVWkAp3Gb/A76TybZNN8B0r1DVg== +api: eJztVk1v2zgQ/SvEnFU7SXPSqUmQpkELNHBS7MEwnLE0tphKpDIk7biG/vtiKPkjtovsIVigQG8E+Th8nHnzyBV4nDlIhzDD81kBowRychnr2mtrIIUfjpzyBambi/ObL2ph+ee0tAtFL5QFwShHPNcZqYu7W+WtKjGYrFCoDC0UB9NTg2CcQqZuiXKlTQwZHHGM6GrMSGXWeHrxarJUOU0xlL6nHjYBtVFolOUZGv0L48kHWxOlTVaGnGL4x836bf4o+x/X7MdkZtrQuEbGijyxezxGc6F9ESNtD6pZV8hLldmqDp4Umblmayoyv+Mdg6DK9XRKLLAjW/d4d4hrM/8vxCEBWxPHlNzmkMKNVHIQzBUTeoIEmJ4DOX9p8yWkq70CD4JRHQASiIk0XmBY16XOYtj+kxPsClxWUIUy8suaIAU7eaJMNtYsJLwmJ6sbvpGo29ngPGszgybZYtqVtxDjObHTLY0DZCviQ1aY51ougOXdK357AXbPOsjwO8UNXB5HeO1Lagsx6Oog01Uova6RfX9qufqQo8e/FfgfK9C0faOZckg9B4oTrrbGtSednZwcdtP3r+/XRBzMWOdvUr7NhW2TwPkxQpeYv397V252VATOow9unNl8V07aeJoRQwKiZPTt1MezVxf5h9w1s+VBl+LNnT4eSfLa7pSxXmFZ2gXlbdOQL6x4YG3jfWv0BaTQj49bf0GuPz/tczAOEpB3K4pruIIoDSi8r13a72Ote1lpQ95z9EyMPW1h/128jyvqrkQvt1JXgpc3EJqRxM4Ca7+8l4S2ObskZOKLIIQ2qZEThUqEQQqTCIKkG3xe5+tp0ZqCFGqwdfPrF6zqko72+7osB23+m4Vtd28BXVO/1ZwHTbYjCW2mNl64q3OXN0nUWyntPhauA4t2MYvafV2u3SJRhbqMApvaT9uFJoHt9U57pydnvROZFJlUGLVvMFYgfnNS9a19vDmYfZqrbRP9/Rz9CZ+jTvWSgn5dojZS+O4taP1h/flNYEHiDPNT+TSJS4wSKMRJ0iGsVhN09IPLppHp50C8hHQ4SmCOrHEi6h6OmgQKwpw42spPWkIKV61ePjwIEYGXQQgde+CbZL3pIsuo9jvwA78Wn9n43d33+wexje6LV0UHjn4b4ybboZBsmn8BdgFDew== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Uses the GA4GH workflow execution service API to launch a new run. Runs are laun id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/ga-4-gh-run-describe.ParamsDetails.json b/platform-api-docs/docs/ga-4-gh-run-describe.ParamsDetails.json new file mode 100644 index 000000000..bf4813a8f --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-describe.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"run_id","in":"path","description":"Run string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/ga-4-gh-run-describe.RequestSchema.json b/platform-api-docs/docs/ga-4-gh-run-describe.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-describe.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/ga-4-gh-run-describe.StatusCodes.json b/platform-api-docs/docs/ga-4-gh-run-describe.StatusCodes.json new file mode 100644 index 000000000..f91b35cb7 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-describe.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"run_id":{"type":"string"},"request":{"type":"object","properties":{"workflow_params":{"type":"string"},"workflow_type":{"type":"string"},"workflow_type_version":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"workflow_engine_parameters":{"type":"object","additionalProperties":{"type":"string"}},"workflow_url":{"type":"string"}},"title":"RunRequest"},"state":{"type":"string","enum":["UNKNOWN","QUEUED","INITIALIZING","RUNNING","PAUSED","COMPLETE","EXECUTOR_ERROR","SYSTEM_ERROR","CANCELED","CANCELING"],"title":"State"},"run_log":{"type":"object","properties":{"name":{"type":"string"},"cmd":{"type":"array","items":{"type":"string"}},"start_time":{"type":"string"},"end_time":{"type":"string"},"stdout":{"type":"string"},"stderr":{"type":"string"},"exit_code":{"type":"integer","format":"int32"}},"title":"Log"},"task_logs":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"cmd":{"type":"array","items":{"type":"string"}},"start_time":{"type":"string"},"end_time":{"type":"string"},"stdout":{"type":"string"},"stderr":{"type":"string"},"exit_code":{"type":"integer","format":"int32"}},"title":"Log"}},"outputs":{}},"title":"RunLog"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"status_code":{"type":"integer","format":"int32"}},"title":"WesErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx b/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx index e2490dbfb..0c5500440 100644 --- a/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx +++ b/platform-api-docs/docs/ga-4-gh-run-describe.api.mdx @@ -5,9 +5,9 @@ description: "Uses the GA4GH workflow execution service API to retrieve the deta sidebar_label: "GA4GH: Describe run" hide_title: true hide_table_of_contents: true -api: eJztVkuPGzcM/iuCTi2wsHeT7aE+1XGmrpGNvfEDaRssHHmGHmt3PJpIHHsNw/+9pDR+rB/dogjQS08jkRzyI8XXWqJKnWx8kam6TWfy4Uom4GKrC9Qmlw05cuAEzkC0m7ft38TS2KdpZpYCniEuWUY4sAsdg2jedwQaYQGthgX4nxJApTMnzNRfbZkL5ZzRCiERS40zT071AnLxlbhjnXytyStpCrCKtXcSwtBmaP0yf++RTYAECmXVHBAsY1/LnC4kGDQQWzP0QuFMHvtDaoQjhHkqdAI56qkGS1IWvpXaAplDW8KVdPEM5ko21hJXBesOP8nN5oGFXWFyigzz31xf8+elmd4H0hmbHMkEc1VRZDr2LtUfHYusT02YySPEyN5ZDgDqYKDy6hRKQA0OX9exfbexD5w7q2wnEzivSYwXFH0dXDmRDFl1ikolieYgqOz+Bb7jIB/YgjzVOYwPX/y76C1tdl4CNWYQUqVfxZeoDilpT3+4kpCXcy6gUfdDt/e5S5RPo2gUvadDp9sZdpp3nT873TZd+6NuN5zum6OBl2j1Pt7fRcOIjtHvUWs07PXHUb/f6xNh8MdgGH3cXVvNbiu6C3/5I6t62MMdeICcFJQvmUlfT4pQNWdeL54fppuyVq24qBDOZk4IjsUx6gv6IE8uMx0mpsRLLLD2vMpnjePYJIc6NZVb6qt5auxcYSC9ffPiVe9MlaDuiaPk/oGj/4fvKHx0J5tFiezPUckEASbenmuM71Qitl3ru3XIuUsvBEBh6f6Vn5/BRdYa269a/c6nt2ea/XZaidygUBl1FxokLE4Na2Z4hKXgUfNEasi6n7X1Jbj64qZO5erq69DkNyTE83Q713yPkjPEwjXqdVXoWpyZMqk5+EYma9qczLeB54j7TCF7J1osz7NZ8uByNLStxtWAAxti9w6UBdssGdkuRGxRVkOQ7xMvRJRw+HUbt8clej91PjX+920vCijY7GsAq/XBVcKcESr2GfHS+UOXKSl05p9tan7ZMwjIbibJm9rPP9WumVYYh3OV70tW+l2mIbb7BO8lxzjX+9z8j3ag6ikQnrFeZIpWGvKlGlohkbZLGw01ekty/kb67s/nRrU10KPPDG8IX+R6PVEORjbbbJhMNWhXRKfjQlmtJvxylHOJdnymrJ2qzMHfxOWHfrU0/SgurVVnndg2xpzb4kJlJd/o+ASr/RK3eSDJGShqYR5WYDbjGAo8+O2kbXCa78quHQ0pP/8CN1+3lg== +api: eJztVt1v4zYM/1cEPm2AkLS9PvlpuZ7XBddLsnzgthVBTrWZRK0juRKdNAj8vx8oOx9N0nUYDtjLniyLFPXjjxTJDZCaeYjuYaauZ3MYS0jRJ07npK2BCEYevaA5itvW9e1vYmXd0zSzK4EvmBSsIzy6pU5QtHptQVY4JKdxieFQiqR05oWdhl9XGKG8t1oRpmKlaR62Z3qJRnxzhZno9FsDJNgcnWLr7RQiuGVo/cJ8CsgeECTkyqkFEjrGvgGjFggRVBZAgmbouaI5HPvTL4zw5LSZCZ2iIT3V6ECCw+dCO0whIlegBJ/McaEg2gCtc7ZdHYKyHLOyz63x6Fl+dXHBn9fXdD+DhMQaQkMsVXme6SS41Hz0rLI5vcI+PGJC7J1jAkhXF9RenUKpUKOn921s4zYJxPmzxnY6leQ9jckSndeVKyeaVVadolJpqpkElfVe4Tsm+eAuNDNtcHIY8R9it3DZeQ3SlGGVKv2a31KCJ0VnWJGApljwAxp1Pne6Xzsg4fdRPIo/gYR2pz1st+7af7U7tyChP+p0qlWvNRoEjZvul95dPIxBQvxHfDMadvuTuN/v9kHC4M/BMP6y+71pdW7iu+pUWLKp8R7uIADkpCjMJLOz95OiejVnopcsDtNNOafW/KgIz2ZORY6jCek37KFJ3xZ6Sm1Bb4nQufMmXzRNEpse2tSGcBZe89S6haJq68PVq6je2TpB/ROz5P+Bo//Td0RfKcEWlBfE/hw9mUqBN6/PFcaPKhXbqvXDKuTCz94gQFHh/5WfX9HHzlnXr0v9zqcPZ4r9tlsJY0moLLMrTIO1BdLccgubYUDNHSmCZui1zRX65vKy6Qrjm5uqyJcggfvptq+FGgVzotxHzabKdSPJbJE2PD6jUw1tT/rbIEhEL1PE3okb1ufeDNy4PCaF07QeMLEVdx9ROXStgpHtKOIboW6C/P8QlEDWi1+3vD2uKPipzdSG49taVKHga98DWI8PvlbmjFBJyIjXzh+6jAulsxC2qf1lLygl7HoSXDYuL64aF7yZW08LZfZvFsIwE4ntQMGDyTHQzT45/6MhqI4F4Qs180xpw77UXavKpO3UJmGFHiQsLyGUf15H9dgwljC3PCLcw2bzoDyOXFaWvP1coFtDdD+WsFROqwcO3f0GUu15nUI0VZnHv+Hlp349Nf0s3pqrzjqxrYyG6+JSZQX/gYQnXO+nuHJcSpijStEFWJWwlSSY08Gxk7rBeb57d7fxEMryO4pnt7s= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Uses the GA4GH workflow execution service API to retrieve the details of the run id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/ga-4-gh-run-list.ParamsDetails.json b/platform-api-docs/docs/ga-4-gh-run-list.ParamsDetails.json new file mode 100644 index 000000000..9ffdde842 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-list.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"page_size","in":"query","description":"Page size","schema":{"type":"integer","format":"int32"}},{"name":"page_token","in":"query","description":"Page token","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/ga-4-gh-run-list.RequestSchema.json b/platform-api-docs/docs/ga-4-gh-run-list.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/ga-4-gh-run-list.StatusCodes.json b/platform-api-docs/docs/ga-4-gh-run-list.StatusCodes.json new file mode 100644 index 000000000..1f4e4b834 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"runs":{"type":"array","items":{"type":"object","properties":{"run_id":{"type":"string"},"state":{"type":"string","enum":["UNKNOWN","QUEUED","INITIALIZING","RUNNING","PAUSED","COMPLETE","EXECUTOR_ERROR","SYSTEM_ERROR","CANCELED","CANCELING"],"title":"State"}},"title":"RunStatus"}},"next_page_token":{"type":"string"}},"title":"RunListResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"status_code":{"type":"integer","format":"int32"}},"title":"WesErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/ga-4-gh-run-list.api.mdx b/platform-api-docs/docs/ga-4-gh-run-list.api.mdx index 57c45932a..df665c3f5 100644 --- a/platform-api-docs/docs/ga-4-gh-run-list.api.mdx +++ b/platform-api-docs/docs/ga-4-gh-run-list.api.mdx @@ -5,9 +5,9 @@ description: "Uses the GA4GH workflow execution service API to list all run reco sidebar_label: "GA4GH: List runs" hide_title: true hide_table_of_contents: true -api: eJytVdty2jAQ/RWNnhmcWx/KUwl1KRMCFPCkl8kwwl6MEmM5khxCGf69u7JNINAmnckLSLtHez27XnMrYsMbv3gsLuI5v63xCEyoZWalSnmDBwYMs3Ng7eZF+ytbKn0/S9SSwROEOWGYAf0oQ2DNQYdZxRJpLBNJwnSeMg2h0pGp8xpXGWhBDzoRmm2Tt2GedhGNykxosQALmkJZ8xQvCMpEDBMjfwMiJAXzkINe8ZchDhDGSpgJ57AQvLHmdpWRDZlaiEGjaqb0QthCdH7GN5vaviOr7iF9g6cKd+DKWC3TGA1jETWYTKVYO9KfnZzQ376t/hXaCBWGl1rSiixLZOgq5N0ZgqwPXajpHYSuYJrqaWXhAEttdlBCa0HBSwsL86bXExkdSQRztMLCoabGIc0XxJqgd9Xr3/RQ8i3wA/8zHjq9zrjT7HZ+dnptvA6DXq84DZrByCFa/etB1x/7ePS/+61g3B9O/OGwP0TB6Mdo7F9vr61mr+V3i1fuSKawvlbahAIauQCxl1sJkoqEuXHSFJ7sZKe9R7q195T4OCx7hzrSXhzr3qWIkNzIEkffd2rjwsR/7UJuJqGK4I3M3qZ0A8bXWumDnM6PMLKaUJYqN8JqCZGzhqM5VzS2MRTTaud48dzK8JZgvMdTz3EQY8VtUI1xrhOEza3NTMPzRCbrYaLyqG7gAT3VpToYsJHTsEEiLCXFWoSnzcJpqAyuHC3takT1LEp2CUKDbuYU0LYy5LEaULpPHQglxeFLVa67pXXpyXSm3POKVEUU5Pa1AMvlZ0owEUGEjgj7ye+mjFyQievWTH16VmAgVLnCz2n944f6CckyZexCOB6V28pt4gYjqrKy6ntBrp/5+H7ruyytxXnyskTgksTYXI7rkg/VJ6TGkRH4+3iKPy4+bN0csyDIej0VBgKdbDYkLtYscSWSRkwT5FtjJhID/0hpd90fjeoeVi8+Ho8iyQnHaef/p6dq3b/mqsI9+7qli5bkDFO8RfgcRIREpHyLl80whMzuvDpYH2RlO35tf4yE/QPZEJXL +api: eJytVdty2jAQ/RXNPmsgtyc/lVKXMkmAcpm0zTCMYi9GiS05khySMv73zsp2AoE26UyerMuuzl7OHm/AicRCcA2JOEtWMOcQo42MzJ3UCgKYWbTMrZD1Ome9b2ytzd0y1WuGjxgVZMMsmgcZIeuM+sxplkrrmEhTZgrFDEbaxLYFHHSORpBDP4YAeoQ2LtSFtA445MKIDB0aCmUDSmQIAeQiwYWVvxE4SArmvkDzBK9DHIkEWW1moxVmAoINuKec3pDKYYIGOCy1yYSrjk5PoCz5LpDTd6jegdTY7UFZZ6RKoCznHAzaXCuLlu5Pjo7os/vW8Bw4RFo5VI5uRZ6nMvIVat9aMtnsQ+ibW4x8wQzV08kKwBTKblkJYwQFLx1m9l3eCxkfSISDdcLh/g0HVEVGrJkNzgfDqwFw+D4LZ+EX4NAf9Kf9zkX/V3/QAw7j2WBQrUad2cRbdIeXo4twGgKH8EfYnU2H40U4Hg/HwGHyczINL5+33c6gG15UXn5JT805OOlSCmjiAyzLl5NxoeiwsP5U4aNbbLX3QLd2XImP47p3UJZ0e3aoe59FzAzeF+jp+0FtzGzy1y4UdhHpGN/J7OeUrtCGxmizl9PpAUY2E8qU9iOs1xj71zJ0K01jm2A1rW4FAbS9ZLTXaNsPx23PQQ6kBs0YFyaFAFbO5TZot0UuW1Gqi7hl8R6NaEm9N2ATf8NGqXCUFOuSPSkL0FBZjAoj3dOE6lmV7DMKg6ZTUEDPlSHEZkBpf+ONgNeLr025btfOpyfVUnv3hlRVFAT7VoC1+NnamIggIk+E3eS3U8ZMyNR3a6k/vVyUHKhyFc5x6/jopHVEh7m2LhOeSLVceSkOGHGV1WXfiXLzQsiP0++6tg4fXTtPhVQUm09yUxOi+YdwWCPF9HAMvJKmOYeVto5MNpsbYXFm0rKk40pniSyxtOImxRiCpUgt/iOlbb0/GNUdPr36ezyItCA7INH/T6RG79+CauxesOa0MZLAILielxxWKGI0Pt/KsxNFmLstrz39oFee568XTqEs/wAITJXw sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Uses the GA4GH workflow execution service API to list all run records. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/ga-4-gh-run-status.ParamsDetails.json b/platform-api-docs/docs/ga-4-gh-run-status.ParamsDetails.json new file mode 100644 index 000000000..bf4813a8f --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-status.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"run_id","in":"path","description":"Run string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/ga-4-gh-run-status.RequestSchema.json b/platform-api-docs/docs/ga-4-gh-run-status.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/ga-4-gh-run-status.StatusCodes.json b/platform-api-docs/docs/ga-4-gh-run-status.StatusCodes.json new file mode 100644 index 000000000..cf71dd96a --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-run-status.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"run_id":{"type":"string"},"state":{"type":"string","enum":["UNKNOWN","QUEUED","INITIALIZING","RUNNING","PAUSED","COMPLETE","EXECUTOR_ERROR","SYSTEM_ERROR","CANCELED","CANCELING"],"title":"State"}},"title":"RunStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"status_code":{"type":"integer","format":"int32"}},"title":"WesErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/ga-4-gh-run-status.api.mdx b/platform-api-docs/docs/ga-4-gh-run-status.api.mdx index 2c0ff6716..52a52a36f 100644 --- a/platform-api-docs/docs/ga-4-gh-run-status.api.mdx +++ b/platform-api-docs/docs/ga-4-gh-run-status.api.mdx @@ -5,9 +5,9 @@ description: "Uses the GA4GH workflow execution service API to retrieve the stat sidebar_label: "GA4GH: Retrieve run status" hide_title: true hide_table_of_contents: true -api: eJzFVUtz2jAQ/isandoZBufVQzmVUJcySSA1eNLHZBJhL1iJsVxJhjAe//fuygZCSdpLZ3rBq31ov119u5TcirnhnR98Ls7mCb9t8RhMpGVupcp4h4cGDLMJsH73rP+ZrZR+nKVqxeAJooJ8mAG9lBGw7vWAWcU0WC1hCS7IWGELw9TMnXSRMWGMiqSwELOVtInTz+USMnaP5jsZ37d5i6sctKDbBzFi6BO0oMjG7jY050KLBVjQhLzkGR7QrY5HsyTgubAJ/70avAQxaZnNmYwhs3ImQaOXhp+F1IDJrC6gxU2UwELwTsntOqe76yBeVbfkbHKVYV/IfnJ0RJ/9NKMLvDNSmcUUZBV5nsrIFeQ9GHIpD1Oo6QNElqrTVL6VdYKmqkMoiBL7AYeWFoesWNCbhsOL4ehmiJovoR/6H1EYDAeTQfdy8H0w7OMxCIfDWrruhmPn0RtdXV/6Ex9F/6vfCyej4M4PglGAivG38cS/2h573WHPv6yjnEhXYYestCkBGjuAVbXT7F6xqkh/9lL7zkXM6EXA2H/Xx4WZv9rEwtxFKn7eSok5544aM6UXwtaq05O9Ym7A+ForHTSE2NZ0+gIlNoxmmbJMpDhDSDdyRyInimg+B4eaeNvhnptHbwXGWx57SALjlTUVKs9s5oBGbzMEhU4xLLE2Nx3PE7lsR6kq4raBn5i5LdXBMIydhV2nwlKRrEf+NMacWG5wvrW06zH1t27hOQgNulsQwG2nKCNvJobOU+eEmlr4tGnfw8q6cmU2Uy58w5EaBaX9G8Bm05jGmYghIkeM/eKfl4zckKl7vZn6sDMgEOpcnee4/f5d+4h0uTJ2IRyvmqXi1l6HBZutpt0Gafq/B7fcMfU/bc3mRSw8WS9PBa5BLMm1pmxotVnzLY7Ewt/lMS0/JBd+Otv92dSHJEiwHxRVllNhINRpVZEaR1OvUY/iUmgppvSSyMFYGpKRzDORGvhDg94EzcZ9y17byS9W0yhFtib0Ii3ohOIjrHf/ANUteiYgYryHYNXGbhRBbp+FHWwTov12Gvv+BPn6CwR7aCk= +api: eJzFVU1v2zgQ/SvEnHYBwkrSnHSq62pdo6mdlW10u4GRMtLYYiqRCj/sGoL++2Io2U7W6e6lQE8ihzPkezNvRg04sbEQ38FGXG8KWHHI0WZG1k5qBTEsLVrmCmTj4fX4A9tp821d6h3D75h58mEWzVZmyIa3E+Y0M+iMxC2GIOuE85bpddgZr5iwVmdSOMzZTroi2Ddyi4p9NV7dy/zrADjoGo2g2yc5xDAmaKlX83AbcKiFERU6NIS8ASUqhBi6eOAgCXgtXAH/ZpN6xawzUm2YzFE5uZZogIPBJy8N5hA745GDzQqsBMQNuH1Nd3dB0LYrcra1VhYtnV9dXNDn5TOzj8Ah08qhcnQq6rqUWSAUPVpyac6f0A+PmDliZ4i+k90DPatzKBwou3h+wgGVr6imy+nH6ezzFDj8uUyWyXvgMJlOFpPhzeTvyXQMHNLldNqtbofLefAYzT7d3iSLBDgkfyWj5WKW3idpOkuBw/zLfJF8Om5Hw+kouemiwpKuWnFw0pUEaB4Atu3Jcqpi25L9+rX0vRM5o4qgdT8vj5Xd/DCJ3t5nOn+eSqkcboI01tpUwnWmN1cvyHxGmxijTdoL4sjpzSuSOCiaKe2YKEu9wzzcVqErNMl8gwE16TaGKPRjtEMbbS8j45WNmk4KbWQPfUCtd2gCb0qIoXCutnEUiVoOslL7fGDxCY0YSH3WDPNwwm5L4YgkG5E/tTGQyi1m3ki3n1N+uxS+Q2HQDD0BPGaKXoS+Y2j/EJyA94s/Dul73LlAV6q1DuEHjXQo6Nn/A9hPGts7kzBEFoTxkvxzylgJWYbqrfXb00HLgTLXvXM5uLy4GlyQsdbWVSIIq58qYe7FLD2MNRNGSF+AF3ibk1R/0djsS+Lwu4vqUkhFlEJuml5XhznPYYdEYHtJ088rWsfHAdrzW3EotHUU1TQPwuLSlG1L5iePZg/x3YrDVhgpHqiUdw3k0tI6h3gtSov/kaDf0n7k/s5+NJRfZdMbhdoTelF62gGHb7g//QLaVcuhQJGjCbC6w2GWYe2ehZ2NE9L9sR3HyQLa9h8ESGhO sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Uses the GA4GH workflow execution service API to retrieve the status of the run id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/ga-4-gh-service-info.RequestSchema.json b/platform-api-docs/docs/ga-4-gh-service-info.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-service-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/ga-4-gh-service-info.StatusCodes.json b/platform-api-docs/docs/ga-4-gh-service-info.StatusCodes.json new file mode 100644 index 000000000..d64148208 --- /dev/null +++ b/platform-api-docs/docs/ga-4-gh-service-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"},"apiVersion":{"type":"string"},"commitId":{"type":"string"},"authTypes":{"type":"array","items":{"type":"string"}},"loginPath":{"type":"string"},"navbar":{"type":"object","properties":{"menus":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}},"title":"NavbarConfig.NavbarMenu"}}},"title":"NavbarConfig"},"heartbeatInterval":{"type":"integer","format":"int32"},"userWorkspaceEnabled":{"type":"boolean"},"allowInstanceCredentials":{"type":"boolean"},"landingUrl":{"type":"string"},"termsOfUseUrl":{"type":"string"},"contentUrl":{"type":"string"},"analytics":{"type":"object","properties":{"hubspotId":{"type":"string"},"posthogApiKey":{"type":"string"},"posthogApiHost":{"type":"string"}},"title":"Analytics"},"allowLocalRepos":{"type":"boolean","deprecated":true},"contentMaxFileSize":{"type":"integer","format":"int64"},"waveEnabled":{"type":"boolean"},"groundswellEnabled":{"type":"boolean"},"groundswellAllowedWorkspaces":{"type":"array","items":{"type":"integer","format":"int64"}},"scmsServerUrl":{"type":"string"},"forgePrefix":{"type":"string"},"seqeraCloud":{"type":"boolean"},"evalWorkspaceIds":{"type":"array","items":{"type":"integer","format":"int64"}},"contactEmail":{"type":"string"},"allowNextflowCliLogs":{"type":"boolean"},"logoutUrl":{"type":"string","nullable":true},"seqeraAiBaseUrl":{"type":"string","nullable":true,"description":"Base URL for Seqera AI services. Can be `null` if not configured."}},"title":"ServiceInfo"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"msg":{"type":"string"},"status_code":{"type":"integer","format":"int32"}},"title":"WesErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/ga-4-gh-service-info.api.mdx b/platform-api-docs/docs/ga-4-gh-service-info.api.mdx index 6d508584e..833755081 100644 --- a/platform-api-docs/docs/ga-4-gh-service-info.api.mdx +++ b/platform-api-docs/docs/ga-4-gh-service-info.api.mdx @@ -5,9 +5,9 @@ description: "GA4GH workflow execution service API info" sidebar_label: "GA4GH workflow execution service API info" hide_title: true hide_table_of_contents: true -api: eJytVlFv2zgM/iuGnnNJu/UGrE9zg64L1m1Fu94eiuLGyIyjTpY8SU6aBfnvR8qOlxR208PdU12JpD6SH/llLQLkXpzeiRxO8rm4HwhbooOgrJlk4lRc8PENuoWSODEzKwbCoS+t8Uhua/Hq6Ij/ZOilUyW7kdOXj2QmrQloAt9CWWolY9DRg2eTtfByjgXwV1iVSE52+oAykGPpGEJQ9QMLdF7VLo2hD06ZXGwGFFf99cy1tEWhAqfR5VuF+Vc69Du34BysCIEKWPgOL3LTNlfmCsK8M6iBxRTc4aQKNNVLHu5x1zBF3Qmgcl3ndBFU0Hz0OSIcWzNT+bD+5xOBIZseI446R3BhihAm1FK3gN03FB3l6AjjzLoCQn30+lVE49F9s+6HL0HiuYGpxt1mTK3VCCZ2Q2u7nBgfwEgcO8yIOQq077bWYDJK7LYzWUoDXeG/zG499lk03Oy7BgN6FZR8QSvm1ZSmoY9kpfVhbvO0VB9xdcDiA30937u0hbWt2KWVoK+RgnQUakBTWTqkueOqB1fh78w/weN7pfFG/cKDvXxzwu8tYfF8C3NnK5P5JWr9UruUc8CspchLRqIfI8X2svC8rND1tZaccrxyOFOPnfcef9L6G2tb9cBHon8LeJL9Z8jcEJDhvADVQ0Yu0md8DDP6O9bq0uZ9Y2FzW3WTmlZTpTV3pWVCnWmqzqBnTp76DJ5seXZMbq8vE8oquYnRknSS+Fos/DAZg0mmmHznMN8TNUuMDYmMW6WiER/ukXtXYzZxG510ScsZZInDnxX68P9pTOHzbjIECJX/W9rs8JTwxttJ5xv6c+esu27Ess3pdYdcbhU3FgjqoYjR9u0u0pOLD8mSyMdUSPARZRXdmpIn6dUkUbVIF0hrhQU8x5hvVCwxiio/WqIfLY5HjdsfjYuPg8M/Bta1joh5CKU/HY1IZ4eSR2JYk2aorHgKriHAlYbAZUniCDEisbnn2LJyKqxuuCN10c9IVNCl1Z6U8osMJZoxu6MRndQf77cFf1iGWKAInd1bFtU0pGcPAdzytDFu5pCD7Se/mzLWUxqffff7goC0P1PE8fDtn8Oj7W4vIDLRQEzn33RwD31boECLYFRqUGZH7uvubn/D0a6mChOk46apbY+pEfOoMndivZ7Wc7/Z8DENlCOBuqPPBThVD/3dfa39GXWASfGDNUykUmLJnKJFWMW193TyuOEt/y7Ov1Kn/gGHC5jV +api: eJytVlFv2zgM/isGn72k7Yp7yNOlQdcF67agXW8PRXBjZMZWK0uuRDvNBf7vB8lOmhR20+HuKY5EUh/Jj/q0AcbUwegeUjxPM5jHYAqyyNLoaQIjuPLLt2QrKWiqlwZisOQKox05GG3g7OTE/yTkhJWFd4MRfP8CMQijmTT7XSwKJUUIOnxw3mQDTmSUo//idUEwArN4IMEQQ2E9BJbNARVZJxuX1tCxlTqFOgYs5F9vbAuT55J9Gl2+JWc/1kVzSLuL1uIaYpBMuevwqmNQJpV6hpx1BtVYLdAeTyonXb7n4B53hQtSnQBK27Vex8CSlV/6FhBOjF7KdND8+Uq6hLrPyEfNCC0vCHmqmWyF+2dIzZSShRiWxubIzdLHs4DGkf1p7KMrUNClxoWi/WYsjFGEOnRDKbOaaseoBU0sJaRZonLd1gp1InV615lsDEw2d9+Xd476LFpu9m2jRrVmKd7RiqxcuML0kawwjjOTjgv5hdZHLD4bx2/3bryDta3YtRGobqgwXYWKIaHCkkD2VWdb0kvmX/H5k1R0K/+ho73849yft8Lq7Ram1pQ6cStS6r12Y58DJTuKvGck+jHWMTiRO39Zke1r7dLYlGaWlvK5c9/RE1mcKFP2wKcK1Q7wNPnPkH1DUPBljrKHjL5I3+iZl8qsJkpem7RvLExqym5Sx6BLpXxXdkxoMh3LC+yZk9c+8atb3jtGdzfX0dLY6DZEi8bTyDVi4QbRBHW0oOiXD/MrkstIG45EuFVKS8nggNz7GlOH2+i8S1ouMIksPZXk+P/TmNyl3WRg5NL9LUxyfEr8jbeXzk9yl9Yae9OK5S6njx1yuVXcUCBshiJEO7S7Gp9ffY5Wxj56KkT0TKIMbm3Jo/FsGslGpHPizHgBTynkGxQLhkHlhytyw+p02Lp9aF1cGBz/GNg0OgIZc+FGwyEWciD8SAwa0gykgdfgWgLMFLIvSxRGyCOCeu5ji9JKXt/6jjRFvyC0ZMflgZT6Ez2UYObZHYwgbj8+bQv+sOJQoADdu+9Y1NBwNj0KcMvT1ridQx/sMPn9lKmZ0nDsny8bdfzyTIHTwenJ2eBke7nnGKioMeTzOy08gL+rENMzDwuFUu/pfdPe7SMuhhU5iKE6bbu6a/I8hizIzD1sNotm8OvaLz+VZNcwup/HUKGVzdTfzxvxT8gGVjx6EYOxEFR4UlWoynDvvR493/EdAa8uf0Bd/wvsE5j6 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ GA4GH workflow execution service API info - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/generate-data-link-upload-url-1.api.mdx b/platform-api-docs/docs/generate-data-link-upload-url-1.api.mdx deleted file mode 100644 index 3ba329636..000000000 --- a/platform-api-docs/docs/generate-data-link-upload-url-1.api.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: generate-data-link-upload-url-1 -title: "Generate data-link file upload URL (to given path)" -description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`)." -sidebar_label: "Generate data-link file upload URL (to given path)" -hide_title: true -hide_table_of_contents: true -api: eJztV9tu4zYQ/RWCTwkg29luWmD91FyLoMkmyAX7kAY1LY1sJjKpJakkriGgH9Ev7Jd0hpQs+VI72fahD31JTHI4lzPDOaMZd2Jkef+eJ8KJTibVk+UPEU/AxkbmTmrF+/zIgHBgmWB31+fMaVbkmRYJS2WGu7h2Y2BzBUxYq2OJNxL2It3Yn47kMyg2IKFzlDlLBhGzOcQynUo1Qs2ki+UCxXcGiTRX+Guw2/1FnWrDDr7csJuPjQUbMaGYSBJJDoqMpTrL9EunyJmBrwVYxyYF/hkCs6AcE6kDw6a6MMFM5f5YWBbrSZ4BubqDhkDFulAojGu0AMZos0sBphLNyN/Ax1Jd76DysDHoha0eikk7HqCeJNdSuS6PuM7BCPLzLEEofwJFSziugLjzF+9M9usHlM2FERP0xlBKZlzhAu80oKGIpIQQTnw5S8fzBFhnCFSZYPAylWBQloCRGBfvO1NAxG08hong/Rl305yshEu8LKPGcMjDRqskMC8BRB6BohOGdyF22ky/0XaM8uS+yGwTN+bWK1wpz1p0behvMfeizZPNRQzbjH2pBZkqJmBkvMUWVgGM/FGqzUS4sPXD/oL1SyNHaLMyPAaRbHQ84qrIMjHMICBalg8BZMT/UCdTuhFrNKwc/RR5nsnYp6X3aCmK2apqPXzEfFENGqpYJ8HSKb2Xz97JVScWgSEpplNfCP6VzftEl5dR7c85qBFW0RvwWdZ/Q89vrX4mFRtOsUG1Dd169ducvji7OGEk8jead6A76kZs0IZQxw5cBxWCmGAXGzh4db08E1Jhw6K0cicdpYbXj/yiyJy8EsaF134dMoWi5fLb8Bs218oG+L/b26N/i05f/syjfyu/IU5qTdugCr6zs2M2qnpYgqhXvbnLrqs4sBeb9U2xKlCfpKJue7ZlWBgj6MFJBxO75rkue3RA8pS43EDHypFC60hQnpHgFeLCAfIAQt/BvurqYmSXCjyPIQqMDt6Ys5AVShpK76/Ly2GT2nfkpymAez4Ba8UIiIE3p60WXNfT5qGcEH2tOP5xTUHVFMWURrYkLkV/vPT+qvRn7U6RJRP25+9/sHnfZJj2Vs/2mlISi9jB1RnSgaV+1ZTH/GJEN5vhQZswBczv/1exxEOLNWakm3qyPgRhwBwU1N3uH6gjI5OPNZF+rn1JeP7s814zx/RmDbeX9XuZVbRbEgOAea6ngcJkRA7O5bbf64lcduNMF0nXwldMX1fq1ZbpT9hVJhw1V3ZE8pQOTu7V3t8QfAGKdgxzNMhiTUa0Hnoh3Ak/Tuu2/fjiPGSUluuGjE5eBY1Yi2TSNJklXthbauCtxy9Vqr1bVUqq6CicbYETjDLGWTUIkwUR+3paBLUNJZaUzDwbpfrH5gAdoYwEOx+6n77v7tEepXgifDlWnF5Peq3abg+f1IF2sFGFwZhKY3c5jBaJ/z+C/5MRvCrkhqg9BVHmZ9WjXPj+iXh/YeQOmv12NRDj6xnTm8Z7s9lQWEAmK0vaDkMjPde64/F+iv0QNud24/y61v0nmK6Zkp9FVpAsp+Hy7R5sGWo3OLA4NzfmH2hhZJhR34XGTj1J7LLNXzRrvapHCTVtu1N720rr+wBqOfWWD55vca0qrfIBRasvgPcBtzlR80+MhRIJZ0dBR8e33EZihWubGwdxDLnbKNsmwKvLm1sijOrbZKITumPEC30c4l/vvPYxeR7yezOeCTUqPDXzoJPoRSyy0xIbeczWIo0P1Uvc6idQZTkH3tGaYC/LvwC4Le2Z -sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api -custom_edit_url: null ---- - -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import ParamsDetails from "@theme/ParamsDetails"; -import RequestSchema from "@theme/RequestSchema"; -import StatusCodes from "@theme/StatusCodes"; -import OperationTabs from "@theme/OperationTabs"; -import TabItem from "@theme/TabItem"; -import Heading from "@theme/Heading"; - - - - - - - - - - -Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). -For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/platform-api-docs/docs/generate-data-link-upload-url-with-path.ParamsDetails.json b/platform-api-docs/docs/generate-data-link-upload-url-with-path.ParamsDetails.json new file mode 100644 index 000000000..fb8a50ed8 --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url-with-path.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier","required":true,"schema":{"type":"string"}},{"name":"dirPath","in":"path","description":"Path to the destination directory","required":true,"schema":{"type":"string"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"Origin","in":"header","schema":{"type":"string","nullable":true}}]} diff --git a/platform-api-docs/docs/generate-data-link-upload-url-with-path.RequestSchema.json b/platform-api-docs/docs/generate-data-link-upload-url-with-path.RequestSchema.json new file mode 100644 index 000000000..4bb9685aa --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url-with-path.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file to upload."},"contentLength":{"type":"integer","format":"int64","description":"Size of the file to upload in bytes."},"contentType":{"type":"string","description":"MIME type of the file to upload (e.g., `application/octet-stream`, `text/plain`)."}},"title":"DataLinkMultiPartUploadRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/generate-data-link-upload-url-with-path.StatusCodes.json b/platform-api-docs/docs/generate-data-link-upload-url-with-path.StatusCodes.json new file mode 100644 index 000000000..b2f6a6d64 --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url-with-path.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","description":"Upload ID generated by AWS S3. Required for the `/upload/finish` request."},"uploadUrls":{"type":"array","items":{"type":"string"},"description":"Array of pre-signed URLs to execute multi-part upload. One URL per part."}},"title":"DataLinkMultiPartUploadResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/generate-data-link-upload-url-with-path.api.mdx b/platform-api-docs/docs/generate-data-link-upload-url-with-path.api.mdx new file mode 100644 index 000000000..f262ad41d --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url-with-path.api.mdx @@ -0,0 +1,67 @@ +--- +id: generate-data-link-upload-url-with-path +title: "Generate data-link file upload URL (to given path)" +description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`)." +sidebar_label: "Generate data-link file upload URL (to given path)" +hide_title: true +hide_table_of_contents: true +api: eJztV81u4zYQfpUBTwmg2Nkf9OBTs39F0N0mSDbYQxrAY2lkcyORWnK0WdcQ0IfoE/ZJiiElS45dJ9n20ENPtsgh5+ebmW+4UoxzrybXKkPGo0KbW69uEpWRT52uWFujJuq1I2TygHB18R7YQl0VFjPIdUFevnlBsL4A0HubamTK4E7zIuzO9VcyMBWh99rcnmbTBHxFqc6X2swBw11QIS/gYJppd468mB6OfjXvrIOTT5dw+aLX4BNAA5hlWgzEAnJbFPbuqK7A0ZeaPENZe4YZgSfDgDmTg6WtXVTTmr9AD6ktq4LE1APrgExqa8PkKBMN5Jx1h+Jgrg0W+jcKvrTHj8BTXJiO49I410b7xRTIZJXVhkcqUbYih2LnaaYm6icy8klv2kBchYNXrvikeSFOq0RV6LAkJifArJTBktRE9aFTidICSxXFN7F6s4bBs5PQ6owM61yTU4mS8GhHmZqwqylRPl1QiWqyUrysREs8pJom6RVHNPZqFYF1IpBnbYLLkGlHKVu3/E7dqaNgPha+9/tLTeHCrSTtRHe6/hh1d9bd+gpTekjZp04QTF2S0+kDurRhmoet3LoSOS798HJD+5nTc206xQvCbK/hiTJ1UeCsoBjRprmJQSbPr2y2lBOpNUyG5S9WVaHTAMv4sxcvVttX29lnSlly0EnesiYvu1I1vwQjt43YDIxIgc1DIoRaW3eLkWqSzp73ZOa8eEx87t9/KUW4837QBmZLJj9U9DFc/5DRH04/vAUR+ZubD2g0HyUwHYbQpkx85NkRltMEpkzfeFwVqM30cCSwKtYs0Kiu1D/UBetzdBxr/iIipRqR3ayNsOAra3wM//PjY/nZNPrsZ5X8W/hGP6VBPRSqaDucvoF528kymC3bDj2Ci9YPyK3b3RrbBA0g1V3z8wPF6BxKwWmm0u8o1/sWnYi8AFc5OvJ6bigTmgq8RN8orZmglNAfVei4S0Y4MxTYrCIHsvFIzCIqAlqTqJe7cHnVQ/sEfPoEuFYleY9zEh7eD1snuKunrV15KyS2ZfiLHQnVERUYy4DCqJSpIP1yW/oXy+9sbTL48/c/YN03wToY9OxwUy5iCZycn0KmvfSrPj3WBxM52Y8Q1sVZYH3+vxrLJlGe0tppXgayfkXoyJ3U0t2ub6Qjl8QLK9Rf2ZASgT8natxPM+NVz+1NVy+rlnYbYQByX7tpoHaFkANz5SfjMVZ6lBa2zkaevpDDkbbbLTPswHmBLM0VXou8wKHEvM76SwlfDMXQh3U0RGNHRvI9C0Iqaf+869r25zsOIRNYLnoyevsNZdDaJJO+ydzjheN7DXxQ/NrkNpjVQtJ6J+485LiEUafkW2HRgGnIp82gDkNJJeoisFFuf+w3mkQJIlHPs9Gz4+ejY1kUjEsM+diSejfwDZJ7OINKCzpg287HkhuH9/0YsPj/k/g/mcTbTO6ZOnCQQL9qq3LjGZSoycbMHW8Oy+1EfJOohRT15FqtVjP0dOWKppHlODVKvXYtT01yLDztx3bvALvT/Fta7hiTv2JRi6yS6fLxFjww1e4xYHNw7tXfyIfTcUh9UjQOulHiEPY/aXZa1c0SZjk0p7N2AOvTAjQw6jEvnu8xrU2t5qZJuifA0wK3H6j1G2MjReLe63jHUei5vcQW2fYnTtKUKt4rO2TA87PLj8IY7eOktJmccXgnr0O8i8bb4FMgorC2UgWaeR24WcU7hV9wk57u0VGI2c5Ir1ZR4qO9JdM068CzfEvYm+YvJOjwVw== +sidebar_class_name: "post api-method" +info_path: platform-api//seqera-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). +For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. + + + Request + + + + + + + + + + + + + diff --git a/platform-api-docs/docs/generate-data-link-upload-url.ParamsDetails.json b/platform-api-docs/docs/generate-data-link-upload-url.ParamsDetails.json new file mode 100644 index 000000000..336fa7f97 --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier.","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"Origin","in":"header","schema":{"type":"string","nullable":true}}]} diff --git a/platform-api-docs/docs/generate-data-link-upload-url.RequestSchema.json b/platform-api-docs/docs/generate-data-link-upload-url.RequestSchema.json new file mode 100644 index 000000000..4bb9685aa --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file to upload."},"contentLength":{"type":"integer","format":"int64","description":"Size of the file to upload in bytes."},"contentType":{"type":"string","description":"MIME type of the file to upload (e.g., `application/octet-stream`, `text/plain`)."}},"title":"DataLinkMultiPartUploadRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/generate-data-link-upload-url.StatusCodes.json b/platform-api-docs/docs/generate-data-link-upload-url.StatusCodes.json new file mode 100644 index 000000000..b2f6a6d64 --- /dev/null +++ b/platform-api-docs/docs/generate-data-link-upload-url.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","description":"Upload ID generated by AWS S3. Required for the `/upload/finish` request."},"uploadUrls":{"type":"array","items":{"type":"string"},"description":"Array of pre-signed URLs to execute multi-part upload. One URL per part."}},"title":"DataLinkMultiPartUploadResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/generate-data-link-upload-url.api.mdx b/platform-api-docs/docs/generate-data-link-upload-url.api.mdx index 08745cb6d..d7b57f454 100644 --- a/platform-api-docs/docs/generate-data-link-upload-url.api.mdx +++ b/platform-api-docs/docs/generate-data-link-upload-url.api.mdx @@ -1,13 +1,13 @@ --- id: generate-data-link-upload-url -title: "Generate data-link file upload URL (to given path)" -description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`)." -sidebar_label: "Generate data-link file upload URL (to given path)" +title: "Generate data-link file upload URL" +description: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint." +sidebar_label: "Generate data-link file upload URL" hide_title: true hide_table_of_contents: true -api: eJztV9tu4zYQ/RWCTwkg22k3LVA/ba5F0GQT5IJ9SAOYlkY2E5nUklQSryGgH9Ev7JfsDClZ8qV2su1DH/qSmORwZnjmckYz7sTI8v49T4QTnUyqJ8sfIp6AjY3MndSK9/mRAeHAMsHurs+Z06zIMy0SlsoMd3HtxsDmCpiwVscSbyTsRbqxPx3JZ1BsQELnKHOWDCJmc4hlOpVqhJpJF8sFiu8MEmmu8Ndgt/u7OtWGHXy+YTcfGgs2YkIxkSSSHBQZS3WW6ZdOkTMDXwqwjk0K/DMEZkE5JlIHhk11YYKZyv2xsCzWkzwDcnUHDYGKdaFQGNdoAYzRZpcemEo0I7+Cf0t1vYPKw8agF7Z6KCbteIB6klxL5bo84joHI8jPswSh/BUULeG4AuLOX7wzGUrmwogJ+mIoIDOucIE3GshQRFI4CCW+HKPjOfzWGYJUJvh0mUowKEuwSHwV7ztTQMRtPIaJ4P0Zd9OcrIRLvCyjxnCIwkarJDBPAMQdYaIThnchdtpMv9N2jPLkvshs826MrFe4kpy16Nqnv8XcizZPNhcxbDP2uRZkqpiAkfEWW5gDMPJHqTYT4cLWz/sL1i+NHKHNyvAYRLLR8YirIsvEMIOAaFk+BJAR/0OdTOlGrNGwcvRT5HkmYx+W3qOlV8xWVevhI8aLctBQvjoJlk6pWj55J1edWASGpJhOfSL4Gpt3iS4vo9qfc1AjzKI34LOs/4aKb61+JhUbTrE9tQ3devXbnL44uzhhJPI3mnegO+pGbNCGUMcOXAcVgphgDxs4eHW9PBNSYbuisHInHYWG1yV+UWROXgnjQq1fh0ihaLlcG37D5lrZAP+Pe3v0b9Hpy9949G/FN7yTGtM2qILv7OyYjaoOliDqVWfusuvqHdiJzfqWWCWoD1JRNz3bMiyMEVRw0sHErinXZY8OSJ4ClxvoWDlSaB3pyfMRvEJcOEAWQOg72FddnYzsUoFnMUSB0cEbYxaiQkFD6f11cTlsQvuO+DQJcM8nYK0YAfHv5rDVgut62vwpJ0ReK45/WJNQNUExpZEriUnRHy+9vyr9SbtT5MiE/fXHn2zeNxmGvdWzvaaUxCJ2cHWGdGCpXzXpMb8Y0c1mdNAmzADz+/9VLPHQYo4Z6aaerA9BGDAHBXW3+wfqyMjkY02Un2ufEp4/+7zXTDG9WcPtZVUv1PfBPNczQIGDAVKCc7nt93oil90400XStfAFg9aVerVR+hN2lQlHLZUdkTwFgZNTtc83BFoAoO35HAOyWFMQrYdeCHfCj9O6WT++OA8UBeO6oaCTV0Fj1SKFNK1liQ32ltp2q+SlSrV3qwpE9Tp6zraHE4wyxvk0CJMFEfssWgS1DSUmksw8B6X6Y3OAjlBEgp0fur/81N2jPQrsRPgkrJi8nu5aGd0eOKnv7GB7CsMwJcTu8jNa1P3/2P1Pxu4qkRt69sRDkZ9VpbjwzRPx/sKgXVUjlsyYyheFZ7OhsICkVZa0HeZDqtG6ufF+iq0PNgd046i61ucnmK4ZiJ9FVpAspzny7R5smV83OLA4IjfmH2hhZBhH34XGTj007LLNHy9rvaqnBjVtu1N724rl+wBqOfWWb5vvca36rCofULQa9t8H3OZAzb8mFlIknB0FHR3fZxuJFVptbhzEMeRuo2yb664ub26JJarPkIlO6I4RL/QdiH+989q/yZOP35vxTKhR4VmYB53EKWKRkpYoyGO2FmksVC9xq59AYbHWwDhaE+xl+Q0SHOWg +api: eJztV8lu40YQ/ZVCnzwAJXkW5KBTPF4CI56xYY8xB8OASmRR6jHZzeku2qMIBPIR+cJ8SVBNUqSWsWwghxxyktis7nr9annFpWKceTW+UwkyDjJtHry6j1RCPna6YG2NGqtjR8jkAeH2+gLYQllkFhNIdUZennlOsDoA0Hsba2RK4EnzPLyd6UcyMBGjC20ezpPJEM6sg6OvN3DzvtvsI0ADmCRafGMGqc0y+zQoC3D0vSTPkJeeYUrgyTBgyuRgYUsX0LTI5ughtnmRkaA4sA7IxLY0TI4S8UDOWfdGsKfaYKb/oACz2T4AT/XCZFQvjVJttJ9PgExSWG14qCJlC3IoOM8TNVa/kZFHOmnueBs23rpMRapAhzkxOeF6qQzmpMaqY0NFSgvTBfJcbdJ/smLWs9NmBjohwzrV5ASF8KIdJWrMrqRI+XhOOarxUvGiEDf1LlVV0cpz7CicgZnvnH8vyS22vB93prv9v8Tfk3UPvsCY9nn72hqCKXNyOt7nTBumGTkVqdS6HLle+uXDmvtLp2fatJ7nhEnY8TPkkTJlluE0o5rTqrqvaSbPH22ykB2xNUyG5S8WRabjkAijb16usdw+2k6/UcySCk7ShjV5eStJ+zmA3AaxzoxYgU1DVoZUX9XhUFVRi+eCzIznL+Fn8/wbqYGd54M2MF0w+b6jL+H4faA/nX86BTH5yckHNJwNI5j0KbQxEw88O8J8EsGE6QePigy1mbwZSlgVa5bQqLbSPpUZ6yt0XJfcdR0pVYntenWEBV9Y42v63x0eys866MvfVfRvxbe+p/SHfVTV2OH8BGZNI0lgumga5BCum3tAat3uztQkaAhS2fYe33OMzqFUnGbK/Y563UR0JPYSuMLRwOuZoUQEIHR8+kFxyQS5UD8o0HGbjHBpKOhEQQ7kxQtjVkdFglZF6sOuuHzsQvuK+HQJcKdy8h5nJAr3fNhaw11NbXWVU9GQLeDvdyRUqxNgLAOKoFGigvWHbevPls9saRL4+8+/YNU4wTrode1wUipmERxdnUOivfSrLj1WGyPZ2YmzlaDwvNv/X+WyipSnuHSaF0EzPxI6ckeldLe7e+nIOfHcivIWNqREEM+xGnXDxGjZSWzV1Iv0fXKPrRSXLhNJYC78eDTCQg/jzJbJ0NN3cjjUdrtRhjdwlSFLS4VjsZcgKAHVYr4R0moC+shXHIjHVoLkeRqMVNT8OWub9bcnDkRJMK47CTr9gTLdrEtI11o21OBwo233Sl6b1AZYTSCa28l19l1caNQx+cZYPGAcsmid1D6VlKPOggal9tfuRRUpiUjt5+3w7eG74aEsSmRzDFnYSHk7ZfVSuj/43V5fbOLuafX/k+xPJtkmKTupDSIiUVw2ZbX2hRCp8drs2lTWfaTmUorjO7VcTtHTrcuqSpbrYU/qrW1Uapxi5un5WD0/eO4E/UCLHfPtI2al2CoZCl8OYd80+gyC9Ym3838vD07Xw+Wr+DhoR4A3sOeLYCesdggwiz6eFm4vnNV9FbUz8usQPs/IaghfC0b97rg+YxDaU2expUbdjqM4poKfte1LxNXlzRdprs30nttE9jh8kg8ofKrB23Cn0LPD2lJlaGZlEC9VnymtGNc7+UbnDpztJHu5rC2+2AcyVbXinuVZaK+qfwABo2gj sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,11 +18,12 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; @@ -31,42 +32,35 @@ import Heading from "@theme/Heading"; path={"/data-links/{dataLinkId}/upload"} context={"endpoint"} > - + -Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). -For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. +Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/generate-download-script.ParamsDetails.json b/platform-api-docs/docs/generate-download-script.ParamsDetails.json new file mode 100644 index 000000000..49c600226 --- /dev/null +++ b/platform-api-docs/docs/generate-download-script.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier. Required for generating download scripts for private data-links.","schema":{"type":"string"}},{"name":"dirs","in":"query","description":"List of directory paths to include in the download script.","schema":{"type":"array","items":{"type":"object"}}},{"name":"files","in":"query","description":"List of file paths to include in the download script.","schema":{"type":"array","items":{"type":"object"}}}]} diff --git a/platform-api-docs/docs/generate-download-script.RequestSchema.json b/platform-api-docs/docs/generate-download-script.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/generate-download-script.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/generate-download-script.StatusCodes.json b/platform-api-docs/docs/generate-download-script.StatusCodes.json new file mode 100644 index 000000000..754d52e8c --- /dev/null +++ b/platform-api-docs/docs/generate-download-script.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"script":{"type":"string","description":"Shell script content to download files from the data-link."}},"title":"DataLinkDownloadScriptResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/generate-download-script.api.mdx b/platform-api-docs/docs/generate-download-script.api.mdx index 7a18bd247..dae16f6d7 100644 --- a/platform-api-docs/docs/generate-download-script.api.mdx +++ b/platform-api-docs/docs/generate-download-script.api.mdx @@ -5,9 +5,9 @@ description: "Creates a script to download files from the data-link associated w sidebar_label: "Generate download script" hide_title: true hide_table_of_contents: true -api: eJzVVt1u2zYUfhWCVyvg2dmWDZhv1jT9QbBiLZoOuwgMmJGOLCY0qZBUXEMwsIfYE+5Jdg4lSpYlOMmKAu2VLfIjz3c+nr+Ke7FyfH7FU+HF90rqW8cXE56CS6wsvDSaz/m5BeHBMcHqVeYNS81GKyNSlkmFW5k1a+ZzYO09TDhnEokHU7aRPg+7K3kPmi0J9BYxF+lyys6KAnTKlr+l0rolMxb/hkuXZMcVkMhsi7aVdJ6ZrDGIsEL43PW4kB2p+zymfMJNAVaQMxcpuvMGNH3Cy+bYZXAKYYWwYg0eLClScY0fCO/IIkSSHmSYH4r0snXceSv1iskUtJeZBEsULNyV0gLa97aECXdJDmvB5xX324LM1Kf4bjdpLW+MvXWFSKAzfVeC3Q5s/xWBTJdrsDLZN87eBZhQRGNgVmoPK7C4lRm7Fr5e+uW0RyRB4nSfUO4hKucddEQI9qGRgaE1tqofgjDtE9Z3ubBfWHmP79S9pRt1YUQ5CqXjPN820YRISLyx2y6cpE5UmQKLkdSnNkpBWCvIhvSwdnvr5voGb0dqe9xC/D6OHEG/MK8FhaYrjHYQAD+enNBPn8+73/GOxGCoaE+7oiiUTEJGzW4cQaqh7cYGppWl/POyNlDfO3y+Qw0uc1AqFpzG9qMKz5QigXvpFTRpSdnbT/YPjcukAIJPx5x+IVKKVnD+Kc53eX7F1+CcWAEV1OOaROBYTLeevLLW2AHxn0ZeK1Y7po1nQimzQT4BfTpE/2H8a1NiAf73739YW3Govu5lfbgpI9iEnb2/wKxx4lo1aUzqtwcndLJrAk2Z7s5/rVripoOktNJvQ/F/AcKCPSux0s+vFpQm2BlyQ/1jBXWzoC0+64rTrOpaxW5WazyL4UrZCfY+9pbSKjyce1+4+WwmCjlNlCnTqYM7fLypNMN8CDvsvRKeKjU7Jzw9BidykfsliVcLse9BqwVZjIWCvq8DCFfqP69jD7jZ+CCY1JkJxxvhGhZk9iGC5K5MMEVrML26SMKr953fdxkfXqrQgjLzvNtAIqRcbeeH6a8/T09orTDOr0UImqa2xtZ+WBwPyVZdEH77003ztB4++VmhBPYV1CZoXDVR2hvvJnzeG2k6hWKoYjzlKC2dq6pr4eBPq3Y7Wq7bFQVwrAB8nmF9gCP6Pn44GXXkFraDUeheqJKQnNrq45l8+dnkiAeHM9T/9OGz5pYj9JqJ6TNZPXVgOUIojkkdowV9WEmUnhiC38WnfcYeGNNHCcVhSm/3+bTKdcm0WyA6B5FiSSWGNeAsSSAkWDw66Hq99vLm1UfEin7dPqjT4fZRWpiwAfHR3ILGpI0sPX0Twd3uP/MG3qE= +api: eJzVVttu20YQ/ZXFPLUAKzmp0Qe+pI5zgdGgCeIUfTAEaE0OxbWWu/Tu0KpAEOhH9Av7JcUsb6IkyHaDAO2TxN2ZnTNnrjWQXHmIbyCVJH/Qyqw9LCJI0SdOlaSsgRguHUpCL6RoTwVZkdqN0VamIlMavcicLQTlKIZ3hPTeJkoSpmKjKA+3K/WARixZ6IMy66t0ORMXZYkmFctXqXJ+KawTy1fh0SXb8SUmKtsKKbTyJGzWGbROlJJyP8HCdpSZ4phBBLZEJ9mZqxRieI+GP/FNp3YdnIIISulkgYSOGanByAIhhhEsRKCYDzYM+yS9GRz35JRZCZWiIZUpdAzB4X2lHKYQk6swAp/kWEiIa6BtyWZaLWiaaLC8sW7tS5ngaPq+Qrc9sP17LyhMVaBTya5x8TGISc0wDswqQ7hCBxFk1hWS2qOfzidAEofhPan9Y1AuR9EjRIjPHQ0is06s2kCwzBDC9i0f7kunHiTtxNIfdeEIc5xKp3F+6LIpVQ4Tsm47ppMyia5SFH0mTaEdhSCdk2xDERZ+59ze3mFC0OxiC/n7NHAs+o1xLTg1fWmNxyDw8uyMf6Z4Pv4CESTWEBriW1mWWiWhouZ3nkXqQ9udjQhKx/VHqjXQvnsYvn0OrnPUum84ne0nNZ4ZZwKQIo1dWXL1Tov9c+cyM9BEcH7M6dcy5WxFT89xfqzzGyjQe7lCbqinOekFj+X04Mlb56w7AP7jkWj13U4YS0JqbTeYQpA+P5T+1dI7W5lU/P3nX2LoONxfd6o+vJSxWCQuPl2JVHl5q7syZvYHxYg1xyHQtelR/7/KZROBx6Ryirah+b9G6dBdVJRDfLPgMimQcsvzY4XtsOArmI/NaV6Po6KZtxzP+3Tl6kT30M+WymmIIScqfTyfy1LNEm2rdObxHp2cKXtYD+FGfNKSuFOLS5bnYACD67FfM3ktEbseDFywxb5R8PdtEIKo+/OunwF3GwqEKZPZoN4R16Fgs48BZHdVgr4T5qjLJER96vyuy1hIpcMIyuzP40UTATPX2nkxe3H2cnbGh6X1VMiQNV1z7Wf7fnfcR1uPWfj/X2+62BL+QfNSS2WYm0By3aXpZL+LIJ7sNCNDfa4uIsitJ9ar61vp8Tenm4aP23nFGdy3AIgzqT2e4Pfp28lRR9a4PdiFHqSuWBJ4rj4dybdfTk54sL9E/UsfvmpxOQGvW5m+EtVzN5YTgPo9aUS04A+nGNIzU/C7PrTfi0f29KOA+m3KbHfxDMyNxdQsmghylCm6gLAVuEgSDAXWqx6Mvcl8ef/2C0Qgp417r1GH14/CqutW4otdo2maASXxNwNsmn8Awdrexg== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Creates a script to download files from the data-link associated with the given id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/generate-download-url-data-link.ParamsDetails.json b/platform-api-docs/docs/generate-download-url-data-link.ParamsDetails.json new file mode 100644 index 000000000..eb50ddf11 --- /dev/null +++ b/platform-api-docs/docs/generate-download-url-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"filePath","in":"query","description":"File path to download within the data-link (e.g., `folder/subfolder/object`).","schema":{"type":"string"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier. Required for generating download URLs for private data-links.","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}},{"name":"preview","in":"query","description":"If `true`, generates a URL for preview purposes. If `false`, generates a URL for direct download. Default: `false`.","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/generate-download-url-data-link.RequestSchema.json b/platform-api-docs/docs/generate-download-url-data-link.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/generate-download-url-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/generate-download-url-data-link.StatusCodes.json b/platform-api-docs/docs/generate-download-url-data-link.StatusCodes.json new file mode 100644 index 000000000..20838fb4b --- /dev/null +++ b/platform-api-docs/docs/generate-download-url-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Pre-signed URL to download the requested file."}},"title":"DataLinkDownloadUrlResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/generate-download-url-data-link.api.mdx b/platform-api-docs/docs/generate-download-url-data-link.api.mdx index eaeefda54..74bd5d907 100644 --- a/platform-api-docs/docs/generate-download-url-data-link.api.mdx +++ b/platform-api-docs/docs/generate-download-url-data-link.api.mdx @@ -5,9 +5,9 @@ description: "Returns a pre-signed URL to download files from the data-link asso sidebar_label: "Generate download URL" hide_title: true hide_table_of_contents: true -api: eJzVVttuGzcQ/RWCTwkgr9zWLdB9qhPHgdGgMRQHeTAEiNqdlWhT5JrkShUEAf2IfGG+JDPcm1bayE7QIumTtOQZzpnhzBluuBczx+NbngovTpTU946PBzwFl1iZe2k0j/kIfGG1Y4LlFk6cnGlI2fvRG+YNS81KKyNSlkkFjmXWLJifA2vOY8I5k0jh0WYl/TzszuQSNJsQ6A1irtJJxG5wnQ5NhGZTYIVDg8xYlkoLiW8cOYZryGMpYcXywubGgYv4gJscrCDGVylyfg2aPuGiMntv1UXlDbG5sGIBHizFvuEaP9CmpYMQSZHnws/5fjoumtCct1LPmExBe5lJsMTDwkOBlJGEtwUMuEvmsBA83nC/zslNacW320HjmZJ3XfoKfh8KsOsDx5eIYkSpk3hKqtR7SX8G0SwasElmVAp26Ipp9c9M7zCbk+fE9CnMEoyEohPKtWnpp/eyhfZkho2qvIRLnZXXQ5gmELx8FzZzK5d4dW047qlsV8beu1wk8BjXDzWQ6WIBViYdqm8DTKhet1J7mIHFLeS6EL5c+u2sQ6Qq0OMkrjI2oRqZDOp8ADUZNUHWV+SMDDJM75cs9lolYheQiUL5uDbrDWhqjAKhkf+YqtflRqM3Avx8eko/XdZv/8RDEoNZ0J52RZ4rmYTOG945gmwOfZRlR51nqU+9LB0UVh1e6H6arr8sOlT01G/gSF6oiyK6Bu6lV1C1KnX0jgqMqgARR8izvhBfiHRUnvo1obaNf8sX4JyYAWnp8QzUwL6ybsJ4Za2xB8R/6bmbWgOZNp4JpcwK+QT02SH6L+MvTaFT9umfj6xpHdLXna4PJ2UEG7Dz6yusMSemqmpjyn9jOCDLVoKogkmrGvsfNZe46SAprPTrMA1egLBgzwuU4/h2TE2Bo2JuaKrMIHglpY75sNWn4aadHdth3ZondZ2eUJ2TF7usR06ofD73PnfxcChyGSXKFGnk4AFtI2kO2uBd2GHXSngSHvaS8HQlnCjWEbyjFJbp2I2jyQh5rEUgNH8A4Ur557KWtLuVD2mTOjPBvEpfxYLcPkaQwpUJClQJprsXiW/avgl+N2S8fqmCombmj3YDiVDmSj8/Rb//Gp3SGsqiX4hQOpXu1mO/M1X2mW7aOvyfvG2qy/Pwtx/mSuBMwegr8SyrsfOCG/C485bpL0ismjkmkGw3m6lwgOq43dJyOa6oTOtu53EYIEcS+W8/TnpDvod197W0FKogGKfZ+3Sy//FT5Qj3/ffUNwbw9PfLES7d19I3Mvk+j5gjUbVPrzaiMX1YSSF9ZVk/q2vhOXvk3d9LqVoUer3Lp6a606TbMaLnILANAsMScJ4kkPsd04Op2RlPr1/dIFZ0FX9P4cPpvbRQBALixtyDRiGoWXr6JoLb7WdSYe9S +api: eJzVVs1u20YQfpXFnBKAppzU6IGnOnEcGDUaQ7HRgyFAK3IorrXcpXeXUg2BQB+iT9gnKWb5J0qM7AQJ2p4kkjM73zc738xswfGlhegeEu74iRRqZWEWQII2NqJwQiuIYIquNMoyzgqDJ1YsFSbsbnrNnGaJ3iipecJSIdGy1OicuQxZdx7j1upYcIcJ2wiX+a9LsUbF5mR0LdTqKpmH7DZDf2jMFVsgKy0mLNWGJcJg7LpAlmlDONYCN6woTaEt2hAC0AUaToivEojgIyp6xIvG7c7IiyYaBFBww3N0aIj7FhTPESLo4UAAgpgX3GWwn46Ljpp1RqglEwkqJ1KBhnAYfCyFwQQiZ0oMwMYZ5hyiLbingsLUXlBVQReZkndTx/JxH0s0TweBL4VERpAGiaekCrWX9FcYLsOAzVMtEzQTWy6af3rxgLGbvyakL0EWG/TsuLR9Wsbhve9NRzLDpk1e/KUu6+shm47I3fTa+o+FEWvudujYl6LdaLOyBY/xOay/t4ZMlTkaEQ+gfvJmXI6GFcrhEg0EkGqTc1e/+vlsAKQp0OMgrlI2pxqZB20+kERGIkjHipyRQ8ql/ZLHnlRCdoEpL6WLWrdRQgutJXIFVTWj6rWFVhYtGbw9PaWfIepPv0IAsVYOlaOvvCikiL3yJg+WTLaHMeqyI+UZ0qkTdYDSyMML3U/TzZebDhU96Q0ttRdSUUjXAE44iY1USdE7XWDaEISqIsuzMYrveDKtT/0aqr3w7yFHa/kSqZcez0BrOFbWHY0PxmhzAPynkbtpeyBT2jEupd5gAt767ND6N+0udakS9veff7FOOtRfd1TvT0rJLGDnN1csEZYvZCNjyn/nGJBn34KogqlXdf7/1VxWAViMSyPck58G75AbNOelyyC6n5EocnSZpqmyRB+VOnUEk74/Tbb97KgmrTRP2jo9oTqnKGbdjhxf+ZA5V9hoMuGFCGOpyyS0+IiGh0IfyOCz/8JuJHfUeNh7sqcrAYLYMvhMKazTscujywhFbJuAF783gqD5c9m2tIeN82kTKtXevUlfg4LCPgeQ6IoYbWNMd89j18m+I79LGXMupO+oqf6l/1AFQJmr47wJ35y+DU/pZaGty7mvnabxtnN/MFb2oW77QvyfLDfN7Tn8w00KyYUi9k33rMtxsMIFEA2WmfGKnAWQaevId7tdcIt3RlYVva7nFdVpK3eI/AQ5ksjvvZ2MUl7h03BdWnNZkhnQ8H052B+8qxzBvr9QfSOBly8wR7AM16VvRPLvbDFHWPW7V89oRg9GEKWvLOtXbS28Zs8s/qOQmpdcPe3iaaHuiLSaVQFkyBM0HmFtcB7HWLgd14OxOZhPHz/cQgB82PL3Wrw/fRTWdltb3OoVqqrqUDp6JoBV9Q8n9+93 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Returns a pre-signed URL to download files from the data-link associated with th id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/generate-random-workflow-name.RequestSchema.json b/platform-api-docs/docs/generate-random-workflow-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/generate-random-workflow-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/generate-random-workflow-name.StatusCodes.json b/platform-api-docs/docs/generate-random-workflow-name.StatusCodes.json new file mode 100644 index 000000000..ec601b71a --- /dev/null +++ b/platform-api-docs/docs/generate-random-workflow-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Generated name","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}},"title":"RandomWorkflowNameResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/generate-random-workflow-name.api.mdx b/platform-api-docs/docs/generate-random-workflow-name.api.mdx index cd234a577..bc03f0f22 100644 --- a/platform-api-docs/docs/generate-random-workflow-name.api.mdx +++ b/platform-api-docs/docs/generate-random-workflow-name.api.mdx @@ -5,9 +5,9 @@ description: "Generates a random name" sidebar_label: "Generates a random name" hide_title: true hide_table_of_contents: true -api: eJyFU01v2zAM/SuGzpmdfR2W07JhK3rZirbDDkMPjMzESmxJlehkgZH/PlJ2EqcZtpO+Hh8fH6lOEayimv1SOxc2y9rtonqaKOcxABlnb0s1Uzdo5Yj3YEvX/ByA36BBNVEBo3c2IpN06s10KkuJUQfjhWAUXma2D9HOEloSJHhfG51SFeso8E5FXWEDsqO9RyZwizVq4kAfRBiZPlliO6MiBWNX6nCYKDJUy9W14PtBLcME+G769lrv92PxmXWUQc2hWCbeiLoNhvbsV6c+IQQM85YqPj4d2LW/lx0zyEIScqy/QaqcGLvCVBUIhSqOHSh69KsBHTFsMcSUsw01IysiH2dFAd7kunZtmUd85ly5ceqliof0kt3VQEsXmuyz4LP53a0SxceCHsTy3tVxWSdvJaNISTA+LxKIb/rNV2YG7qda7ygZZezSpfChEYMKSfs/gVKu0exaD5ZZAZ1m5bL4cck8LkbeJO3H8wMLEef6PK/zD+/zqdx5F6kBex6hf7TqQuvJDsLfVPgajBW+pKsb2nj+SPI3Ro1ktytOLIiuW0DEH6E+HOT6ucUgI8XbLQQDC7GMJ4oDEEq2WTq/QYaoudboZWa2ULei5Or/SFdP83Xz5ZGxcNnLF71L7MMT2P2Im2UmxKPboGWpk0EEyZkT8Q/6A5OWdno= +api: eJyFU0tv2zAM/isGz1qcdjv5tKzYil62ou2wQ+ADY7OxEltSJTpZYOi/D1ScV4NtJ8vSJ/J7UAMwLgMUc9hav35t7TZAqcA68sjamocaCrgnI7/0hKa23a8R+B07AgWegrMmUIBigNvpVD41hcprJwXOrteZ2V+prGEyLEh0rtVVapWvgsAHCFVDHcqKd46gALtYUcWgwHkhxnrfLFU7oQJ7bZYQowLW3MrWNeGnkS3EKMBP04/XfH8cxGfGcoZta7dUp7qBqt5r3kExH+ALoSc/67mBYl7GUv1Fdsgw84nIQX9H3FgxdklJFUoJyA8J5Hv0hxEdyG/Ih9Sz9y0U0DC7UOQ5Oj2pWtvXk0Bv5HGiLbxn8ZxOsscW+dX6LrsTfDZ7fABhfBD0LJbvXT2XdfRWOgqVBIMCFgkEalx8s75DhgJWW05GafNq0/UxiJGFtP0fQZGrKwojWGYFqzQrl+LPJVOHWs6k7efTQVQgzu373ExupreTqWw6G7hDc5qhf2R1QfboB9Nvzl2L2ki9RGwYczy9JHkcZ0mWChobWBDDsMBAP30bo2y/9eRlpkoFG/QaF+LZvIwKGsKafIp+TTsoYFZV5GRoNtj2wuTqAUmsxwG7//oCCvAyzHfhperjEZrdWe1h2CNe7JpMjKBGEiz/EMsY4x/Ir3af sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ Generates a random name - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/get-allowed-dynamic-labels.RequestSchema.json b/platform-api-docs/docs/get-allowed-dynamic-labels.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/get-allowed-dynamic-labels.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/get-allowed-dynamic-labels.StatusCodes.json b/platform-api-docs/docs/get-allowed-dynamic-labels.StatusCodes.json new file mode 100644 index 000000000..e3c17389a --- /dev/null +++ b/platform-api-docs/docs/get-allowed-dynamic-labels.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}},"title":"AllowedDynamicLabelsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx b/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx index 1f3238713..a74a7c047 100644 --- a/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx +++ b/platform-api-docs/docs/get-allowed-dynamic-labels.api.mdx @@ -5,9 +5,9 @@ description: "GetAllowedDynamicLabels" sidebar_label: "GetAllowedDynamicLabels" hide_title: true hide_table_of_contents: true -api: eJyVU8Fu2zAM/RVD5yDOiu2wnJZ2XVFgwIq2Ow09MDKbKJEtVWLSGYb/faTkpEmQrdjJsvTI9/hIdopgEdX0l7IwRxvV00g5jwHIuOa2UlN1gzSz1r1i9bVtoDb6ewaOVMDoXRORwzt1MZnIp8Kog/ESzbE/1gzTriFsSF7Be2t0yl2uokA6FfUSa5ATtR45yM1XqIkDfRAlZDLBFuwmnwYchAAtwwxhfXgfKZhmofq+HykyZOXuXAX3g3xBMvTjuQIuoSru8YWJ6X8qCRxiAlbia40xwgLF2H8XuAOeqeStkOsQXDhSzo8R9SYYapmuU5cIAcNsQ0v+feqZ9rikv/ezRlo6afkCkzqQFKrMg1FWGV1CDlZCG7YYYmLdBMvYJZGP07IEb8bauk01jvjCwzQ2Tp3qeEgvxZ0FenahLq4EX8zubpVo3pX0IJ5mfw4L21skjCIlwfh/nkB8kw/fODNww9TqlZKPpnl2KXzwc1AhtO8JlHKNxjiAZRhAp2E4Lv6wZJ4HI29C++XtgYWIc5nnw/jzp/FE7ryLVEOaJfYac7OKoVvF0K5i368juXtHCH9T6S2YRlImad3Qy/2Sc2xOxqddP9n0JfMLquvmEPFnsH0v1zz+QWaLj1sIBubiHI8WByBU7LYMwBpb2TOt0cvwpG2VJT3dE2nuftBurh9FwXFLT1qYsu9WvmkPcrPMhHh0a2xY6mgQQfLPRLwbfwDzwKzy +api: eJyVU01v2zAM/SsGz0KcFjv5tHbrggIDVrTdKfCBsdlEiW05FJ0uMPTfB8pOmgTZhp0sS0/i+yB7EFx6yOZQ4YIqD7kB1xKjWNc8lpDBjOSuqtw7lV/3Dda2+D4ADTD51jWePGQ93E6n+inJF2xbvQ0Z/NiAgcI1Qo3oKbZtZYv4drr2CunBFyuqUVeybwkycIs1FQIGWlYmYocCO6y6YTXikBn3YMAK1af7Xtg2SwghGBArle5dU/A80ldkMPDpmoB7LJNn2nbk5X+UMG07y1SqrzV5j0tSY/8u8AC8ouRDyAOz4zPmwYCnomMre8jmPdwTMvFdJyvI5nnIzYWkP+dZk6ycRr6kyA71CUiHxkjLAZ3icBm0LO+IfazacQUZrERan6UptnZSVK4rJ562xDixDi55vMST5KlCeXNcJ18Un9w9PYJyPkh6UU8Hf06FHS3SikolwiCDRQSBGRffHNcokMH6XaKPtnlz8fro58hCy/6LoMq1BfkRrM2ARWyGc/GnkqlGq2da9vPHQTCgzg11biY309vJVDdb56XG2EwNRj0zkmSMKxnzSo6BnfE9WiL0S9K2Qtvok5FbP4Z5nHIDY5xg4BBobmDlvCiq7xfo6SdXIej2tiPW5soN7JAtLtS6eR4MrAhL4tgBG9rroBUFtdo9cVx1Si8HRdM9dtrs4VUZnGd6kWF8/TDzzf7k7b4fEK9uQ00IYEYSov8Q8hDCb16erRc= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ GetAllowedDynamicLabels - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/get-data-studio-checkpoint.ParamsDetails.json b/platform-api-docs/docs/get-data-studio-checkpoint.ParamsDetails.json new file mode 100644 index 000000000..e07158960 --- /dev/null +++ b/platform-api-docs/docs/get-data-studio-checkpoint.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"checkpointId","in":"path","description":"Checkpoint numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the checkpoint is retrieved in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/get-data-studio-checkpoint.RequestSchema.json b/platform-api-docs/docs/get-data-studio-checkpoint.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/get-data-studio-checkpoint.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/get-data-studio-checkpoint.StatusCodes.json b/platform-api-docs/docs/get-data-studio-checkpoint.StatusCodes.json new file mode 100644 index 000000000..5459fdf46 --- /dev/null +++ b/platform-api-docs/docs/get-data-studio-checkpoint.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["author","dateCreated","dateSaved","id","name","path","status"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Checkpoint numeric identifier."},"name":{"type":"string","description":"Checkpoint name."},"dateCreated":{"type":"string","format":"date-time"},"dateSaved":{"type":"string","format":"date-time"},"author":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"path":{"type":"string"},"status":{"description":"Checkpoint status.","type":"string","enum":["empty","interim","finalized","invalid"],"x-enum-varnames":["empty","interim","finalized","invalid"],"title":"StudioCheckpointStatus"}},"title":"DataStudioCheckpointDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx b/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx index c28bafcfc..65aa71c80 100644 --- a/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx +++ b/platform-api-docs/docs/get-data-studio-checkpoint.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the given Studio checkpoint ID. Append `? sidebar_label: "Get Studio checkpoint" hide_title: true hide_table_of_contents: true -api: eJzNVm1v2zYQ/isEP62AY2dbNmAGhjVN2sIY0BVJi34IApSRzhYTmVTIk1PX0H/fHfVi2hKSONiwfUlM8Y733Ntzt5GoFl5Or6THMtXWy+uRTMEnTheorZFTeQHoNKzAC8xApIBK517YeTgu9AqMuAy6IskguSusNihm52NxWhRgUvH1jwfr7nyhEpilv38VaMUCUKhYXBs6d2IisQbhG47lSNoCnGIks5SwvAc8V6hqe2edPskVyqklIDh2ZiMNHUjeg/e17khqdqZQmMl9Dxv4jbDw5K9ZCJ2CQT3X4BiHg/tSOyAQ6EoYSU/ol0pONxLXRTAVtGRVjTrrWwefALD1RJhyCU4nh1onVViAI9G5dUuF9adfT3bwRHlo4dyX4NY9PF+6TAzAEV8ySrldakRIR6EK4kx64ZqCSTmtfF16cHFOD0F/zc77whrKDmv8dHzM/3bx/vUnqQYDVAt0q4oi10kom8mtZ5FNZHQbzCupSswsG04VwpkD+ps2p0u1Cr81/wkRHLXZ86iwDK3SOGBvbiEJZei4YFHXYEn1GU4eWA1Vg6ZXeo+9QwpBM3Zz4IEOGcsdoSYzVRyNZ6s0cd2P9oqalyNAmdB5G1sujw/s0T8Uzyp6st+frfGhmwbfUFNL1Jjzp8/09MzMLcuHchh6qCmQXqFGKalFuB32IwqUdY4WLAtch0YlWtNLdlQblevvdVmaFf1OOWjfjljlaKUc59kfpNu6tU+pl7UHsedDzHuOFIiKpU6GGvONSi8o/+DxpQ1K/ni1eEZttIKPJu+tc9ZdNHzSAf95gFHasSOMpVmV5/YB0tBBJ8cnffEPFt/Z0hAdPjA5MunV81RYN8CQ/Oac5fm60zj9OOPLVHt1kxN7zhvdjrb/rzHkgoekdJpKjofvG1AO3GnJzXF1zRROkzmzPMBp8rc0OpWTZueYbLo5XU22kaLv8QStmHjBrdoRXzpqYpkhFn46mahCj5PclunYwz3lbqxtf86HG/ExV8iUIc5YnsMuGWPrwiXHsI5H7EgXErbYDjE+3wQh+lL/eNeS0e0DhrhpJgtWbzutRsFmnwLI7uqENq9amJOvkpD8Xedjlxt2C2Zfby8ICEeutvPj+LdfxseBwazHpQq10ywJtGL197l9pJttIf7H+2GTFD5OilzRUsP07wK/12W2XW1HchovhFGl8dXOtkb1kFFoWHuzuVEePru8qvhzvTFxAbaNKqdzlXt4JET/8j41GIM7WPdWPmL9kiVDvdO40Iz/QF9+uGiY5ZV4zt48iK35qMw6BtVi3uaId9cXIXtyoX4BrJ36qK5JPgOVUudz/GqR0ySBAiPlHkfvkOH7t59kvSpF9LJHJ+H1QWBUl0Hik70DU1UdTuQzA6yqvwHQ4M5X +api: eJzNVt9v2zYQ/lcIPm2AYrtdsAcBw5YmbWAM6IqkRR8CA72IZ4uJRCrkyakr6H8fjvph2RaSONiwvSSmeMf77rvjx6skwcrL+EZ6KpW2Xi4iqdAnThekrZGxvEJyGtfoBaUoFBLozAu7DMuVXqMR18FXJCkm94XVhsT8YiLOigKNEt9+f7Tu3heQ4Fz99k2QFSskAUNzbQSI3kwk1hB+p4mMpC3QASOZKxnLS6QLIGjinff+MpIFOMiR0HEylTSQo4ylR+8b30hqTqYASuV+hi381lh4ctqshFZoSC81Osbh8KHUDpWMyZUYSZ+kmIOMK0mbIoQKXrKuoz76NsFnAGwzEabM0enk2OjaEK7QyUgurcuBmk+/nu7gGdShg/NQotsc4PnaV2IEjviaohE210SootAFw0p64dqGUVxW3i49umFNj0G/4OR9YY1Hzx5vZzP+t4v3rz9lJEMAQ7wLRZHpJLTN9M6zSTUIuiXzRkJJqeXACgjPHQKhalfXsA6/Nf8JDEZd9TwBleGqtAnY2ztMQhs6bljSDVitXpLkkd1Qt2gOWu+pcyDH4DlMc+SAHhnbnZDOsXNq2HixS8vrPttrIGAGMAedddxye3zkjP4hPuvBkYf3sws+ttPiG7vUkjRl/OmLRzc3S8v2oR3GDmob5KBRByVpTPg67DOKpsyZLcwL2oSLSuh0zolqA5n+0bSlWUOmFZP2/YRdTtbguM7+KN8urX1JvW4yGGY+prwXZGVds9Xp2MV8B+oKH0r09NoLmqP3sHpBb3SGTxbvvXPWXbV60gP/ZURRumdHGEsCssw+ogo36HR2emj+0dIHWxoViUcWRxa95j0V1o0oJJ+5ZHve7j3OPs15U2kPtxkqsWx9e9n+v3LIDY9J6TRtwuP7DsGhOyv5ctwsWMJzpNTyA75C6mQ0ltN25phW/TtdT7dM+Wk1fEFrFl506+6JL10mY5kSFT6eTqHQkySzpZp4fEAHE20P3/mwIz5lQCwZ4pztmXbJGLsUrpnDho9hIj0lHLF7xHh9G4xk1P740InR3SMF3jSLBbt3N61BwWGfA8jp6gR9a8zFhyQUfzf5YcqtuoWwf2w36kgyc02cN5M3s7eTWZAw6ymH0DztlHCJdDjQ7UOttp34Hw+IbVV4OS0y0CbovwsC3/TZdraNZDycCAetxls749oikqn1xN5VdQsev7isrvlzMzJxB3Y3VcZLyDw+QdG/PFCNcnCPm4OZbw1ZyZah4dfgNOM/Mpefrlpp+Vm8ZHAexdZ+BLMZguowb2vEw+urkD07Ub8C1k5/1Is6kimCQhf4a0zOkgQLGjgfiPSOGl6+/yybWWmgL3t6Ek4fBVZVjcVne4+mrnucxGsGWNd/A9Yjznw= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the given Studio checkpoint ID. Append `?workspaceId=` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/get-workflow-log.ParamsDetails.json b/platform-api-docs/docs/get-workflow-log.ParamsDetails.json new file mode 100644 index 000000000..752b64b46 --- /dev/null +++ b/platform-api-docs/docs/get-workflow-log.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"next","in":"query","description":"Workflow log cursor","schema":{"type":"string"}},{"name":"maxLength","in":"query","description":"Maximum length in bytes of the log to retrieve","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/get-workflow-log.RequestSchema.json b/platform-api-docs/docs/get-workflow-log.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/get-workflow-log.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/get-workflow-log.StatusCodes.json b/platform-api-docs/docs/get-workflow-log.StatusCodes.json new file mode 100644 index 000000000..5bb77082e --- /dev/null +++ b/platform-api-docs/docs/get-workflow-log.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"log":{"type":"object","properties":{"truncated":{"type":"boolean"},"entries":{"type":"object","title":"Iterator_String_"},"rewindToken":{"type":"string"},"forwardToken":{"type":"string"},"pending":{"type":"boolean"},"message":{"type":"string"},"downloads":{"type":"array","items":{"type":"object","properties":{"saveName":{"type":"string"},"fileName":{"type":"string"},"displayText":{"type":"string"}},"title":"LogPage.Download"}}},"title":"LogPage"}},"title":"WorkflowLogResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/get-workflow-log.api.mdx b/platform-api-docs/docs/get-workflow-log.api.mdx index 7e0066bba..1ec7a48b3 100644 --- a/platform-api-docs/docs/get-workflow-log.api.mdx +++ b/platform-api-docs/docs/get-workflow-log.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the execution log output of the workflow identified by t sidebar_label: "Get workflow log" hide_title: true hide_table_of_contents: true -api: eJy1Vstu2zAQ/BWCpxYw7LRNC9Snpq8g6CtIUvQQGCktrWUmFKmQlB8Q9O/dpaRIilUHLtCTZe2QO7sczqrgXiSOT6/52ti7hTJrx2cjHoOLrMy8NJpP+QV4K2EFjvklMNhAlFOEKZMwk/ss98wsQqzZhMkYtJcLCTGbb0MokSvQ7HeDOIt/j/mImwysoM3OYkx0Cv5XHf9qEgxnwooUPFiiWHCNfxDW7oEQSQwz4Zf8Me1mK+aQvk5aThahFu5zaQGzepvDiLtoCang04L7bUZJqkW8LEe9vC4TEbSJ73Ow28HMAch0noKVUT/3Ti6pPSQhtDA2Fb569ea4l13Dxj+dNhRMBxPl1pnBbAOVpWLzFXQSmrgnwTexkWmeMhWwTGo8XI+yqE+f0nrDbC2XAyud0aG4zGgHjla8PDqinz6DH19waWRwF+0pKrJMySgoaHLrCFLsJjXzW4iod5klvXlZJUC6T4NQHRr3J6E8QOfGKBCalyOONGyDfLSPl17RizNPEjf25jL0/YaWWVhLHV+ZO9ADBxOasxZ2DyADHdPjIKkUnBMJDC6MzVorI+IuZWGtoMOWHtLBUvotcWIF34NuhphL9fdgLF2mxPaKlDykx4ee4e0/xwrGH2u2GNyN9lZ0fOOiVhEtQsTxkI7ei5iRBYDzhwiqdY3rhy6jbvf36+/H0eH/yVpjd5i/GrgBjWMybTwTCmuGOGzl0Jet9Ntgle9BWLAnOV7p6fWMLhf66NKQyyYQOJJlTvmkMdNJ0dpqOVHBfh3YVeO9uVUIX3qfuelkIjI5jpTJ47GDeyQ0lmbHLS5DhJ0r4emysw+EZyfnZ5zoNGwvqblVo7qcH3pFGRsnCToPIHxTPXxubOR27UMXpF6YsLxubM2C0j5FkMqVEfpZBSZViCiool98t2QUhlTBxRbmXRtAItS5Ks+L8dvX46NwbY3zqQiiqp0XR147Nauu90gWrTj/5xyum+3xZk7wisrgI6HqolZK+4WA8GlvBBNtPNElFke4opgLBz+tKkt6XY0SkhBefzFXdHsWQjnYU+kTA3SQ7R1sd2b0SqickJxm3WHpdwfpnqz1bP7HdAeP1T1MupO8pTOjP1YSnwNP4tlFbXnP2d7vqUFKzXzR2y6b7lHVGipniF6CiHEv4lcBTqIIsm5fd8y552unn64QK/r28cguwu6DtFC1ARFmLiq3YenDDEaCZfkHfQbgSg== +api: eJy1Vk1v4zYQ/SvEnFpAsLPbRQ86Ndtug6BpGyQpegiMXVoay0woUiFH/oCg/74YSrKktdaGC/RkWTPkezN8fKMKSGYe4mfYWve60nbrYRFBij5xqiBlDcTwgOQUbtALWqPAHSYlR4S2mbAlFSUJuwqxbhOhUjSkVgpTsdyHUKY2aMSXLuM2/TKDCGyBTvJmtynEcIP0bxu/sxlEUEgncyR0TLECI3OEGPo9IALFDAtJa/iWdreV8OSUyXpODiJw+FYqhynE5EqMwCdrzCXEFdC+YJBmEdR1NML1hUywB34r0e0nkUOiMGWOTiVj7CMsZQizEFpZl0tqXv38YYRucEfnYUPBfDBJ6bydRJuoLJe7OzRZaOIJgD/lTuVlLnTIFcqI5Z7Qd6fPsGSFa+VyYaULPhRfWOPR84r3V1f8M2bw9x8QQWINoSGOyqLQKgkKmr94TqmOQe3yBRPuXeFYb6QaAG2z80nkSpNIYqEcUpfWapQG6gjQcK1+ah9SpPnFLbHErfv8GPr+mZc53CqTPtlXNBMHE5qzle5EQoEm5cdJUjl6LzOcXJjardFWpkPK0jnJh60I88lSxi3xcoN/Bd1MMVf6+8FU+ULL/RMreUqPh57d2exeZjj7rWUL9UR0tGLgGw+tinhRHcGHKR19lKlgC0BPlwiqd43nQ5cX0Zl+ff84Bvw/OWfdEfOfJm5A55jCWBJSa7vFNGzlMSmdon2wyo8oHbrrktYQPy/4cuVIa8sum2HgyJYZw7wz03nV22o918F+PbpN572l0xDDmqjw8XwuCzVLtC3Tmcc3dHKm7JFbPIaIuNeS+LKLXzlfXN/fAtPp2D5yc5tGDTkfesWInZMEnYckiNqH3zsbedlS6IIyKxuWt41tWTDsOYJcrkrQt8msCpkEVYyLH5aMuVQ6uNjK/tIH6gi4cw3Ou9m7q/ezq3BvradcBlW11nuD1I/Npu0jllWvzv9zELfdJtzRvNBSBSMJZVetVPpPBIggHs1gpr2IYG09cV5VLaXHf5yua37dzBLWUKq8XGq+PiupPZ6o9MwEnWT7ivujIb2RuuRM4GF3GfzxJD2B2g7n/wh38Vw9wWQ4yns6C/7jFPO58CR+eGg970dx8oNqklI3YMx+yGZ4VK2G6kUdwRplii7waxKukwSLYV+P3HlkbDefniACOfaPb/wi7D5Jq6qajDB06/rAksIQrhd1XX8Fm1ngbw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the execution log output of the workflow identified by the given `work id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/get-workflow-task-log.ParamsDetails.json b/platform-api-docs/docs/get-workflow-task-log.ParamsDetails.json new file mode 100644 index 000000000..ec74378cd --- /dev/null +++ b/platform-api-docs/docs/get-workflow-task-log.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"next","in":"query","description":"Workflow log cursor","schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"maxLength","in":"query","description":"Maximum length in bytes of the log to retrieve","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/get-workflow-task-log.RequestSchema.json b/platform-api-docs/docs/get-workflow-task-log.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/get-workflow-task-log.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/get-workflow-task-log.StatusCodes.json b/platform-api-docs/docs/get-workflow-task-log.StatusCodes.json new file mode 100644 index 000000000..5bb77082e --- /dev/null +++ b/platform-api-docs/docs/get-workflow-task-log.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"log":{"type":"object","properties":{"truncated":{"type":"boolean"},"entries":{"type":"object","title":"Iterator_String_"},"rewindToken":{"type":"string"},"forwardToken":{"type":"string"},"pending":{"type":"boolean"},"message":{"type":"string"},"downloads":{"type":"array","items":{"type":"object","properties":{"saveName":{"type":"string"},"fileName":{"type":"string"},"displayText":{"type":"string"}},"title":"LogPage.Download"}}},"title":"LogPage"}},"title":"WorkflowLogResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/get-workflow-task-log.api.mdx b/platform-api-docs/docs/get-workflow-task-log.api.mdx index 62a1ddddf..b7d2fff54 100644 --- a/platform-api-docs/docs/get-workflow-task-log.api.mdx +++ b/platform-api-docs/docs/get-workflow-task-log.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the output logs for the workflow task identified by the sidebar_label: "Get workflow task logs" hide_title: true hide_table_of_contents: true -api: eJy1VlFv2zYQ/isEn1bAsLO1GzA/Ne3aIli3BUmKPQRGS0tnmQlFKiRlxxD033tHSZZky+ocYE+WyTved8fvvmPBvUgcn9/zrbGPK2W2ji8mPAYXWZl5aTSf8xvwVsIGHPNrYCb3We6ZMoljK2PDWuPMvHCPTMagvVxJiNlyF/YTuQHNvtHuVfxtyifcZGAFnX8VY4RP4P+tj7hDm88mQZNMWJGCB0v4Cq7xD5o2odBvwiXBy4Rf80PMzXHMIXadtJgsmlp4yqUFjOxtDhPuojWkgs8L7ncZBamceFlO9nEr7KMxCTrTeQpWRmcGlNpDEkyxpKnw1dJvb3oQNDz7BsBTDnZ3Omu8HRbl1hk68r+kR2V1mYigzfF0iGA4nOnLMkvF82fQSajpSOy/xLNM85SpYMukRn55pKVZBZZR0t4wW9P1TDQLuiaXGe3AkccvFxf000fwz5/oGhk8RXvaFVmmZBSIPHtwZFIcBzXLB4jo5jJLtPeyCoBwf2yEfNF4PlFnb7o0RoHQvJxwhGEby4NzvPSKFq48dZqxX2/DrX8lNwtbqeM78wh6gBahOFthRwwy0DF9DoJKwTmRwKBjbLZaGRF3IQtrBV229JAOptIviRMb+DvwZgi5VKc3Y+kyJXZ31EdD3bCvGQrQNWYw/aNGi5vHuz2PpvNw76ZmETmhxZshHr0TMSNRAOfPIVSrI/f7KiNvx+t1+jo6+D9Ya+wR8tcDHdAIN9PGM6EwZ4jDUQ5QcaTfBbV+B8KCvcyxpef3C2oulPK1IbFPIGAkBZ3zWaPns6JV9nKGvTErKsktqY/Bbpo5kFuFfmvvMzefzUQmp5EyeTx18ITIptIcycZt2GHXSnjqevae7Nnl9RUnXA3sW6pyVbEu+H3RKGIjKYHwwQhXqo+PjZ48bH0oh9QrE9zrCtcoKOyPAFK6MkJhq4yJHiIK9Ogn300ZGSJVkLOVedtuIBCqXBXn5+nvv04vQv8a51MR2FVLMI7ggzFOE/4QatFy9X95FtS19tihM2xVGfQkJF3UjGlfKmg+770GVHg2zOtJjVe7xizJoyiWwsEXq8qSlqvhQlxCQRBLRf20EsrBSLLDk3UQ7iPs2mG9ESonE07T7rxwI1N2JG5/kL8w/NmDdgRQd7a3cBb0x0rCc+ZN/HRTi+ArNvrIG4TUTBy966Lp1q5m03n16mA6/Qh8AaCayuUCLdcgYjyHilVtXkYRZF2OHc2Onux++nCHtqIvagciFk4fhIQtFCzCk6AsW4ThiYAAy/I7MAdA4A== +api: eJy1Vt9v4zYM/lcEPm2AkfRuhz34ab3tVhTrtqLtsIciuGNsxlEjS65EJw0M/+8HKnZ+tG66FNhTHIkUP1IfP6oBxiJAeg8r5xcz41YBJgnkFDKvK9bOQgo3xF7TkoLiOSlXc1WzMq4IauZ8XOudFWNYKJ2TZT3TlKvpOu4XeklWfZPdy/zbCBJwFXmU8y9zSOGC+N/uiDsMiytXQAIVeiyJyQu+BiyWBOkW52UOCWiBVyHP4Tnm/jgV2Gtb7DB5SMDTY6095ZCyrymBkM2pREgb4HUlQTZO0LbJNu4G+9GYAl3ZuiSvsxMDastURNOZ8yXyZunnTwcQLD1xD+CxJr9+PWvjCpXVPjg58r+kJ2UNFWa0y/H1ENFwONP3ZVbi0xXZItb0SOw/8UmXdalMtFXaqumaKSg3iyyTpNkp39H1RDQTuaZQORsoiMfHszP5OUTw9x+QQOYsk2XZxaoyOotEHj8EMWleBnXTB8rk5iovtGe9CWBc8bYR+9pmyEKdrenUOUNooU2ArOQahs5hzUYWLlk6zfmvt/HWv4qbp5W2+Z1bkB2gRSzOCv0Rg4psLp+DoEoKAQsadMzdyhqH+T5k9B7lsjVTOZjKYUkCLumvyJsh5Nq8vpnrUBlc30kfDXXDtmZXrrjGgka/dWihHdg98Og778oVNx2LxKlN4NMQjz5jrkQUKPAphNrpyP22ypPkjXq9fh17+L947/wL5D8NdEAv3Mo6VmiMW1EejwqU1V7zOqr1Z0JP/rzmOaT3E2muknjuROwLihhFQVMY93o+bnbK3o6NK8bNRnJb6WPyy34O1N5ACnPmKqTjMVZ6lBlX56NAj+RxpN0L2biNO+raIEvXq1/FXp1fX4Lg6mHfSpU3FdsHvy2aROwlJRI+GkHSffze68nDimM5tJ256N5VuEMhYd8CKOnqjEJnLPTALNLjMPn9lKlEbaKczdwvu402AancJs6H0Yezj6Oz2MAucImRXp0GXxA/m+My4p9jbXZk/V/eBV2xmZ54XBnUUVBi1k1Hmd1TBRJID54DJr4b0m5UTxKYu8Di0TRTDPSPN20ry5vpImTKdcCpkYaaoQl0JNnh0ToId0Hr3bReoqnFBGTcnRbuyJg9Evdwkr8z/MmT9gig/eG+gzORP14LnhNv4oebTgV/VEdfeYOQ+pFj1/to9mvXsem0eu1hev0V+A5AHZXbSZvAnDAnH4u12TzPMqr2OfZieBzo7sWXO0gAD1XtmYrF0wchNc3GIr4J2naHML4R2knbtt8Bkm5BBQ== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the output logs for the workflow task identified by the given `taskId` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/info.RequestSchema.json b/platform-api-docs/docs/info.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/info.StatusCodes.json b/platform-api-docs/docs/info.StatusCodes.json new file mode 100644 index 000000000..a7dc8cdec --- /dev/null +++ b/platform-api-docs/docs/info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"serviceInfo":{"type":"object","properties":{"version":{"type":"string"},"apiVersion":{"type":"string"},"commitId":{"type":"string"},"authTypes":{"type":"array","items":{"type":"string"}},"loginPath":{"type":"string"},"navbar":{"type":"object","properties":{"menus":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}},"title":"NavbarConfig.NavbarMenu"}}},"title":"NavbarConfig"},"heartbeatInterval":{"type":"integer","format":"int32"},"userWorkspaceEnabled":{"type":"boolean"},"allowInstanceCredentials":{"type":"boolean"},"landingUrl":{"type":"string"},"termsOfUseUrl":{"type":"string"},"contentUrl":{"type":"string"},"analytics":{"type":"object","properties":{"hubspotId":{"type":"string"},"posthogApiKey":{"type":"string"},"posthogApiHost":{"type":"string"}},"title":"Analytics"},"allowLocalRepos":{"type":"boolean","deprecated":true},"contentMaxFileSize":{"type":"integer","format":"int64"},"waveEnabled":{"type":"boolean"},"groundswellEnabled":{"type":"boolean"},"groundswellAllowedWorkspaces":{"type":"array","items":{"type":"integer","format":"int64"}},"scmsServerUrl":{"type":"string"},"forgePrefix":{"type":"string"},"seqeraCloud":{"type":"boolean"},"evalWorkspaceIds":{"type":"array","items":{"type":"integer","format":"int64"}},"contactEmail":{"type":"string"},"allowNextflowCliLogs":{"type":"boolean"},"logoutUrl":{"type":"string","nullable":true},"seqeraAiBaseUrl":{"type":"string","nullable":true,"description":"Base URL for Seqera AI services. Can be `null` if not configured."}},"title":"ServiceInfo"}},"title":"ServiceInfoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/info.api.mdx b/platform-api-docs/docs/info.api.mdx index c2b439588..d92968261 100644 --- a/platform-api-docs/docs/info.api.mdx +++ b/platform-api-docs/docs/info.api.mdx @@ -5,9 +5,9 @@ description: "General Seqera service features and version." sidebar_label: "Get API version and features" hide_title: true hide_table_of_contents: true -api: eJylVt9v2zgM/lcMPeec7tcB16dLg64L1m1Fs94eggKjZcZRJ0ueJKfNBf3fj5SdNMnZTYc9xZFI8aP4kZ/WIkDhxelMeHRLJfEPZeZW3A5Ejl46VQVljTgVF2jQgU6m+JN+k9Y4mSOE2qFPwOTJEp0n61QMhK3Iil0nOTlP+MiBILvKGo8Ubi1en5zwz36ULx/JTFoT0ATeharSSsaDhneeTdbCywWWwF9hVSE52ewOZSDHynHYoJoALcQY+6hxC33H0AenTCEeBwRC/fPMtrRlqQLn2eVbh8VXWvQ7u+AcrAiBClj6Di9y07ZQ5grCovNQA8sM3PGkSjT1SwL3uGvIUHcCqF3XOm0EFTQvfY4Ix9bMVZE2fz4RGLLpMeJTFwguZESoCdXfLWE3hqKlAh1hnFtXQmiW3ryOaKjS36z74SuQeG4g07hbjMxajWBiNbS29xPjAxiJY4c50UyB9t3WmjhNid10JktpoCv9l/mNxz6Llsh922BAr4KSLyjFos6odfpIVlkfFrYYVeojro5YfKCv52s32sLa3NillaCvkQ7puCgeFJVDalK+9eBqfMr8Ezy8Vxqn6l88Wss/33K8e1g+X8LC2drk/h61fqndiHPAfEuRl7REP0Y628vST4mh6PpKS04FXjmcq4fOfR+n6Fjbugc+Ev23gCf5b0PmgoAM5yWoHjLyJX3GhzCn37FWl7boawtb2Lqb1DSaaq25KlsmNJmO1Bn09Mmhz6HwsGNyc32ZUFYb9RlNNgLk02QMJskw+c7HfE/UPDE2JDJOFVKmPN0j93RHFHrWr1uV4mFFFm+7dOoM8sThzxp9+BXBYhflmLIzGs7eQ4GstMemeGP4bNOeO2fdHnLaLJGanvW3wHhs1BMx3BP6QdRJkjfCtG4Gu1iEUPnT4ZCEL5XM0bSpYqqsOCxPW5ErDYFpl0ROJ6OriXi85bNl7VRYTfkKmnTOaMqjG9V72sYRGUo0Y7pFI1ppPt5vCH13H2LaaiPq2/I1vKCwxwBuiNMat43Bh+0nv5syNm0Tw/79tEFAtu8G8Sr96116shm2JcTSG4jpXGDgcJsHUnwsbV5Oh4DXT3T61UdXe5mBunhYaVBmR6ub4v//lbeIejAT63XWdOjjIy8TtR1JyYw+l+BU056z20alcyoNs+UHq40YSYkV84tGVh0H1GEPMBO2XLw4/0ol/A/tJqLQ +api: eJylVt9z2jgQ/lc8++yDNNe5B56OMGnKNG2Z0Nw9MJnpYi9GqSw5qzWEY/y/dyQbApwd0ukTRlrtD33f7qctCGYOBjNwxCuV0B/KLCw8xJCSS1gVoqyBAdyQIUYdTemJGKPGOFoQSsnkIjRptCJ2ypoexGALYvRHxykMYOxdxsDkCmscORhs4fLiwv8cR/n6CWJIrBEy4nexKLRKgqP+o/MmW3DJknL0X7IpCAZg54+UCMRQsA8rqg7QpBhinzVuUj8wdMLKZFDFgIX655XtxOa5El9n29lSlt82RR2k2UVm3EAMSih3LaeqGLTNlJmgLFudGlzNkc8XlZMp3xK447jGOenWBEpuW69iECXaL30JGY6sWaisV//5TKaEqsvIe10SsswJZWyEeIWHMZQRyoghhoXlHKVe+vMyZOOI/7X8wxWY0LXBuaZDMObWakIT0NDarsfGCZqERkwpGVGoXbu1RpMqk923FhuDEOfu6+LeUZdFQ+SubTSoN6KSN0CxLOeusF0kK6yTpc2GhfpEmzMWH62T17Eb7tPa3ditTVDfUWHbLsoPioIpQfG3LlzSS+Wf8fmD0jRV/9FZLP967+OtcfU6hBnb0qRuTVq/1W7oa6B0T5G3tER3jlUMLsndlHhF3AXtwnJGE6aFem7dd2GKjrQtO9KnFep9wuP0t1P2gGAi1zmqDjL6S/pCz7LQdj3S6tZmXW1hM1u2kzoGU2rtUdkzoa50qK6wo09Oz5wKjz8Y3d/dRgvLO/UZjncC5HrRCE00p+i7d/M9UovIWImSMFVKprR3RO7pgSh0rN81KuWHVRXD+zadusI0YnoqycmvCJY/othTdgY5OYcZeaU9N8Vrw1eb9prZ8lHmVQw5ydJ6/c0ouA16Av0joY+DThL7J8C2HuywFCncoN/HQvUSz9FejWJPWTiFp0FkolE87aLA6Wg4GUP14H0nJSvZTP0V1OVcETLxsDzSNh/RpxLMPN2CEcTNx4cdoR/XEspWO1Hfw1fzYjI+m+COOI1x0xje2XHxhyVT3TYh7N8vG1X88m6Ad713F5e9i920zTFgbzDUc0Pi4+1eSOG1tHs6nWa8feHTr766mtsUepZ+oVGZA7Gu0f//M28ZBGEG2+28btGq8stPJfEGBrOHGFbIqu7P2UMt0ylxoMsPLzcwTBIqPMFWqMswoU6bwFNhT8ab629QVT8BVSai9Q== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ General Seqera service features and version. - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml b/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml index cc009bb77..372522990 100644 --- a/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml +++ b/platform-api-docs/docs/info/parameter-tables/data-links/parameters.yml @@ -34,16 +34,11 @@ Location: path Req/Opt: Required Description: Data-link string identifier. -- Name: "`path`" - Type: string - Location: path - Req/Opt: Required - Description: Content path - Name: "`nextPageToken`" Type: string Location: query Req/Opt: Optional - Description: Token used to fetch the next page of items + Description: Token used to fetch the next page of items. - Name: "`pageSize`" Type: integer Location: query @@ -56,11 +51,11 @@ Req/Opt: Optional Description: List of paths to explore. Returns all files within the specified paths, including sub-paths. -- Name: "`filePath`" +- Name: "`path`" Type: string Location: path Req/Opt: Required - Description: File path to download + Description: Content path - Name: "`filePath`" Type: string Location: query @@ -82,13 +77,18 @@ Location: query Req/Opt: Optional Description: List of file paths to include in the download script. +- Name: "`Origin`" + Type: string + Location: header + Req/Opt: Optional + Description: "" - Name: "`dirPath`" Type: string Location: path Req/Opt: Required Description: Path to the destination directory -- Name: "`Origin`" +- Name: "`filePath`" Type: string - Location: header - Req/Opt: Optional - Description: "" + Location: path + Req/Opt: Required + Description: Resource path of the file to download. diff --git a/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml index 8ac6d2f8c..a7d27a20e 100644 --- a/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml +++ b/platform-api-docs/docs/info/parameter-tables/data-links/request-bodies.yml @@ -67,7 +67,7 @@ - Name: "**GenerateDataLinkUploadUrl**" Type: "" Req/Opt: "" - Description: Generate data-link file upload URL (to given path) + Description: Generate data-link file upload URL - Name: fileName Type: string Req/Opt: Optional @@ -84,7 +84,7 @@ - Name: "**FinishDataLinkUpload**" Type: "" Req/Opt: "" - Description: Finish data-link file upload to given path + Description: Finish data-link file upload - Name: uploadId Type: string Req/Opt: Optional @@ -113,7 +113,7 @@ Req/Opt: Optional Description: Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed. -- Name: "**FinishDataLinkUpload_1**" +- Name: "**FinishDataLinkUploadWithPath**" Type: "" Req/Opt: "" Description: Finish data-link file upload to given path @@ -145,7 +145,7 @@ Req/Opt: Optional Description: Flag indicating whether the upload encountered an error. If `true`, the upload will be aborted. If `false`, the upload will be completed. -- Name: "**GenerateDataLinkUploadUrl_1**" +- Name: "**GenerateDataLinkUploadUrlWithPath**" Type: "" Req/Opt: "" Description: Generate data-link file upload URL (to given path) diff --git a/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml b/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml index 466045a9b..144c4703b 100644 --- a/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml +++ b/platform-api-docs/docs/info/parameter-tables/identities/request-bodies.yml @@ -18,65 +18,59 @@ - Name: config.workDir Type: string Req/Opt: Optional - Description: Nextflow work directory on the cluster's shared file system. Must - be an absolute path and credentials must have read-write access. + Description: Compute environment working directory. - Name: config.preRunScript Type: string Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run + Description: Script that executes in the nf-launch script prior to invoking + Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). - Name: config.postRunScript Type: string Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run + Description: Script that executes after all Nextflow processes have completed. + See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). - Name: config.nextflowConfig Type: string Req/Opt: Optional - Description: Additional Nextflow configuration to apply. See [Nextflow config - file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file). + Description: Additional Nextflow configuration content. - Name: config.launchDir Type: string Req/Opt: Optional - Description: Directory where Nextflow runs. Must be an absolute path and - credentials must have read-write access. If omitted, defaults to `workDir`. + Description: Launch directory for Nextflow execution. - Name: config.userName Type: string Req/Opt: Optional - Description: Username for SSH connection to HPC head node. + Description: Username for SSH authentication to the HPC cluster. - Name: config.hostName Type: string Req/Opt: Optional - Description: Hostname or IP address of HPC head node. + Description: Hostname or IP address of the HPC cluster head node. - Name: config.port Type: integer Req/Opt: Optional - Description: "SSH port. Default: `22`." + Description: "SSH port for connecting to the HPC cluster. Default: `22`." - Name: config.headQueue Type: string Req/Opt: Optional - Description: The name of the queue on the cluster used to launch the Nextflow execution. + Description: Queue name for submitting the Nextflow head job. - Name: config.computeQueue Type: string Req/Opt: Optional - Description: The name of queue on the cluster to which pipeline jobs are - submitted. Can be overridden by the pipeline configuration. + Description: Queue name for submitting Nextflow compute jobs. - Name: config.maxQueueSize Type: integer Req/Opt: Optional - Description: "The maximum number of jobs Nextflow can submit to the queue - simultaneously. Default: `100`." + Description: Maximum number of jobs that can be queued at one time. - Name: config.headJobOptions Type: string Req/Opt: Optional - Description: Additional submit options for the Nextflow head job. + Description: Additional options for the head job submission. - Name: config.propagateHeadJobOptions Type: boolean Req/Opt: Optional - Description: If true, `headJobOptions` are also applied to the - Nextflow-submitted compute jobs. + Description: "If true, head job options are propagated to compute jobs. Default: `false`." - Name: "**UpdateManagedIdentity**" Type: "" Req/Opt: "" @@ -104,65 +98,59 @@ - Name: managedIdentity.config.workDir Type: string Req/Opt: Optional - Description: Nextflow work directory on the cluster's shared file system. Must - be an absolute path and credentials must have read-write access. + Description: Compute environment working directory. - Name: managedIdentity.config.preRunScript Type: string Req/Opt: Optional - Description: Add a script that executes in the nf-launch script prior to - invoking Nextflow processes. See [Pre and post-run + Description: Script that executes in the nf-launch script prior to invoking + Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). - Name: managedIdentity.config.postRunScript Type: string Req/Opt: Optional - Description: Add a script that executes after all Nextflow processes have - completed. See [Pre and post-run + Description: Script that executes after all Nextflow processes have completed. + See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts). - Name: managedIdentity.config.nextflowConfig Type: string Req/Opt: Optional - Description: Additional Nextflow configuration to apply. See [Nextflow config - file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file). + Description: Additional Nextflow configuration content. - Name: managedIdentity.config.launchDir Type: string Req/Opt: Optional - Description: Directory where Nextflow runs. Must be an absolute path and - credentials must have read-write access. If omitted, defaults to `workDir`. + Description: Launch directory for Nextflow execution. - Name: managedIdentity.config.userName Type: string Req/Opt: Optional - Description: Username for SSH connection to HPC head node. + Description: Username for SSH authentication to the HPC cluster. - Name: managedIdentity.config.hostName Type: string Req/Opt: Optional - Description: Hostname or IP address of HPC head node. + Description: Hostname or IP address of the HPC cluster head node. - Name: managedIdentity.config.port Type: integer Req/Opt: Optional - Description: "SSH port. Default: `22`." + Description: "SSH port for connecting to the HPC cluster. Default: `22`." - Name: managedIdentity.config.headQueue Type: string Req/Opt: Optional - Description: The name of the queue on the cluster used to launch the Nextflow execution. + Description: Queue name for submitting the Nextflow head job. - Name: managedIdentity.config.computeQueue Type: string Req/Opt: Optional - Description: The name of queue on the cluster to which pipeline jobs are - submitted. Can be overridden by the pipeline configuration. + Description: Queue name for submitting Nextflow compute jobs. - Name: managedIdentity.config.maxQueueSize Type: integer Req/Opt: Optional - Description: "The maximum number of jobs Nextflow can submit to the queue - simultaneously. Default: `100`." + Description: Maximum number of jobs that can be queued at one time. - Name: managedIdentity.config.headJobOptions Type: string Req/Opt: Optional - Description: Additional submit options for the Nextflow head job. + Description: Additional options for the head job submission. - Name: managedIdentity.config.propagateHeadJobOptions Type: boolean Req/Opt: Optional - Description: If true, `headJobOptions` are also applied to the - Nextflow-submitted compute jobs. + Description: "If true, head job options are propagated to compute jobs. Default: `false`." - Name: "**CreateManagedCredentials**" Type: "" Req/Opt: "" diff --git a/platform-api-docs/docs/info/seqera-api.info.mdx b/platform-api-docs/docs/info/seqera-api.info.mdx index fe197ff7c..576d0c1f0 100644 --- a/platform-api-docs/docs/info/seqera-api.info.mdx +++ b/platform-api-docs/docs/info/seqera-api.info.mdx @@ -19,7 +19,7 @@ import MDXComponents from "@theme-original/MDXComponents"; diff --git a/platform-api-docs/docs/launch-action.ParamsDetails.json b/platform-api-docs/docs/launch-action.ParamsDetails.json new file mode 100644 index 000000000..68b0c8809 --- /dev/null +++ b/platform-api-docs/docs/launch-action.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"actionId","in":"path","description":"Action string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/launch-action.RequestSchema.json b/platform-api-docs/docs/launch-action.RequestSchema.json new file mode 100644 index 000000000..391ead8c3 --- /dev/null +++ b/platform-api-docs/docs/launch-action.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Action launch request","content":{"application/json":{"schema":{"type":"object","properties":{"params":{"type":"object","additionalProperties":true}},"title":"LaunchActionRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/launch-action.StatusCodes.json b/platform-api-docs/docs/launch-action.StatusCodes.json new file mode 100644 index 000000000..5ac559bfe --- /dev/null +++ b/platform-api-docs/docs/launch-action.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflowId":{"type":"string"}},"title":"LaunchActionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/launch-action.api.mdx b/platform-api-docs/docs/launch-action.api.mdx index 075e940b3..b085ea6ce 100644 --- a/platform-api-docs/docs/launch-action.api.mdx +++ b/platform-api-docs/docs/launch-action.api.mdx @@ -5,9 +5,9 @@ description: "Triggers the execution of the Tower Launch action identified by th sidebar_label: "Trigger Tower Launch action" hide_title: true hide_table_of_contents: true -api: eJy1VVFv0zAQ/iuWn0Aq7YCBRJ/opiFNIFFtRTxMleYm18RbEnu2s66K8t+5s5OlbUInELxUjf3Z9913950r7kRi+fSGi8hJVVi+HPEYbGSkpm8+5QsjkwSMZS4FBk8QlbTB1NovLNQGDPsmyiJKWbiDyRgKJ9cSYrbaelQiH6Fgt2H/Mr4d8xFXGowI3xgl3DDzANzUwogcHIZFbhUv8ANB7XkESKKmhUv5Id9wB7POyCLpuBgEGngopQGM50wJI26jFHLBpxV3W00BwiFe16PnmBtl7q0WEXRhH0ow217cny2QFWUORkb7sXuxZOEg8VtrZXLhwtLHU4y+DFTBujMVb+nMYIpZUL2B4kWRwjsLRweE1pmMvL6TO0unqj4FtbqDiA5qQ9VwEiztevHtEE7EsaQrRTbfOUFiomTcSZfBQS2vGnI1Afb19wtWY9OFsO9OTvqpfv/67/KiUq4ztaGGGyj5b/gHhpQAQk6HOJ6J+G+K0Klxw3OwViRA7jueQws8msCFMcr0mL8fULf1ICuUYyJDcZAPwS363Ei39fY7A2HAzEp02/RmSe2J3kwV+VYrn7R34pRPmikyqVqr1pPQpeQAMI+toUuTITx1TtvpZCK0HEeZKuOxhQdkNJaqZ69rv8PmmXDkF3ZOeDabX3Li09K9JnWDUrukn8WiiK0Z6XvlQbgS/nxpnXi3cV4GqtpVZ8WLJ5HrDPZMQjBZrJWP0hSgIUvsXsqDVJER2AZM3YPa0WX7Gu0qgw0kMz8v1upzt4FESOAQ5+3404fxCa1RiXLhm6+Zac1IHxreh3yrrp//20vQ1MbBk5voTOCMRdY++6pprO55GvHpzivQ9BY2QEp9iLiqWgkLP0xW17QcRjV1XCytWGXktrXILBxJ84VBPsj2Hra9t+JRZCUhfYM+CiMp/h9yeXXVDInX7Mi7NkipWRTFdpdLS/VZxHqJ2BREjDcRt7B9Hhi8WdAl3fHeQKOHMpyYRRFodxS7Ozfm368XZLvmfctVTGeM2NAzjb+eqtKh6DQsaa3CghdJ6ecfD3eS+8S+xw887bMaFAN7xSMW6h4K7JdWG0ffJExd/wLNeyuB +api: eJy1VU1v2zAM/SsGTxvgJd0HdvBpbdEBwwasaDPsUAQYYzOxWllSJblpYOi/D5TsJmm8DBu2my2R4uMjH9mBx5WD4gaw9EIrB/McKnKlFYb/oYCZFasVWZf5mjJ6pLLli0wv48FMr8lmX7BVZZ2lNzJRkfJiKajKFptotRIPpLIf6f5T9WMCOWhDFtM/FJBeOI0GkINBiw15soytA4UNQQGDP+QgGJpBX8NzvOmNzHkr1GqLxUIOlu5bYamCwtuWcnBlTQ1C0YHfGA6QnCCE/CnmWts7Z7Ckbdj7luzmIO73wTBTbUNWlPuxD2IJ5WkVr5baNujT0ft3EMI8QSXnz3S1YZ/RFGVivTeFHEqtPCnPDmiMFGXkd3rr2Ks7hKAXt1Syo7FcDS/I8W0k343ZYVUJfhLl5Y4HkxlCDl54Sc9qedWDC2ywz388cEYrl8K+OTk5TPXr53+XF5dyKfWaG26k5L/AnxByAiGHd2MYz7D6myJs2biBhpzDFbH6jucwGB5N4MJabQ+Qvx1hd9BgprTPUEq9pio+5ahsrfCbKL8zQkv2tPU1FDdzbs+GfK1Zt0bHpKMSC5j2U2TaDVIN09SlrACyD4OgWyuhgNp744rpFI2YlFK31cTRPVmcCH0gr+t4k11K9KyX7Jzts9PLT8B4BrjXzG5iahf0E1kccRAj/y+iEeT9x8dBibdrH2ngql1tpXjxiI2RtCcSNhNqqWOUvgA9WEb3uzyYFVGS6425e7CM3bPP0S4z1KCQcV4s9YftRciBCU5xXk9en7yZnPAh16jB2H39UOtn+tj0fg642zb0f1sFfXE8PfqpkSgUo47pd31nbfdTDsXOGuiba55DzY1Y3EDXLdDRNytD4OM0q7nlKuFwIVluS5SOjqT5m0k+ivaONgfL4gFly5axQx/QCo7/h1heXPVT4mV2ZLGNQuoPUW12sQxQn0gM85BDTViRjdjS9XlC8GrGj2zdDyYab8rkcVqWZPxR293Bcfn1esa66xdcoyv2sbjmPY3rBFWbVHSelnzWgUS1auMAhPQmyw/3Rf5M1DGrUTK6LlnM9B2pEJ648fzPxITwE1PsK6Y= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Triggers the execution of the Tower Launch action identified by the given `actio id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/leave-organization.ParamsDetails.json b/platform-api-docs/docs/leave-organization.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/leave-organization.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/leave-organization.RequestSchema.json b/platform-api-docs/docs/leave-organization.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/leave-organization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/leave-organization.StatusCodes.json b/platform-api-docs/docs/leave-organization.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/leave-organization.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/leave-organization.api.mdx b/platform-api-docs/docs/leave-organization.api.mdx index 8b11aa46e..567149370 100644 --- a/platform-api-docs/docs/leave-organization.api.mdx +++ b/platform-api-docs/docs/leave-organization.api.mdx @@ -5,9 +5,9 @@ description: "Removes the requesting user from the organization identified by th sidebar_label: "Leave organization" hide_title: true hide_table_of_contents: true -api: eJzNVE1v1DAQ/SuWTyAtyQIFiT3RwiJVVFC15VStVCeZbNw6tms7W5Yo/50ZJ+l+Cjhy8sc8e97Me3bLg1h6PrvlxuG4mPACfO6kDdJoPuNXUJsVeBYqYA4eG/BB6iVrPDhWOlPHAB4VWv4SdIbJAnSQpYSCZesYXsoVaHaHqPPiLmE3R66qGx+YNoFl0N+o1ZqZJ40hUx7kSPiEGwsuLs4LpHkBYgXftyCIsMKJGgI4Kq/lGheIjCwwKqk6K0LF90vevobppgYn801VjpITfekAMwfXwIT7vIJa8FnLw9pSFqkDLMEhtDSuFqHfen/Cu25Bx7012oOnE2+mJzTscfjKXrFvhuUGL9KBdxN+Mp0e4s5EMfYSc41ohAlrlcxjDem9J2y7xXLD/5bX4L1YAkk/kDfZPeR0n3XU5SB7oiNwU6UPDhXEmvCoDIq25s4ZdzXUh5EuMn97pMJRvyi7UMo8IR+Ce8gbJ8M6qnYGwoE7bVCn2e2CmoeSVoY0L0ChulFoivKUHJy2UeAuraHOUPpUkTM43epWoxUapxBfhWD9LE2FlUmuTFMkHh6RVCLNgSeuY4RdKhFIUPaJ8Oz08pwTpZHxNTW4b9Y27+d+UUY+uIXWWQThTj/5Mlrl/inETkhdmnh8aO7AgtL+jSCVK3N8uD2YnCHy6Izd4rdLRnNIFZ1amo+bABKhzvV5Xicf3iVT2rPGh1pEYw1PKz7CnYe6T7PdWPT//VkGsQL8DKlVAj8KrDZ2rR2sNnyWEz4bf5PBbTjr/YamqLA/BG3bTHj44VTX0Tayc2RtnK6EkyIjZdGThfQ0R2OXQnn4Q+NeXA2v9yX7h6/qaDXDptBrTjRUQyucPsD6+YvsFgisQBToUCLYx07zHGzYOnXw0ey80c/zi/nNHOFi9yXsOT8mOEoKuxcRN+YBNHZw5BhoTRy77jdBm1ew +api: eJzNVE1v2zAM/SsCTxugJWlX7ODT2q0DihVb0XanIEAVm3HU2pJL0ekyQ/99oOI0n9h23MmWSJHvkY/sgE0ZIBuDpzLAREOBISfbsPUOMrjF2i8wKJ6jInxuMbB1pWoDkpqRr5PBU2mc/WXkjbIFOrYzi4WaLpO5tAt06sFTeVU8DNT9kVB1G1g5z2qKq4iuWir/4pCUnx3kGIAG3yClw1UBGVyjWeD3LRfQ0BgyNTKS0OvAmRohg4QCNFhh1xiewz7l7TDKtTWSzTesSJILfEtYQMbUooaQz7E2kHXAy0ayWMdYIoGGmafa8OrqwxnEOJHnofEuYJAXp6Mz+exh+KreqW9e5d4xOoao4Ww0OvS7MMW6lqBh7Z11YJqmsnniMHwM4tttodzgH0ONIZgSpfU9eD99xFziNSRVZrsCunbcsAxM1pUQowa2XMnVJZGn254fxBgT8vdHGK77l9puqsq/YJFCBcxbsrxMXbtAQ0jnLc8hG0+keDXy3EvPC6yQMTVarDAUBQ+71OA4rLGeIoVhJcoAiUqLtRRaqiCDOXMTsuHQNHaQV74tBgGfkczA+gNN3CWLuqkMS0PVJ/FX5zdXIJDWiO+kwKtibeN+rZdkhF4tcp4mJ9D9z5e1VB5fOFXCuplPz/vi9igk7d8ACl2bY+idRRkmT8rYJb9NGWtjq6TUmf+4MUQNUrlVnpPByeh0MJLLxgeuTVJWP1tpCncmdR9nt9Ho/7ta+m4x/uRhUxnrhG0qW9drrd+WGrL1OunlBhpWgptomPvA4tp1UxPwB1UxyvVziyTanmhYGLJmKq0dd1DYIP8FZDNTBfxD4d7c9uP7Vv3DrjrKpr80bgkCo2rlBBqecPm6I+MkapijKZASwJXtPM+x4a1XB5tmZ0g/X15f3l+CBrM7CnvSTwmOguq6lce9f0IX4ytGlrNgjPE3Fe9X1Q== sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the requesting user from the organization identified by the given `orgId id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/leave-workspace-participant.ParamsDetails.json b/platform-api-docs/docs/leave-workspace-participant.ParamsDetails.json new file mode 100644 index 000000000..e75286b91 --- /dev/null +++ b/platform-api-docs/docs/leave-workspace-participant.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/leave-workspace-participant.RequestSchema.json b/platform-api-docs/docs/leave-workspace-participant.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/leave-workspace-participant.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/leave-workspace-participant.StatusCodes.json b/platform-api-docs/docs/leave-workspace-participant.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/leave-workspace-participant.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/leave-workspace-participant.api.mdx b/platform-api-docs/docs/leave-workspace-participant.api.mdx index b25c18acc..6cb30a54d 100644 --- a/platform-api-docs/docs/leave-workspace-participant.api.mdx +++ b/platform-api-docs/docs/leave-workspace-participant.api.mdx @@ -5,9 +5,9 @@ description: "Removes the requesting user from the given workspace." sidebar_label: "Leave workspace" hide_title: true hide_table_of_contents: true -api: eJytVE1v2zAM/SuCThuQxdnWDVhOa7cMKFZsRdthhyAHxmYStbalUnK6zPB/L6nY+WqxAMVOlqUn8vHxibUOMPd6ONYPlu68gxS9nvR0hj4l44KxpR7qKyzsEr0KC1SE9xX6YMq5qjySmpEt4sHcLLFUmzB93dPWIYHEOM84ygXCEn9355dAwaTGQRkY6YCgwIAkXGpd8g/fsDTnmz1thISDsNCHzH7SHErzNyZRZVUgmVSZDMtgZgaJ8cLXEDKBQBX2tE8XWIAe1jqsnCQxZcB5hM4sFRDWWx9PdNP0Nkw2ZR3hsynv/5OZyHXvbOm5RXzj3eBEPgd6fFdv1A+rUsuBWNmmp08Gg6e4M8i6TnKuDs0wcC43adQzufWCrXdYbvmPdYHewxzFLS15O73FNHaTpPPBrIl2wG2VPhD7RwTWwYRctkZElq7a+vikiczfP1Nh5ylV2qAgz+0D8xG4x7QiE1bRQWcIhHRacY+G44mIx/ZaWPFhhjk7LZpOTnXCNvNJHc3WJNt3kNQ7XW8StzWs15KNlp1dK8o5ziIE54dJAs7009xWWd/jPZPtG/vEJ9fxRF3mEKTR6ovg1enluRaqXSXXIvxaxN16NjpKRt26SP6nEcQ768W3zkK3DyEqZMqZjddb0VsWkvYYQSnXsCgtWBwDaXTMfvG7JbNpTB4dPLOftwdMRJRb53nb//ShP5A9Z30oIBqufXRxYGwnyiHHeuvbF0+oVsiAf0LicuCHzUxiRXVrj7FMIWn4sJtGO5OSd/cnw55JuJMLLkpi1PUUPP6ivGlkmwmS+JSXSyADU2kHGykzXtbs0hnkHv9R8Kur9im+Vsdn4LNVtptQrrSwyCv54+UdrjajVybgizgdmYMvILSrczNh+AIh42Ai2xpxmqbows7dJ7Nsbwx8HV2MbkYMh/1HdfCIYoJnqXFPI+LG3mHJfe2YBvkXjk3zCNKUjG4= +api: eJytVMtu2zAQ/BViTy3AWk4a9KBTk9YFggZtkLTowfCBltYyE4lkyJXTVOC/F0tLfiWogaAnW+SSOzM7nA5IVQHyKTxafx+cKjDATEKJofDakbYGcrjBxq4wCFqi8PjQYiBtKtEG9GLhbZM2Kr1CIzbXjECCdegV33FZQg5XqFb4a9i/Vp50oZ0yBBKc8qpBQs9YOjCqQcjB+uqyBAmaQThFSzhE9t1Xyug/qYkwbYNeF0KXaEgvNHqQwHi1xxJy8i1KCMUSGwV5B/TkuIk2hFUqXVjfKFovfTiDGOUGyYbWETwbev8fzIyPB2dNwMAnTsdn/HOgx1fxTnyzorCG0BBECWfj8fO6C1UOkwQJQ3XegXKu1kXSM7sLXNvtoNzin0KDIagK2S09eDu/wyJN0/PkSa+BDoVbloG8NhULDKSp5qWJ99bf9PwgxpiQv3+B4eApYSwJVdf2Ect0VcCi9ZqekoMuUHn05y0tIZ/OWLwGaWnZhyXWSJhMx7uQWV+FrEtmi9n2HWTdztRj5raGDcDd/Gqwa+tryGFJ5EKeZcrpUVHbthwFfECvRto+88lt2hHXtSIetPjE9eL8+hIY6sDkloVfi7jLZ6Mjd4TeRfw9T0Ug+z9fBgvdPVJSSJuFTcd70XsU3PYYQKarCwx9MTtGFckx++R3KWOjdJ0cvLAftxtRAiu37nMyOhmfjsa86GygRiXH9a8uJcY2Ug5BdlvjvjqieiUJf1PmaqUNI0mUut4fU44hnng+xNFOVErI96NhzyUzCUsbiO/ourkK+NPXMfLyQ4uejTqTsFJeqznPY9pBqQP/LyFfqDrgPwi/uenf4ltxPARfZNkvKvMEjKJu+Qsk3OPTJns5Al+F6UgQvgLQrs5xFiUsUZXok2zrivOiQEc7Z5+F2V4OfJ5cTX5MQILaf1UHryg1eBFa160rfth7NDFukBJ/M8YY/wLOHYyT sidebar_class_name: "delete api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the requesting user from the given workspace. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-action-types.ParamsDetails.json b/platform-api-docs/docs/list-action-types.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/list-action-types.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-action-types.RequestSchema.json b/platform-api-docs/docs/list-action-types.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-action-types.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-action-types.StatusCodes.json b/platform-api-docs/docs/list-action-types.StatusCodes.json new file mode 100644 index 000000000..842211634 --- /dev/null +++ b/platform-api-docs/docs/list-action-types.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"eventTypes":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"display":{"type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"}},"title":"EventType"}}},"title":"ListEventTypesResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-action-types.api.mdx b/platform-api-docs/docs/list-action-types.api.mdx index bf68e1c3f..c6bb56128 100644 --- a/platform-api-docs/docs/list-action-types.api.mdx +++ b/platform-api-docs/docs/list-action-types.api.mdx @@ -5,9 +5,9 @@ description: "Lists the supported event types that trigger a pipeline action. Ap sidebar_label: "List action event types" hide_title: true hide_table_of_contents: true -api: eJzNVVFvEzEM/itRnqd2wECiL9ChgSaQmNjQHqZJc+/cNluaZImvozr1v2Pn7trrWm3ijac28Wf78xfbV2uCWdKjGw0FGe+Svj3SJaYimiBnPdI/TKKkaI4qVSH4SFgqXKIjRauAYgH+G81shlGBCiagNQ5VE3CgxiGgK9XdpycfH1KAAs/LO0VeWQ68E8k49t+gVOEd4R8a6CPtA0aQcOdly2ico1+JH9sDRFggYZRSau34wLheQsYYKeaxwrjSz0u83uR01QKjKZQpmZaZGowMTsUcF6BHtRaejDdMbJZNUx8XQM3VhxO9XrN8EVNgJZkYe7w9Ppaf3Xw/v7NrLs+RWCEEa4pc4PA+CaTeT+on91iQFBtFDjJNgixgo8MWCzGClGkIF+n1GMlXscAeLvF7uples1AmBcuxDtr6RR2wo4OJxbJnm3hvERzrdKTJkJW7s64Avu1dyyNvTOlXq6lgGHRySNVTKFVEfuFE/yKvuJgoNG/0AlOCGcoQvKxYB9wvu19ZjD7uMX93oB+69lbOkwJr/RPzEXjCooqGVrmtTxEixnFFcz7eSqtxz8+9jMQMM0cQkx62szykdjwSxmU3G1W0DJkThTQaDiGYQWF9VQ4SPjKJgfF703GZLerCAkm7qy+CV+OLcy0UOoaXImgjTp/nRh/J2M1SboUM4pvmz9dukO6fKFdu3NRn91bMloWkfY2glGsKXigNWDqBFZFgu8X3S+ZmMDbP8dR/3hqYiCjX5Hkz+Ph+cCx3wSdaQG6kdtdIu7Yrr7/TnnOtt335XyzW9nHkOOQ55x3J1WWV6rabtl+GBp2/EHOuX0x1PYGEv6Ndr+W62a7SZbw22tmfgk34ggqv7N6DBB9wtbfel2ArQeamXEI0kj/PCdNFKDmaEGtcx0WBgXpeeytiZ7q+nV0xFnYb+lkD5+jd+nWrXmwWKSOu/AM6FqrjT3LmRLwX/gKrEp65 +api: eJzNVcFu2zAM/RWBZyPJumKHXLZ06IZiA1asHXYoApSxmUStLKkSnS4w/O8DZTtxmqDFbjslFinyvedHugbGVYTpHWDO2tkI8wwKinnQXp5hCt915Kh4TSpW3rvAVCjakGXFW08SQVYc9GpFQaHy2pPRllRbcKRm3pMt1P3HZxceo8ecrop7xU4ZHfmgkrYK1S5L5c4y/eERZOA8BZRyV0WHaJaq38o9yMBjwJKYglCpwWJJMIVBQ8hAC5mnisIWXlL8vetpq5KCzpUuyLJeagqQQczXVCJMaxCcMAVtmVYptHShRG6PPpxD08wzCBS9s5Gi3DibTOTnsN+Pb5BBomdZoui90XkiOH6IklIfN3WLB8pZyAaRg3XbIAnY6rDPxRBQaGqmMr5dI7oq5DTIixy0XUGTQaGjN7g9HRuSOhEniwtDxSC2cM4QWmiaDFizkbPLngA0w2N5ybtQ/NlpKjlNBuenVL3AQgV6qijyv8grV3QQmHdQUoy4IhmC1xXrE49pD5mF4MIR8vcn/NDbW1nHCo1xz1SkUpHyKmjeJltfEAYKs4rXML2bi9VK4rWTkVhRwogSgnE3y2PuxiNS2PSzUQUDU1gz+zgdj9HrUW5cVYwiPVHAkXZH03GTIuraIIvd1WfJV7PrKxAIPcIbEbQVZ4hzp4907GcpWSElQdb9+dIP0sMzJ+baLl263onZoZC2bwEUujqn2CWLEzBPTjgkP6RMJWqT5njpPu0DTQaiXNvn3ejd5Gw0kUPvIpeYnNQtG/Frt/OGS+0l2HpvzP9is3ZvRx7H3qC2wi7JVHd22n8a2uz0iVi7yBKq6wVG+hVM08hxu17FZoWO3fAv0UR6RYU3lu9JgI+0PdrvGzSVZCZXbjBo6Z8GJYM1YUEhAWuvzvKcPA9uHe2Ig/H6enkLGeCho184OFXv96/dDmrXdZtx6x7JNg30+FmeoZk3TfMX0F+e3g== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists the supported event types that trigger a pipeline action. Append `?workspa id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-actions.ParamsDetails.json b/platform-api-docs/docs/list-actions.ParamsDetails.json new file mode 100644 index 000000000..9ed23b665 --- /dev/null +++ b/platform-api-docs/docs/list-actions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"attributes","in":"query","description":"Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.","schema":{"type":"array","items":{"type":"string","enum":["labels"],"x-enum-varnames":["labels"],"title":"ActionQueryAttribute"}}}]} diff --git a/platform-api-docs/docs/list-actions.RequestSchema.json b/platform-api-docs/docs/list-actions.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-actions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-actions.StatusCodes.json b/platform-api-docs/docs/list-actions.StatusCodes.json new file mode 100644 index 000000000..1a34b72ca --- /dev/null +++ b/platform-api-docs/docs/list-actions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"pipeline":{"type":"string"},"source":{"type":"string","enum":["github","tower"],"x-enum-varnames":["github","tower"],"title":"Action.Source"},"status":{"type":"string","enum":["CREATING","ACTIVE","ERROR","PAUSED"],"title":"Action.Status"},"lastSeen":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"event":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"timestamp":{"type":"string","format":"date-time"}},"discriminator":{"propertyName":"discriminator","mapping":{"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"ref":{"type":"string"},"commitId":{"type":"string"},"commitMessage":{"type":"string"},"pusherName":{"type":"string"},"pusherEmail":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"GithubActionEvent"},"tower":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"timestamp":{"type":"string","format":"date-time"},"workflowId":{"type":"string"}},"title":"Action.TowerActionEvent"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"ref":{"type":"string"},"commitId":{"type":"string"},"commitMessage":{"type":"string"},"pusherName":{"type":"string"},"pusherEmail":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"GithubActionEvent"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"timestamp":{"type":"string","format":"date-time"},"workflowId":{"type":"string"}},"title":"Action.TowerActionEvent"}],"title":"Action.EventType"},"endpoint":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"usageCmd":{"type":"string"}},"title":"ListActionsResponse.ActionInfo"}}},"title":"ListActionsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-actions.api.mdx b/platform-api-docs/docs/list-actions.api.mdx index bb2b0e6b8..df62de705 100644 --- a/platform-api-docs/docs/list-actions.api.mdx +++ b/platform-api-docs/docs/list-actions.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available actions in a user context, enriched by `attrib sidebar_label: "List actions" hide_title: true hide_table_of_contents: true -api: eJztV1Fv4zYM/iuCn3ZAmnbbbcDysuXarAjWtV2a2x4OBaLYTKJWlnwS3V4Q5L+PlO3ETpz0VmzYYdhLYomUyI/6RJGrCOXcR70PkYxRWeOj+06UgI+dyngc9aIr5dELqbWQT1JpOdUgSmWhjJAi9+BEbA3CJ+wIME7FC0jEdCkmEtGpaY7gJ13RzzIwiZj8+Gzdo89kDMNkItAKTRaaW240qn27USeyGTjJSsOkdKtf+tyJMulkCgiOsawiQwPSqRkiHcVoPubgltEuxj829kyeAgEQKgGDaqbAkbInQKmMeqsIlxlvrMipeRDNrEslFlPfv43W687G+hb8ceP9JFH8KSnC1RLxJHUOnqOjTKzzBDgwuADhwGeEGcRXEzoL0H7ypitGgLmj4EkjIM1wWSzfqPQIltaTN0LNhE0VIiTdNljSOcn+KYTU1+Y9eWXmJAAKD5Ol2Ja58umE506epGPUvilEhZrXF+f0G6PvVwgpVGtSqeAEc9+cnfFfMzw3v5DhQAODLJVZplUciHD64FlltY/ETh8gRiaGY9qgKgxUJH8Z8oENVLIflnWnPPEWQaYy0Mq0C73NXdwi2sZ5rnCRT2kC7TPRrT3e+0rNuHfvCjtsESXmR0/2fDToj4fXlzTVPx8Pfx/Qx2A0uhnR/23//d3gos1AsS0Z0NLjHYBpM7G5KolEOEGVBpd4cO6AfltCe2gRPJVkOH5aiWIipcpItK5td7Kb3Bi9jHroclgzMAoqyjT7XF8Ywa6V0onldZEHmvJOlBKDeUPSLI/uHwDiYNbKudimlACG7TQuhL+C93J+gM+5X4C7Pkj3IB6k9E60yl8T3oprlyFWBeMG4fzXFeW/BCJ0wmsz0/a5NbjrvUszZtcbcFjJGriZhTfsf0a8hhH/DSbsp9ggGPNOnP5MklnVyIDbiJbP79/zxB0udI48eqH4aJXQa7/75k2t1SANS5W/gJnMNR4UL8mmig+Jh+Ssy6zeeUtqOq94bGrHdcWRvZheoA3TOd+J8/SFM67VqaOy1ukW46GZ2eLSH9FlBdJ421YZvZMJlYNUVHr8KyUSL1GOI/AhSsubzYQ7yor0YAqo+T9wzro9z79tqemqUl4Yi9xb0A1IwlYe4twpXIYU+A6ko5uR44KG93wrqMZfWC7/5xB8lCyKTuWmEaBe5KnqAnJHOSdaIGa+d3oqM9WNtc2TroePZL6r7F4pfhck4pYoxFwQ56wv+rfDcCUr3+44lEVY6h5uIsMWq/I6EDAo0Uzx8XPFsodnDJgVE4GXl2EsvWCzLznIcFVMjUKhzBygWPBmTfB1yFAk42D2p62ALy5FrrDzdfeH77pnIYFbj6kMFCr7mqtau7br4GpLwy+ncSyPhYenmZYqpIIQn1XJoEb7uyDEPLVaTaWH906v1zxdNG/MK3pDGAzRcCa1hyMheKGvbHXsEZZ7rWuZUaPwwH2++X+tszwCrNEVb3Hd88ApBhbuOh0DPcRc21HAi5X9OIYMa6v20lwjQ1wOxqQrm1dz5yrWCy1plrW96fCDxtg+giECVO4jj8kQ5bY/AYEw+iA= +api: eJztV1Fv4zYM/isCn3aAm/Zuhz3kZcu1WRGsa7u2tz0UBcLYTKNWllyJbi8I/N8HynaaNE56KzbsMOwpsUiR/KhPFLkAxtsA/WvAlLWzAW4SyCikXhfyDX040YGDQmMUPqI2ODGkGmWlrUJVBvIqdZbpCyeKrNfpjDI1masxMns9KZnCuKcGRUE2U+Mfn5y/DwWmNMrGip0yOvC6yaVGa7cHCbiCPIrSKGvCGjQxJ1Cgx5yYvGBZgMWcoA8rjiABLWgeSvJzeInxj6U/W+bkdap0Rpb1VJOHBEI6oxyhvwCeF2JYW6bbKJo6nyPXSz98hKpKlt6fwe92PsgyLX/RqOUW9YimpCDZ0TY1ZUaSGJ6R8hQKZwOp78YGJ2TC+F1PXRCX3gaFVlFe8LzevlTpK1saM36n9FS5XDNT1uuChd6jxKeZ8rCyHthrewsJkC1zIUttVrjyZU/W9h7RC+qwLmTNRvbX5/SboB+0CKGqqpsEWjjR3YeDA/lZT8/ZL5BApIFlkWJRGJ1GIuzfBVFZbCJxkztKWYjhhTasawctyV+HvMWAzjbTUiXNiXcICl2Q0bZbGFzp0w7Rc55vNc/KCSTA7on8lnxvKq3nvXdZ+xGPjFzuPNnDi+HganR6DAkMDq9Gvw8hgeHFxdkFJHA++Hw5POpyUJutEjAY+JLIdrlYXpUMmfZY5zEk+Tj0hEwdqd22iR4bMuw+rUwLkXJtkZ3vsu4JszNr5tBnX1IlwHIKjHnxtbEIgpdemiDmp3UdWJcnkGNRiMH+oj26fwCIp2kn51KX55pH3TSuhb9SCHi7hc9lmJE/3Ur3KB7mqE2n/C3pbbl2HHNVM24Yz79qKf8tECGJr83UuKfO5FYbl+ZKQl+DI0rO0tk0vmH/M+ItjPhvMGGzxEbBlViS8mezwum1Cvic0eb5/XueuO2Nzo5HLzYfnRJPG2/exDlDaEWqwxFNsTS8VTy3mOt0m3hkmXzhzIu3ZEXnDY/NynGdSGaPJkfs4nIpd+Iwf+WMV/rUi6bX6dXfIzt19aXfoSsKVQIfuzqjT5gpTw8lBf4rLZJs0V4ycA15c7OFcDtZkW8tASvxD713fiPy7zt6uraVV9axzBbuibJoKlBaes3zWAI/EXryg5Jn0L++kVuRE8+ctP+3FGNEEcE+LgeBQP6xnQJKb6APM+Yi9Pf3sdC91Lgy6wV6II897TZa8csoUecGWbigDkVfDc5H8Uq2sV1KKuu0rEa4zIx4bNvrSMCoBEnz5+eWZXdPHDFrIYJsb9LYRCFuXwtQ4OqUQqMsHMA0cmAd/CpkqotxdPvTs0AuLvlQ+3nfe3/woXcQK7gLnGPkUDPYnKzMay8jXDzz8NuZHJtzkc/9wqCOtSAmaNFQaG3+nbnAsrRYTDDQZ2+qSpbr6U2IlekgYDLoT9EE2pGCVwbLzsDuab4xuzYlFeIL9/Xu/7XRcgewtbH4GdeNfHgtwOJlT2BGmElzd71odg7SlApe2bVR59ZKxPHwChLA9bv54i6udlpo5yu2F4ta48rdk60qaMNn+YbqpqqqPwHYhvpF sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available actions in a user context, enriched by `attributes`. Append id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-compute-envs.ParamsDetails.json b/platform-api-docs/docs/list-compute-envs.ParamsDetails.json new file mode 100644 index 000000000..7cfa9153a --- /dev/null +++ b/platform-api-docs/docs/list-compute-envs.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"status","in":"query","description":"Filter by compute environment status.","schema":{"type":"string","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, lists compute environments in a user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-compute-envs.RequestSchema.json b/platform-api-docs/docs/list-compute-envs.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-compute-envs.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-compute-envs.StatusCodes.json b/platform-api-docs/docs/list-compute-envs.StatusCodes.json new file mode 100644 index 000000000..a278378fc --- /dev/null +++ b/platform-api-docs/docs/list-compute-envs.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"computeEnvs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"status":{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"},"message":{"type":"string"},"lastUsed":{"type":"string","format":"date-time"},"primary":{"type":"boolean"},"workspaceName":{"type":"string"},"visibility":{"type":"string"},"workDir":{"type":"string"},"credentialsId":{"type":"string"},"region":{"type":"string"}},"title":"ListComputeEnvsResponse.Entry"}}},"title":"ListComputeEnvsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-compute-envs.api.mdx b/platform-api-docs/docs/list-compute-envs.api.mdx index 77acb2e0f..5af00e3be 100644 --- a/platform-api-docs/docs/list-compute-envs.api.mdx +++ b/platform-api-docs/docs/list-compute-envs.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available compute environments in a user context. Append sidebar_label: "List compute environments" hide_title: true hide_table_of_contents: true -api: eJzVVk1v2zgQ/SsEz145/Vpgfdk6iVoYaySFk7aHIkBpaWxPQpEqSTlrGP7vO0PJ34rjPexhT5I4w+GbN2+GWsqgpl72fsjMFmUV4Dcwcy8fOjIHnzksA1oje3KIPnihtBZqrlCrsQbR7BC0A501BRhyQSOUqDw4MpsAf4dE9MsSTC5+/vls3ZMvVQaD/KcIVmgKeiLKxn0dqiNUjOODCpWPISaoA501XrTFEbVjIjvSluAU5zLIm2yuav+U0+3IUjlVAIViLpbS0Af51fvJjMzBrwrcQh4y8+lMBD6bQaFkbynDoqyDOzRTsoCpCq7A1Sjt3w9uPtNS/1t/MOxfDlN6T0ej21F6TW+Dm2/94YDfznZ9WK06m3R2+D+d0/cN8wQNHGYCc8oGJwguEYOJsAWGAHknltCfq4Q2FpBMU3BkmlhXqFAv/f5erlYkQge+tMaD5x1vLy74sQ/19i/aGg8wga2qLDVmsdTdR88uy+ND7fgRssBldyyMgPUB2Y4kts7KOcUUYYDCvx4E8+MarzpNCVoMpVaBU281NgJsEY0Dld8avZC94Cp4VUTX6TBtlltE0pEBg+b4265I7uqzCUUB3qtpO3ytfPjqoSXpnYrmigZLQGKAE3ZYKBLddsPYWg3KsHEj0ZuX+JqjxzFqDItWMwe4RtdqyxxEGSvtB+1VcjDFWjMHptWWooPhMWokmqQmUFarM1zZibzet+n5UuXCAbWlD/9G2LwFHZfhx6ZcXNaTUn25rjs5pM5Zd4T8XUsnrkesMDbwVWGfCQ+7e8gqFwtGo/USlAPXr8KMPh+4yWnuziyP5SlEjIpNsrt3IXEQN1+P58pp8piFUPpet6tKTDJtqzzx8IswJGiPJtpdtIgvTbOJK/YX/S8DyQjWAO+Yz5qbXZgbevjE9RCLwo1OtFK/fFrr/fE5xMTRTGzc3nDZoOBjXwPI6WIGvnFmIagsCmE/+d2USQuo4wCd2I9bAzcNMVef8yb540NyEfvQ+lCoqKPmfhi+dB8fol1uhfm//zNoSstRujSLMY6hyPGykeLxv9GMqOP15XKsPHx1erXi5foyZYHm6JkIEvWEhg2coO/c34dWmE+w2P1LmStdsZPkO/98CP/dbX8C9P6/yBb5A384ZOhxPhDZdNNRkzGt9dZ+lkEZdnYdjca9qfI5vSdftd/JB50bo6/ve7PYiU0ljh739gkMlXmNP/A3HUTz8B9kz+Vd +api: eJzVVk1v2zgQ/SvEnFk77RZ78GXXSdTCWCMpnLR7CAyUlsY2E4pUyJGzhqD/XgwlfyuJ97CHPdniDIdv5j3OsAJSiwCDB0hdXpSEH9CuAkwlZBhSrwvSzsIAxjpQEMoYoVZKGzUzKNodAu1Ke2dztBSEtkKJMqAXqbOE/1BPDIsCbSZ+/vHi/FMoVIqj7KcgJ4wO9EaUrfsmlBQqxgmkqAwxxFwbQi9m6644onHsgQRXoFecyyhrs7lq/BNOV0KhvMqR0HMtKrAqRxhAsx8kaK7Bc4l+DceV+XImgpAuMVcwqIDWRRPca7sACWjLnBm4miTD+9HNV5Aw/DEcjYeX4wQkJJPJ7SS5Bgmjmx/D8egapnUttxj3ivo20L+35bRljl6nQmdoSc81+p4YzYXLNRFmMvISzqW3KzVtCRfoQcLc+VxRs/T7Z6jrqQSPoXA2YOAdny4u+OcQ6u1fICEeYImtqiiMTiN//cfALtXpoW72iCkxl57ZJt0ckO7xvHNW3isukSbMw/tBdHZKXC1bCjoMhVHEqXcaW1V1KMGjym6tWcOAfInvKuM6GSftcodIJJAmw/F3Uu/dNWfXEnIMQS264RsV6HvAjqT3GM0U4QfSOcaEvc6VX+9tmDlnUFk2biV681q9VjromTaa1p1mDnCtfact9RhlrEwYdbPkcaEbzRyZ6l2JjjrCpJVoL7Hk11Cf4cpOtYTPXXq+VJnw+FxioH8jbN6iPdPwsKWLaX1Tqq/zupdD4r3zJ8h/67iJm74prCPu/+4FsxgqYFr6SNhDBZeoPPphSUsYPEz5kudIS8e9doERo2IT9A+mDAfxq03PLb2BASyJijDo91Whe6lxZdYL+Ixe9bQ76Wh30SK+tZdNXLG/GH4bASPYALzjeja12Ye5LQ+fuGliUbjRCWT758tG748vFBPXdu7i9raWLQo+9j2AnK5OMbTOLASVRiEcJr+fMuZKm9hA5+7PnYEvDfrQnPOx9/HiU+8iXkQXKFdRSO2AGL82ZY/hVjtl/u/nfcstR+kXRunYh2KRq1aLpy+epQvE61U1UwG/e1PXvNxMU1ZopgMXIoPBXJmAb5Tv3EdBJ8wnXO+/PVbKlOwEPPTPh/Dfjfs3QB8+RnbIp/zhNUOPDULCElWGPpa12TpMUyxob9dJbzxoK1+Te5CgDq/y0dWN0TcD3673YldV43HvntDWNWzwE39DPa3r+hfbltra sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available compute environments in a user context. Append `?workspaceId id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-credentials.ParamsDetails.json b/platform-api-docs/docs/list-credentials.ParamsDetails.json new file mode 100644 index 000000000..30806bd73 --- /dev/null +++ b/platform-api-docs/docs/list-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"platformId","in":"query","description":"Platform string identifier","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-credentials.RequestSchema.json b/platform-api-docs/docs/list-credentials.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-credentials.StatusCodes.json b/platform-api-docs/docs/list-credentials.StatusCodes.json new file mode 100644 index 000000000..5f8c28913 --- /dev/null +++ b/platform-api-docs/docs/list-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"type":"array","items":{"required":["name","provider"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"name":{"maxLength":100,"type":"string"},"description":{"type":"string"},"provider":{"maxLength":16,"type":"string","enum":["aws","azure","azure_entra","google","github","gitlab","bitbucket","ssh","k8s","container-reg","tw-agent","codecommit","gitea","azurerepos","seqeracompute","azure-cloud","s3"]},"baseUrl":{"maxLength":200,"pattern":"","type":"string"},"category":{"maxLength":20,"type":"string"},"deleted":{"type":"boolean","readOnly":true},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"keys":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"s3":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"},"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},"azurerepos":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},"azure_entra":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},"container-reg":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},"tw-agent":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},"k8s":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},"ssh":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},"google":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},"bitbucket":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},"gitea":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},"seqeracompute":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},"codecommit":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},"gitlab":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},"aws":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},"azure":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"}],"title":"SecurityKeys"}},"title":"Credentials"}}},"title":"ListCredentialsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-credentials.api.mdx b/platform-api-docs/docs/list-credentials.api.mdx index 4add70a4e..8a3b0fb61 100644 --- a/platform-api-docs/docs/list-credentials.api.mdx +++ b/platform-api-docs/docs/list-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available credentials in a user context. Append `?worksp sidebar_label: "List credentials" hide_title: true hide_table_of_contents: true -api: eJztWt1T2zgQ/1c8eg6BQq/T4+Uu5DjKwJQOaeceOsxVsTeOiG0ZSSZNM/nfb1e2E3/lg4HcEOAFEmu1u7/VfsnZKTPc1+z4O3MVeBAZwQPNblrMA+0qERshI3bMLoU22uFB4PB7LgLeD8ApbHBE5HAn0aAcV0YGfpq204ljiDznxx9jqUY65i6cez8cI50AedU3z6lyDi2H2+1xwM1AqjDbPRCBITGF/f0J7gnjxIjId3LyNmsxGYPihODcyzB0CyBbLOaKh4DsyABTFuEXpCvoizSC4N8loCasapR/5ipHSQhKuI6wzAcCFBJrdwghZ8dTZiYxMRaIy7dLpCA36aMP79ls1ppLX8BdLfxLRudoowj3atEpEQrCk1WgYxlp0LR+eHBA/8q8ry6Qhz2GyNAqj+NAuNaS+7eaSKZ1EbJ/C64hqyqyuxGpgKJbLYi5UpwwCQOhfa7gLhFISp5oLWH53CMqRd64Wobw6G/If15C5JshOz48bFWRtzIDl+jeHRw0EJaMUTNhQbEKsw9VXi0G6BkEiY/J3/ivREH+/1+0iuL4zZfSD+ixL8ww6acfMMTwQ1+YfuKOgCBrPcS/o486OxsuIlB7CkiMGe9xnw6LljzAaAiFSRkBzwUqiCVt1nCHYZFGzFybPTeQCbmcPmI3iLHPNXxTQdWuZK+YGwwZ8hPWYDx0E/AlOmx1Z6OhA4w+r2DkvpQB8IiRl3LvKgqQj1EJIHHAtfmmS9RzM8/jyUPpe0ZY/6lxoEVMANw8holVI/Yex2QEE70+dDxBfhiKiBupmoRV+BLE6paM4+Rzml3K6y08oTgmXhTQR0+vETqX64LWFzBpjCQNmB5M42qLjRV6b4kZet6wZyYBdCzX04jqUJP7kCkMBhE96x31wE2Q1+SCrD6bx9kW0FIFzNNMPW1wrbG2NLpNFWtB/zNhPiX9KoZCRO8Ijg5pfE0aN2LJ0mEDGOw6rga2QD81zD437vDzMpwa2WBWXbpud2/suxm3DemrdquYbPpo6FjaeWTOGw6RcnggYM1iz0buRlCo5yiBOaWTzg+/XMq25MtLz/Ahvky8fewhVVMuKxxYN0d0nZHnUOdVegso0YwRcsp63Qak1NX+JRqYkW8OuVqbRzt+euyl0KV2ZBtoaPOAWs4lx6bEPa5tHHxGjqChl1sZdxcfa4mKWrAtoH0oGnLaeKiwQ3sgpF7vU60Wps3nFlBhA9RwA1ld6qwyVRUXTfAWtNzYM7ZTFE+EObHYGnoU2OB29TxK+xkpWwuW0jXjf63rT9p0oknwdn+NCbGjmu6DxRQ5rqaMxxbqUvHsWYt2U4tWzV249+2I13RR467VuMH56f778sIdA+WS13v58VaK6POJguzFxxYw7moHT8sygleQ/55rW7EbObLx8v860uKLQ7ms19sZT6z1eC/qKvRabrFvRXjHIm/pi9MX/K7spbwg2w0PW3oTe3sZ/6pexr+9o9nqO5pnbsQn+XW1ZIrSjbeQbgojIbPiQmVC5zobVCEipHrfNKpywj2HZkdAp8MPG86sFMdNQgSLyWD9mElOuNK/TpWSqqb5UV3zq3w4yYmkodEqOUZ9Zum5WcPZuDsBLD2qk9AQxfcbsm8IZihpoMm3cyF0bPhl3y2NNmGVuM/nmhKa42BDY2J9vL/PY9G2wx7t9A1tW0hWHS5KvdiZzxh1id7pfDm3B5zr1yNzpqYpajm3Dklk2TCS9R9LhE/SD3/noxK3Y2Nxi2gg7fZSLFmx6xQkuAK9NiO2Pyq61g/K4IuQ0RUErZHYPxcLqAhZLpXzrv37b+0DW1qlNiG3bpRNal1W5tiqSk4X7rij83PZORK3fXwuIjJEkk4FpW5XGxscopno8XSaTRDNZvQ4nWEjZ8Qkl+WVAW6BFTZbM17XqNyIkl1lgu+eBwlR2gy8ufiVA3YrhJcG+Bayb+iLEiTcBjKaCrM5DZGhUdKdlHdjU9hVy2Gl8D87/UoVuhxzlRgrlm4eTQq88YAsxVe6VOIh5eqnl8zZDSau/wBjv9cT +api: eJztWm1v2zgM/iuGPrsva4dhyJe7NNfrihbr0Gy4D0NxY2wm0WpLnkQ3lwv83w+U7dRvSTO0OTTtvjSpRZF8KJKSnGchCCZW9L6KwGCIiiREVtz4IkQbGJmQ1Er0xKW0ZD2IIg/uQEYwitCrTPCk8sBLLRov0IrwH9r3+kmCKvS+/TbT5tYmEOB5+M0j7UXSUnvyUqrU4HvgpicR0FibuJg9lhGxmcr80dwLdJykJNXEK8X3hS90ggYYwXlYYBhUQPoiAQMxEhoOwEIoiFH0RMVf4QvJ8H+kaOaiGZS/li6rNEYjA0865WOJRvjCBlOMQfQWguYJK5aKcOKG2EGg/NG7tyLL/KX1e7jrjX8q5DxLhnGvN50LiSy78YVBm2hl0fL40eEhf9R1X10IX7hlUMSjkCSRDFwkD75bFlm0TejRdwyIo2o47iRzA9W0uhcGY4AxScLYPTf4I5UGQ85EFwmn506GaDgb19uQIf+N4Z9LVBOait7Rkd9E7hcBrsm9OTzsEKwFoxXCimMNZe+aunyBKo0ZEsw43+Df1GD5+TcqMiB8MdF6EvHjiaRpOsq/RMBfRpJGaXCLDNnaqfDF7XtbrA1IhWbPIJuh2R5MeLF4KMRAx7GkXBFCadBgonmyxR9oIK+YpTd7QaRTTjl7LG4yX4zA4hcTNePK8UqACA3niegIXgCEE23mrZmdgY6QMKwEeaR1hKAEZymEVyqaix6ZFDNfRGDpi61JL8O8rKcQCPdIuvxpaeDBgUGgxyhxbiTh45Tc4tw+XDqh5DyMpQLSpstYQy9DbE4pNM4/5t2lPu6LGJKEdXFBHz+9R76AIEBrL3DeWUkWA4PUOeqLmZGENWUJ0HRI8wj7Tuup4n2oK304FCQp4mfD4yEGqZE0v+CoZ8s62wJa3gHLNtNuG2DtTJvOtGlirfh/JulDOmpiqFT0juDos8fX7HEnlqIddoCBKLoauw36qWGOgILpx1U4LWkDE1w57mZvnLuFtg3lm3FrhGzxaOiEChSddywi9/BI4gODQ1e5G0HhM0cNzCmvdLn49a1sS7m8cg1/JpdZ90RaMl29rLJggxLRdSFeQl3u0ltAGWilMCjPuh1I+VT7h+xQxrk5BfNgH+1P8mWvlS4fR7aBhieP+ci5YtmMvAPatJh8QfoWO85ya+vu4n2rUfERbAtofxYNJ20yNWA7grMW0nD4obUX5ofPLaAKgTpuIOu3OudM08X7Q/AWvNw4M7azKZ5IOnHYOs4ouMHt6nls7WfsbKtYateM/3Vff9JDJ1ibxnitI+ybrvtgtUXOmi3jsRt1bfMcuogO8og2w1259+1I1gx0iAPncUfy8/335ZX7maRLaJ/lZ1vZRJ9PFRQvPraAcVdP8DysFb6C/vdcjxW70SM7L/+voy2+OJSrzno7k4mtM96Lugq9llvsr014xypv5YvTF/yu7KW8INuNDFt5E/v1Mv5VvYz/9Y5mq+9onnkQn+TX1VooajfeSrupUEKy6kCDoXNdEFVYKPPF2y6qygmEHnNH0NLPcFaqdJMYrYUJPkwzKQXX5tepMdq0PD9ue35VkpM8pYmpVXqGoVNli8C5ujtBMGj6KZMovt5wfGOkqWZC08TxQnjZRE8cBDVqk0VzV/KaUuZxiClRYnsHB5DIfUf22M/f0O5L3SIX5VnsLTlGA5b3+p/O3QKX/g05nHloql4uo8MWSzKSyx8nxLQW9+XPkirxfUYOt1Rj7abXasmZfchBhisDtIWw+1ExcHlQB1+FjDHIyHGwxvr3+4HMFxy53M6b/TeHR/uHbm/VlmJweVRQtS4bRLaml4v7fNxRAl2xkKztIIlAKg5EmtOC8rxr8Qan2hI/XiwKClGW8eOcxMbZGEpbNJYxRBbXxOwBfl2nc7fc7RoUvjuIUpZ0LXhz82sZdmuM1xh897Zv+B8j2birZF9MERyL7OuimMmNN6HKrFYTq9X/2eln3qLrRdcosureDWpe0b1Y5BKf+VaZZaJ0P79lZjdZlv0HnvHXOA== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available credentials in a user context. Append `?workspaceId` to list id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-data-links.ParamsDetails.json b/platform-api-docs/docs/list-data-links.ParamsDetails.json new file mode 100644 index 000000000..324f127d6 --- /dev/null +++ b/platform-api-docs/docs/list-data-links.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials identifier","schema":{"type":"string"}},{"name":"search","in":"query","description":"Free text search criteria — data-link name and keywords: `region`, `provider`.","schema":{"type":"string"}},{"name":"max","in":"query","description":"Pagination max results","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"visibility","in":"query","description":"Filter results by visibility","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-data-links.RequestSchema.json b/platform-api-docs/docs/list-data-links.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-data-links.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-data-links.StatusCodes.json b/platform-api-docs/docs/list-data-links.StatusCodes.json new file mode 100644 index 000000000..8b0e44b29 --- /dev/null +++ b/platform-api-docs/docs/list-data-links.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"},"description":"Array of data-link objects."},"totalSize":{"type":"integer","format":"int64","description":"Total number of data-links matching the query."}},"title":"DataLinksListResponse"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"dataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"},"description":"Array of data-link objects."},"totalSize":{"type":"integer","format":"int64","description":"Total number of data-links matching the query."}},"title":"DataLinksListResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, or the API is disabled in the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/list-data-links.api.mdx b/platform-api-docs/docs/list-data-links.api.mdx index 91f0a2397..fee677eeb 100644 --- a/platform-api-docs/docs/list-data-links.api.mdx +++ b/platform-api-docs/docs/list-data-links.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves all available data-links in a user context. Append `?wor sidebar_label: "List data-links" hide_title: true hide_table_of_contents: true -api: eJztWV9v2zYQ/yqEnjbAVtKkGzADw5YmbWGsS4Ik7R62YKIlymZDiypJ2XUNA/sQ+4T7JLsj9YeyHNtLN6wPfklM8nR/f3c86ZaBoWMdDH4NEmpoX/DsQQf3vSBhOlY8N1xmwSC4YUZxNmOaUCEInVEu6Egw0jxDeEYoKTRTJJaZYR9NSM7ynGUJiX6YS/WgcxqzYfL9ciEL1a93+jxZRcRIokoRHZ41ac34tyzoBTJniqJ6wwQUfMO1uYAH31j9e0FOFZ0ywxSatgwyWACVpwfQcLTsQ8HUIli395daZlZMmeIx4QnLDE85U0Cs4wmb0mCwDMwiR8YcFBvbo1SqKTVu69vnwWrVq6XHilkmVOhd8s8b0h2SNXgtG7fkaEZVPNku4JVijKAziaMmcAbe4pT89cefTQgIsiQUgvjAFuC9RA9IpNgYmEQ9EuVKzkA9FYV7qjalH7frdU3HPLNhJUALoNCFMHp/l5+etOTJNNXM7C2yJn+atBnXfMQFN4sdzucCfF0ZR0YL0nrycUdCXsJDucw003h+cnyM/9rcr34CHjZVMoOnNM8Fj62BR+81kiy7IuToPYvRcggpJJbhTkBSp1RDSpWi1kDDpno3C550LVl3yEWNN0fgYT4kr1mGmc4SMqIa/kKcKtz1CPLtEYfIngUqOAgKDGRuTs0kDFa9Mjq7dLhEpMuUmIlXgshXLByHPTIq4gdmbDZ8bXm2nt1pXrPqSAjJZQElFVDlFz5aGNlPuI7ljEEpIKmSU78QNuXBalPZfMPS3drc+A6yglsK9aDqxqJIMAx48PZmSCxcWOWMSJ8Ojo6mi77zChaCsV7foZ9gh8axLDITIhophzBGzntOwXXgNijA85CcF0qBlWJBdJHnUkGqRKUArDfrVjIo1XiPORK8wz72ca8/owoDp9uHhhvBSqkI8Ttkt7Lotdjq6ncuZJHU2Ot6LiS3tZ50rq1fpBwL5vxRqObH72CXovWyHyNrXGr2AcAey2leGCRHRIO/txoMsmDlRMEPy7H67wRVKycHS4wvBtenm1xyXbnCQmy8F9adkxz1o+kUFbrPqDb9Z2gzK7Bg9OdMm2cAEPIzXZAR3rxlXmgJ2Kvc7gDvJcC2yqTYh4IDKXqJo922FHgxvu/9C9XLv6y79etpFWg9w7eg0pMetxD6P2Nm1T30dO0U0eAMo4f2e7aDL6ghMYU+MI6ZxjXXfsa9nOZmYVGSFyO45rwi6vxmd8/sw3wk/CiMpBSMZt3eb8IgAmu5TUCs4wXliNbsyJybiSxMJ14TnsB6D2nv6psfsENNoUkq6Dgkw5RERhVYA1pKOMbuQkhYSqGDIAKaX2gh2NzJdnw24U0xmlxlYhEMkDUEWIir1DbIuygr3Lw7ezO8gPPhpfu1AQHhrZO/6rxFuIMNV+A5BBgyPrI8IwLRjEoBERRVuHjh/aDeIfMJOIBqLWNu2wIfL1QBYyag80+sL6DsazreI/leKgViS3ILKJ7NqOCJj6jmru4cbcT7hZFbcN7E1RUfFz0jDRW3/BPb5/VinfcdPozvLCMAsC9CQztt4kl1qdu+dLPOGl+lbsouEyiQ5uT4pFt4MKly8POh2zx0m4du89BtHrrNQ7d56DYP3eah2zx0m5/VbT7f9FXzBU1uoL5C1f4n/aZfkqvg7KzCj0bRN8BGsKP46YbPsdWcgmTS4PhEzkEfS/28S30pzStoYhL7Gb5pwQADPu6QU4pkPVK2BWfXQ8xXaOJwLpPg5AS3aw7hl+o1rCAsLhR++sbS8IJBUqmzwkxgeY9ZPYUCKXHGM7af5rGPhMWRN65CFmpWzXoKJeB8YkyObSLNeWjvlNDdKCGXHRzf2hNyLahBxBPXVYBLbVWp1Lu1bam11VeyNhclVl/vbQ22RLDjfryqcun93Fif8CyV9vHSN6UWKHaXgmguh1uhJLYNb2wD2zbeNxliy4VN5VT+2ByAIug5J+dZ+N034bG9yaQ2U2pxUQ43MFFJy+lrbyU1vL7EaWEZI9w4ygW8HaCR1lnLElHrA9AJeAB3l0t8EXyrxGqF226igzirci0YpJCTbIs/dkwTN+r2wEDK2sASroECKQOcOe0v/tFh4hbB67PKJ4r+D8aMW5SuB59P1PbR4eMWmW6i+fkC69HjFlk1zVOjsX3uuEVyi66Rfo8LiKZtdaFaQ9ZAJ4fvDZAf7kn3lch7qnP1tGr865d3+CrQrqxrldRvIWnmawS5ainu5APLIF8r9Q2uQRBcN38DexJ0MQ== +api: eJztWc1u40YSfpVCnzYARXvswR4ELDbO/ATGzs4Y9iQ5zBrLElmSetzs5nQ3pVEEAvsQ+4R5kqCaP6JEWfI6GyQHnSSyi/VVVX9VXWSthceZE+NPIkOPIyX1gxP3kcjIpVYWXhotxuKWvJW0IAeoFOACpcKJItg8A1IDQunIQmq0p68+hquiIJ1B8velsQ+uwJSus7+tV6a0o+7OSGZVAt6AbSAGOjvRTvG/tIiEKcgim3edibF4J51/jR7fBfsjUaDFnDxZdm0tNOYkxqJnh4iEZM++lGRXYtffnzpMXeZkZQoyI+3lVJIVkXDpnHIU47Xwq4IVS+1pFpamxubo61t/fSmqKurQU0tBCSp3DP/VRvQIsvNW6tkWjiO06fwwwFtLBBxMqKUhtdKTlQi//Oe/my0AVgmoM3ig1dLYzI0hsTSTRicRJIU1C5mRTeInmpbj18N23eBM6rCtkONXsORK5d3TQ355sYVnplNH/smQnfjz0BbSyYlU0q+OBF8qT7Z1DiYr2Hry8UDeR8KSK4x25Hj94vycf7a1f/iHiERIFe15FYtCyTQ4ePbZsch6CGEmnyllzwvLieVlDZB1KbURRWsxOOgpd8dVyGzoyW5AXnd8qwV6nI/he9Kc6ZTBBB1lYDS0vIuA9UZQMzIKRLXkTGlTggL9PBZV1OzOMRveM9PNFPy8V4LgLxTP4ggmZfpAPmTDN0Hn1rNH3dtcDRBieF8qBVNj+4UPS29GmXSpWZClDKbW5P1CuCkPwZrW51uaHrfmth+gALxlUARSp6rMeBt44Yfbawh0oTYYibscn53lq1EdFS4EM7d7B38en51hmppS+5jZiFKTTero1QbuEnfDAl6P4VVpLWmvVuDKojDWO0gaAK43u16SLnM+x2oRPsO+jvjeaIGWN85tL3rpFTWoTPGPrK4K7A3cGtr3Spky67g3jFwMd52duHQhLsbMFNXxKO3mz79Je4vd5Shl1Xzp6AtZTE1elJ7FmdGJuzzoMC65QNZQIhJBY/tbA7VXNQ6XmD4MX1/uC8lNG4pAsdmTuF4HqZZ+NJ2S0o0InR+9YJ+p5IIxWpLzL5JvYvgnrmDCJ2+TF87k1IW9JnwvAQ5VJktfSmkp4yhJ9juUgt4e30f/h+rVP6yH9et5FWg3ww+wsoeebjH0D+ZMNVzs2TooouKKd4/97/kOfo4eUtSAaUqOr6XrZ9ybvPCrwJKinCiZ9opoHbdw9yo8LCeqvwsTYxShHvZ+c/Jz2sltkK5BUKvGFlYHS+nnpvSD/ZrLLCP9BLQfu5MfnEdfOpgqnMVwPYXE25JrwJYRteL6QMhoiqXyoKTzsJC0rLFrPfv4ZgmzD1qtxJhVRwKV+jANDfIxyZY3P169u34tInH9vv63hwHxXY1fDd4i6oU9R+Ar1JzxSdCZgLGQNABJDHfk+f2guwPLOWlA50wqQ1vQ5wtagowUecpCLHJyDmdPSL431hoLjXgglNQLVDLrM2pzVg+W9vL9tTcHeL7Z17r41LvnjUd1J3+mp7xe7Or+yA/zO8uE7BaEgxx9Om8P9dCX7rfZ8avUbdNliqpimYvzi2Hh4aQqPGWnbvPUbZ66zVO3eeo2T93mqds8dZunbvPUbf6mbvPlvq+a32F2S19Kcv5/6Tf7JbndnKNV+NFd7DsQdnBg+OWez7HtnAK08Tw+MUvKRJB+OZR+b/xbU+osfIbftGDGbvGONU1ZLIKmLbi6ueZ8zaTjuUzGkxO+3WmI/6xR4wpCaWn50zeXhu8ILdmr0s/F+NM9Z3VOfm54xjMLn+a5jxRjcdYbV7EKu2hnPaVVYizm3hfcJmIh43CmxPWJEksz4PFdWIEbhZ4ZD3VXcXVzHapKa95daEuDr30jO3cZsf16H2pwEBJR8+dtm0uflz7EROqpCY83sWmsYNhjBrK7MiXXCIeGNw0bu+1832XKUaqQylPz7WahigRHrsZ5Eb84v4jPw1FmnM8xEKOZbnCmwlbUd15LOn79GceFzSbxjbNCodTsZIjWuqHU7gR0bpznu+s1vwn+YFVV8e16pMNEa5NNjKeoHB2Ix5Fx4l7bHmg1mFguUJUsKXjo9HT4R6eJB4B3h5XPhP4d5owHjO4mn8+09tHp4wHMeqT52wG72eMBrE7mubtxePB4AHlLboN+zxdWYuh1P91zK0oYXhw+rZsn689EvacGZ89Wkf/+zUd+F9gurTultN9Dou5btF7XEh/NA+mqEq35nq9FdV9V1a/xiHRW sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -43,30 +44,24 @@ Retrieves all available data-links in a user context. Append `?workspaceId={your id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-data-studio-checkpoints.ParamsDetails.json b/platform-api-docs/docs/list-data-studio-checkpoints.ParamsDetails.json new file mode 100644 index 000000000..e0b90d878 --- /dev/null +++ b/platform-api-docs/docs/list-data-studio-checkpoints.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, checkpoints are listed in the user context.","schema":{"type":"integer","format":"int64"}},{"name":"search","in":"query","description":"Free-text search filter to match against checkpoint `name`. Supports keyword filters for `status`, `before`, and `after` (checkpoint saved date).","schema":{"type":"string"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}}]} diff --git a/platform-api-docs/docs/list-data-studio-checkpoints.RequestSchema.json b/platform-api-docs/docs/list-data-studio-checkpoints.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-data-studio-checkpoints.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-data-studio-checkpoints.StatusCodes.json b/platform-api-docs/docs/list-data-studio-checkpoints.StatusCodes.json new file mode 100644 index 000000000..42cfe7003 --- /dev/null +++ b/platform-api-docs/docs/list-data-studio-checkpoints.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["checkpoints","totalSize"],"type":"object","properties":{"checkpoints":{"type":"array","items":{"required":["author","dateCreated","dateSaved","id","name","path","status"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Checkpoint numeric identifier."},"name":{"type":"string","description":"Checkpoint name."},"dateCreated":{"type":"string","format":"date-time"},"dateSaved":{"type":"string","format":"date-time"},"author":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"path":{"type":"string"},"status":{"description":"Checkpoint status.","type":"string","enum":["empty","interim","finalized","invalid"],"x-enum-varnames":["empty","interim","finalized","invalid"],"title":"StudioCheckpointStatus"}},"title":"DataStudioCheckpointDto"},"description":"Array of checkpoint objects for the Studio session, sorted by creation date in descending order."},"totalSize":{"type":"integer","format":"int64","description":"Total number of checkpoints for the Studio session."}},"title":"DataStudioListCheckpointsResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the Studio is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx b/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx index aa2b675f3..0e3013d78 100644 --- a/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx +++ b/platform-api-docs/docs/list-data-studio-checkpoints.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the list of checkpoints for the given Studio session ID, sidebar_label: "List Studio checkpoints" hide_title: true hide_table_of_contents: true -api: eJzlWG1v2zYQ/isEP7WAY2dtOmAGhjZNmiHYlhZxin4IAoiWzjYTSVRIyklm+L/vjtQLZWtuYmxAgX2xLfGO99xzLzx6xa2YGz6+5saWiVSG3wx4AibWsrBS5XzML8FqCUswzC6ApdJYpmYsXkB8VyiZW8NmSru1uVxCziZuI2bAGNyAnZ8OmFHaQsKmTyzWIGhflggLTOI32oI8kfmcKZ2AHrLjosAXLHr/oPSdKUQM58mvEbPK2w4No75gjRiLVW7h0Q7ZpCwKNGlYIeYy9wYF7jmTqQVNtkpDnwQ6MiB0vIhQVosMcH3IB1wVoJ3eeYIU/IGGT4UV3rWTFgFKNmrE4orn+IAalfeoPeCSWCyEXfBNajeoMtZhkwnkVs6kR6LhvpQaEIbVJQy4QQIywccrbp8KZ8pp8fV60FgPmKvt35egn7YAfGu4y8sMmYlD4+zbAsOpMmkxeIMO8UL7TMCgYgyIxtKAbgLAe2CiHsxB4xKmSyasf/XzUQe4j8VuzGca4IDMMC9dRZUSBLfFZzEXMu9kCoto/yhIjDt4QpLqjPApHBkrbGmiAYumgC8Af1HWRGKGMhF7FWxoxBJ9pyR+3ettT1Ay8bjbsT/Fo8zKjEIxRX+wyDSYMkW06JoGW+p8yE5hJvDdmEXvDqMXEP32TQeMms0M2N14LvpwmDtZOLba0gpBvRzTDaW4KVSOVUAabw4P6asL5fPvqOqyK7e0KooilbGzPro1JLIKjLYlc83jTrFaZUU6kX8BtbkKm5reQkxUFJqq3kqPI1RsHRFaC2JKWsjMpi1R2oUiJykvTqjTQVI9TShfSI8+XAwGdUvwWfd9QKj6jGraDGLbrPpKnK8rNFuZu2sfVHCaoZs9GzTISO7ASjSzDtl4tkrF6ybbS+zIxABGXaY1t9SHLsijf4nPdbDldnnXxvtWKnx9PYFbaVN69RW3Ps9niuRdOvRtVCXIVlEEIfEiVHqbjAJGndiCrLAucXM6ATNyFMs3xVLwR8QSfydE2uMBqRwshaY4mxfp1m5tnpMT70Hoed9xemodEV0vj6niuhMH8xFtB4/uOfqyeYMstm1hjwq7IuWgafdNRl2Aw39ggsaMYLi4rNoiSpP8UV9j/CiSS6wJMHbfBokxNmL+jHqpBXcm9Cetld4C/rano9cDFsuVZSJN1QMkLhhHh0fb4hfKnqkyxzHkgYaSgFNp3A4zWsWQtuvHX85pMZFGTFPMhjoWzXA0/FEpo5qHuNQSq45myo8454A+Lqk/XN/QiYkD50LRZDp3h7hvHXxUzfCjVTN+rkfdAxD7zbIeVUuNjYsvrC3MeDQShRzGqSqToYF7jM1Qqu151a2wL6mwVBTshOSJaE6gaswTIs0TECJvOCCL9ZBAz1MnhG/8j7O63G4frCNKUoMk9bq7eBRk9nsAyV0Z49XFC1O0Reyi3XU+dLnq6M7sh3YBgRBz3s5Pw1/eDQ9d11bGZsIlSzVaURXXydklv4N11ebe//OKVWUDbTcqUhzZ3Vmr3WHqE7q9lA74OLxRhbRi4i0wBiS9Wk2Fga86Xa/ptZ9qKdPrHsDHM5Ea2BGJ/+5C1OsuXkO2rmt4mpYkyWlcfz7yH/FatMPn5qa3p7v7XZZ2APLXsz3R7H9V2oGouaO1oG7oQUtC9cLEfnVZHWCvN7tH778OvbDqO1D+FIJqI1oX6PoGhRcgsNc4lH79OI6hCN3ZOnA7J9tvn664H/2Do2PjqHC796LCVuAkrtQd5NgOapCWngngev039leeLA== +api: eJzlWG1v2zYQ/isEP7WAYqdttg8Ghi1t2iHY1hZJin4oAugsnW02EqmQJyeuof8+HKlXW3OTYAMK7EsSm3e85557ZbaSYOnk7It0VKbKOHkdyRRdYlVBymg5kxdIVuEanaAVikw5EmYhkhUmN4VRmpxYGOvPlmqNWlz6i4RD55TR4vwsEs5YwlTMNyKxCHyvSIFQKC3YFupU6aUwNkU7EadFgToV8a93xt64AhI8T3+JBZlgu29YaQGiFROJ0YT3NBGXZVEYS04UsFQ6GASdioXKCC3bKh3/ZNCxQ7DJKhYFWMiR0E5kJE2B1uudp3Im/1SOzoAguPamQyAj2aoxi1upIUc5k7X356mMpGIWC6CV3KV2hypHHptKUZNaqIDE4m2pLKZyRrbESLpkhTnI2VbSpvCmvJasqqi13mOusX9bot3sAfjccqfLHK1K+sbF5xVqYXJFhGk0IB5syARMOQZMY+nQtgGQIzCVJlyilZFcGJsDha9+PhkAD7E4jPmdRTxiMyJI11HlBMmBkpWAJSg9yBQR8/1xLzFucHNnbJMRIYVjR0CliyMRz3FhLMaRz5oYFoQ2Fs96FzpYY+qT+PmotyNByeH+sGN/wb3Ky5xDMUfLRWbRlRk5ds0ilVZPxBkuoMxoJuKfjuNHEP3q5QCMWSwc0mE878dwuBtVeLa60uqDejyma05xVxjt0LHGy+Nj/jWE8uEPGUmfXZr4FIoiU4m3Pv3qWGTbM9qVzBeZDIqVDEF2qb4ht7kam5l/xYSpKCxXPamAo6/YOQLWAjOlCHO3awtKWhl2kvPiDXc6TOtPl5wvrMc/fAyipiWErPs+IJU+pJp2g9g1q7ESl1WNZi9zD90DOXrNvpsjF7TIWO6IVI6NUmDjwSo1r7tsr4GAGcAcVNZwy33oPXv0L/FZ9a7cL+/G+NhJjW+sJ0hSlPFXnxzac70wLO/TYeyiOkH2iqIXkiDCpbfLKOoyZ7YwL8gnruYJmLOjSkOmvoW01GvIVMqk3R+xytEaLMfZPUq3cWt3Tl4GD/qej43TM/JEDL085YobbhwiRLRbPIZz9HH7Blvs2sITKuyKlXtNe2wzGgKc/AMTvGb0louLui3KqmL5k7HG+BrSC7wt0dFTG2SOzsHyAfXSCB5M6LfWGrsH/NVIR28WLKENCcgyc4epD8bJ8cm++HtD70yp00jc8VLS41Q5f8OCT4Wx3fnpx3M+TJWDeYZpG4t2OZr8qJRxzWNSWkUbv1O+RrBoT0vuD1+ueWLmSCvDm+nSD/HQOuS03uGn23b9rKbDAejQrptVtbSZnMkVUeFm0ykUapJkpkwnDm/RwkSZ/X3Vn4iPGRAXhXjD8ky0ZFAN5ksmLRDQR95ywBabJYE/z72QjOo/3jXl9vWOPFGKGySrN90loGCz3wPI7qoEXS3M0YbER3vofN/luqN7s791B1Ukmblg58XkxfHLybFv28ZRDj5b6t2Ky7jJziH7A7DbLvn+n2+sOh34ummRgdJ+2Fo/TUNGd6/SSM76T6o+rdeRXBlHLL3dzsHhJ5tVFX8d1lpO9aYJyNkCMocHIvHfvYhG3b3Bzd57bQ1ZyZKS9/WHI/8R30UHfG6fek9092mvpQOAwvvsiWie/lY6gKh9pHWgrvmDVYzqkYn97KKeYM93u8fovx1GYTWPIL3pg+oi2hRodV1FcoWQovUow/lpkmDRd2dv4g5G2+9vr2TY/XuzY2dW+NtHUW23QeLK3KCuqhYk8WcGWFV/A2a/nlE= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the list of checkpoints for the given Studio session ID, sorted by cre id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-data-studio-templates.ParamsDetails.json b/platform-api-docs/docs/list-data-studio-templates.ParamsDetails.json new file mode 100644 index 000000000..ab8942bee --- /dev/null +++ b/platform-api-docs/docs/list-data-studio-templates.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, templates are listed in the user context.","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `100`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}}]} diff --git a/platform-api-docs/docs/list-data-studio-templates.RequestSchema.json b/platform-api-docs/docs/list-data-studio-templates.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-data-studio-templates.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-data-studio-templates.StatusCodes.json b/platform-api-docs/docs/list-data-studio-templates.StatusCodes.json new file mode 100644 index 000000000..6e1f1e6d9 --- /dev/null +++ b/platform-api-docs/docs/list-data-studio-templates.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Ok - paginated list of available Studio templates.","content":{"application/json":{"schema":{"required":["templates","totalSize"],"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"description":"Array of available Studio container image templates."},"totalSize":{"type":"integer","format":"int64","description":"Total number of available templates."}},"title":"DataStudioTemplatesListResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/list-data-studio-templates.api.mdx b/platform-api-docs/docs/list-data-studio-templates.api.mdx index 474bef3fc..9d39125a3 100644 --- a/platform-api-docs/docs/list-data-studio-templates.api.mdx +++ b/platform-api-docs/docs/list-data-studio-templates.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves a list of available Studio container image templates. Ap sidebar_label: "List Studio container templates" hide_title: true hide_table_of_contents: true -api: eJzNVm1v2zYQ/isEv2QDHNltswEzUGzu2xCga4s4bT8MAUJLZ5uJRDLkybFn+L/vjrIsOXadxkOBfZJI3stz77eUqCZB9v+WActM2yCvOjKDkHrtUFsj+/IC0GuYQRBK5DqgsGOhZkrnapSDGEY2kVqDShvwQhdqAgKhcLlCCIkYOAcmE9e/31t/G5xK4Tx7eS3QVtI2lEIb0rAhiiJhjonsSOvAK4ZznhGg98T2RqGqVF/W/ETnlFcFIHi2aCkNHYi+pZdoNNt0V4JfyIeWft3oNmUBXqdCZ2BQjzX4RHydghG20IiQdVqwlYdoCWRsAU5BlIH80IIf0ikUSvaXEheOEWl6moCnp7H1hcLq6tczuVp1NrALNT8M9y8110VZMNgRKaSweAhljoF96wFLbxLxBsaK7vri+lmvd/0ENC+eb6Gx43EAPAzowz4g4VY7QYKFUxNtYhTbqJ6OiRKUxDtrAsWcOJ73evzZhvLxVpzWGikw38zbJk9JVQyZQZamnMt1GtF2bwKLXLZAergrtYeM6wZb+YcWVT7U/wBX0doSO7qBlB3nPKcx6gp1w9YYrbxX7FVNj+37b4jw4GzQaCkSDW2gYjWTndC8flCfDa/4fPE+xoczt0aVyBXBSCu7D0tmdgpzm1swZ6UoCgqosAz7RAHlLjvRQ2qLgtoEZFGBowsOHJPMyWRNb+RaOpYmlM5Zz4/k5PkpizidKc95Gv6TLNSYM7qmt3yhTkJWDiv8Kw6wzR93ySVRCcYj2K1EKihwM+olmRgtyFM6NK76CZJJ0hEnN6VbUOM6oV9ftWL+nYXUZnDyc8K1uAdg3fwY2zaGAefSE1t1ZWGdwt/RrnYNJ+ZWP2p0t5UctCRwd79Y1zfRMvXZvgp/pbILKkMIeGzlUr4EcsDjtVoT7gS+bcpb763fAf5iT2uqh5kwFoXKc3sPWfT9We9sl/yDxXe2NDRy7nkAcZ0NPp0LyqFMB/ZttqnezaA7upn9aJdwM4C09BoXcUK/ApqeflDilI5X3NppfE8tT/lJnDZO8ZPsrreTbrvb0pSd1aO+9FSXcoroQr/bVU4naW7LLAlwR95OtN3J1WF8EZ9IGme1eM307FrJMGqUQ3ZTZXIb68Zq1ljPLz6PIhHdVD/v6nq5ucfoGm3GNrKvXbRGwWofA8jm6pQWjoo4lnEa47ttfNtkCrHOY7mO7R/NAwGZVa2N3p4lv/2S9PiORgIWKqbHeupzMe72jXYQtjAvm6z7P6yN6xjxsUvEtLmQkdFZy3ViNWtvpzWRKf5TcgU/L5cjFeCzz1crvq72Hk64uvhkf6zyAAcc8aO2yr3W3cJiZ+OdqbxkSsnr3PfjPnK9PACr2miPhHP8cnkA0WarbUBd8cFrRhV7EuUCqIxqmqNecQ3SFFyba6fBbnWyP99eEq3abhwPGkWUXq+BZtGSTRkYKS7tLRjKwho68pkUUVP9F9I0zAE= +api: eJzNVttu20YQ/ZXFvLgFaEp2jD4IKFrnVhhI08B2modAgFfkSFqb3F3PDmWpAv+9mKUoUZai2C4C9EkiOZdz5r4E1pMAg68QuMqNCzBMIMeQkfFsnIUBXCKTwRkGpVVhAis3VnqmTaFHBaqrqKYyZ1kbi6RMqSeoGEtfaMaQqnPv0ebq5rcHR3fB6wwv8l9vFLvG2lpSGau0WgtFkzjnFBJwHkkLnIscBvDBBH6rWTeur1t9SMBr0iUykjBagtUlwgA6fiEBI5zuK6QFPGb6Ze3bViWSyZTJ0bIZG6RUfZmiVa40zJgnHdiaMDLBXBjwFFUVkLrwQzbFUsNgCbzwgshYxgkSJDB2VGpuXv1yBnWdrGGXen4Y7p96bsqqFLAjJEkLYagKDhJbQq7IpuotjnVV8EDdnPT7N89A8+p0C40bjwPyYUAf9wEJd8arsSPl9cTYmMUuqudjGiZAGLyzAYNonPb78rMN5a87ddx6xPzbdbupU0ggpsyyWNPeFyaLaHu3QUwuOyAJ7ytDmEvfcKf+2LEursw/KF20YuJGt5hJ4DxJGbNpUG/UNqQ1kZaoGsay+/4bJgi9C4YdLTqygcnYyU5q3jzqz42u+nz5IeZHKrdFlUKdgMka3octizq7LW0lmo2jaCiw5irsM4W2KiWIhJkrS7Q55tGBJ8wkcSIy90imRMu6gAQqGyrvHcnHYQLzYzFxPNMkdRr+ky02XAi6zWz5GykYZ68a/LUk2BXfD8m1c4USPErCuvCoPLmZyTFXo4XiqQmbUP2E6SRN1NFt5ReMdJSoI2pGsfydhczlePRzKr24B2A7/ATbNoZzqaVnjuqGYVvCTxhXu8RZF515tPHddXKQSZDpfrnqb6hrkT7b1+GvdX6J9xUGfmnnlhiCnjyhV1vBncR3qbwjcrQD/NWe0dQuM2UdK10U7gHzGPuz/tmu+EfH711l80Q9yAKSPjv/dKFMULkJEtt83b3rRffiYfajQyLDALOKDC/ihn6NmpDOK57C4OtQRnuJPHWy5Sdx23gtn6C3uk563WkbkGbtqq+ogAFMmX0Y9HramzQrXJWnAe+RdGrcTq1exS/qU6FZqlq9EXkJLQiMFuWVhKmh3MW6Zi0e2/0lz6MoBMnqz/u2X24fOIbG2LGL6qsQrVCI2+8BFLomw7ASjm2cxfxuk+9SxlKbIrbr2P2++VAnMGtGGwzgJD3pn6Z9eeld4FLH+litfenG3cHRzcIW6OWm7P4Pd+MqSfLY84U2VkjGaC1XlbW5e5POSh4mMHWB5fNyOdIBP1NR1/K6OXyk4trug8FYFwEPBOJHnZV72d3hYufknemiEkmQe+7puF94Xx6A1Zy0L4Tz8uvyAKL1WbsBNZQHMoIqDqUEpqhzpJj1Rus8y9B3tXYm7NYo++PdNSSgtyfHo0kRrbd3oF10bC+XjcS1u0Nb19BCZ3mGeljX9b/cVcwm sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves a list of available Studio container image templates. Append `?workspa id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-data-studios.ParamsDetails.json b/platform-api-docs/docs/list-data-studios.ParamsDetails.json new file mode 100644 index 000000000..8cb991671 --- /dev/null +++ b/platform-api-docs/docs/list-data-studios.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, Studios are listed in the user context.","schema":{"type":"integer","format":"int64"}},{"name":"search","in":"query","description":"Free-text search filter to match against Studio `name` and `templateUrl`. Supports keyword filters for `userId` (Studio creator) and `status` (current Studio status).","schema":{"type":"string"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `100`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"attributes","in":"query","description":"Optional attribute values to be included in the response. Supports `labels`. Returns an empty value (`labels: null`) if omitted.","schema":{"type":"array","items":{"type":"string","enum":["labels"],"x-enum-varnames":["labels"],"title":"DataStudioQueryAttribute"}}}]} diff --git a/platform-api-docs/docs/list-data-studios.RequestSchema.json b/platform-api-docs/docs/list-data-studios.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-data-studios.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-data-studios.StatusCodes.json b/platform-api-docs/docs/list-data-studios.StatusCodes.json new file mode 100644 index 000000000..6169967e3 --- /dev/null +++ b/platform-api-docs/docs/list-data-studios.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["studios","totalSize"],"type":"object","properties":{"studios":{"type":"array","items":{"type":"object","properties":{"sessionId":{"type":"string","description":"Studio session string identifier."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier. Null if the Studio belongs to the user context."},"parentCheckpoint":{"description":"Information about the parent checkpoint if this Studio was created from an existing checkpoint.","type":"object","properties":{"checkpointId":{"type":"integer","format":"int64"},"checkpointName":{"type":"string"},"sessionId":{"type":"string"},"studioName":{"type":"string"}},"title":"DataStudioDto.ParentCheckpoint"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo","description":"Studio creator user information."},"name":{"type":"string","description":"Studio name."},"description":{"type":"string","description":"Studio description."},"studioUrl":{"type":"string","description":"URL to access the running Studio session."},"computeEnv":{"description":"Compute environment information where the Studio runs.","type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"},{"properties":{"credentialsId":{"type":"string"},"workDir":{"type":"string"}}}],"title":"DataStudioComputeEnvDto"},"template":{"description":"Container image template information for the Studio environment.","type":"object","properties":{"repository":{"type":"string","description":"Container image repository URL for the template."},"icon":{"type":"string","description":"URL to the template icon image."},"status":{"type":"string","enum":["recommended","deprecated","experimental","unsupported"],"x-enum-varnames":["recommended","deprecated","experimental","unsupported"],"title":"DataStudioVersionStatus"},"tool":{"type":"string","description":"Tool name or type provided by this template (e.g., 'jupyter', 'rstudio', 'vscode')."}},"title":"DataStudioTemplate"},"configuration":{"description":"Studio resource allocation and environment configuration.","type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the Studio was last updated."},"lastStarted":{"type":"string","format":"date-time","description":"Timestamp when the Studio session was last started."},"effectiveLifespanHours":{"type":"integer","format":"int32","description":"Total accumulated lifespan hours for the Studio session, including any extensions."},"activeConnections":{"type":"array","items":{"required":["lastActive"],"type":"object","allOf":[{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},{"properties":{"lastActive":{"type":"string","format":"date-time"}}}],"title":"ActiveConnection"},"description":"Array of currently active user connections to the Studio session."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"},"waveBuildUrl":{"type":"string"},"baseImage":{"type":"string"},"customImage":{"type":"boolean"},"isPrivate":{"type":"boolean","description":"If true, only the Studio creator can connect to the session."},"mountedDataLinks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}},"progress":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","in-progress","succeeded","errored"],"title":"DataStudioProgressStep.Status"},"message":{"type":"string","description":"Human-readable message describing the current progress step."},"warnings":{"type":"array","items":{"type":"string"}}},"title":"DataStudioProgressStep"},"description":"Studio session startup progress information, including build status and checkpoint mounting progress."},"labels":{"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"},"description":"Array of resource labels applied to the Studio."}},"title":"DataStudioDto"},"description":"Array of Studio summary objects."},"totalSize":{"type":"integer","format":"int64","description":"Total number of Studios matching the query criteria."}},"title":"DataStudioListResponse"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the workspace is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/list-data-studios.api.mdx b/platform-api-docs/docs/list-data-studios.api.mdx index da3aa99af..32e31f81d 100644 --- a/platform-api-docs/docs/list-data-studios.api.mdx +++ b/platform-api-docs/docs/list-data-studios.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves a list of Studios in the user context. Append `?workspac sidebar_label: "List Studios" hide_title: true hide_table_of_contents: true -api: eJztGmlvG7n1rxDzZRNAUpyjRWugaBXb2RXqOK6PpMAiiKgZSmI8V0iOHK3h/973Hocz1ByS7CTttugXe8TrHXw3311g+EIHh78G2hSRzHTwcRBEQodK5kZmaXAYXAijpFgJzTiLpTYsm7NLu5jJlJmlYIUWioVZasRXM2LjPBdpxKZ/vc3Ujc55KCbRX6bMZHa7t5ezakm9/bLI80wZzXK+kClHLBiH8+YyNkLJdAHg8C8CnmrBVbicwlrFEwHzI3YF43a4HmU8DEUOZ86VEEOEw74UcBgQlXATLkXE+ILLtEKPpbCRwBqR5DE3gl1fnA4Y1+xWxDH+vxFrwN7hBUdnik2RE5Noyp6Ux4RKcJOpp3TUVBtuCg2zYaGUSCtgdvzpKBgEWS4U0TyJgPenwLBjbnjJM5ivSMJLuwsQTVjncRrWSLw2pG8dNC/zQ8XvtEiAASGTESAi5xJZ92EpUpYl0hgRDaqL4krQzQGTuu4bYGjgYMKDw7vArHPER8LUQiiYAq4Ah+3QH18F9/eDCml7SdvxfVPdV3mlltsoTHRxzWub4tlTy213c9cqnnpi9WPurcUCbVBWNwhO+Nft1L7lX2VSJHg3MyASFE0JXcSANNCrhClUOmLHYs5h7JBNnx8cTB/A/pcvNrDJ5nMtzHaEzroQ0TcyJ67VCupj9S04cQNcmxVG6O14vaMPDnroNrAVjwtB+M0EyGkYF1EtsIB9nqVaeGIwjflMxBok44IYC3KeMpAYs7ZHsSflikO4jjiePmVy7nSjk0CuFEdMJcidbgvCIBBwrWhp7bFoaL8OcWy44grp15uTRpoY99f6/w/kxdhRDIy7h2WONAL54uAA/zWY9XcATtqaGpzleR7LkO7t2WeNS+48apT4UkglIt8nADKZ4fGl/E0QZpawbPZZhChAuUKrZaTFwW3azZm+A4TWpQFsM3GTNKeHdgezq3yTFtwPNozjHibqYSbzDGQDJQOlrMQGLjBLFySKbWN5TyYc9h8tRXiTZ9LeySbISWpxItc3ywpDB9l9LKw2WrhSO8C34JXIcIHgz1WWkER/BcuNTKm3ofRuv4F67X4sA6LqLWekyi07ONh2rzhLNPRsvu9Sh2OTjc6bvISVyPCmJPMVbEPMQcpljLKIjhJXEsSdQi335UN1ZBeNFnjXTInfVsqv0UeBZPRpQemzrMDJWoRI6NJOnHpOwsW0a2N2z83e4Ki+WHDCu0+AEAu1BoM1ra3hLtIUpXdT0encMEtyMIMn6aqtQEd2jol0JVWWJqg3HkfY7VJAUOPpLMDRXXrB4/jdnCKtB8hHfa3dXEcbAIEJotM5qcSik+G+MBxV1B/PQBECdKINJQbRRzvFY92jcmgYj2Wn1N13OiAPKIEMXIjVdQOpgcgMJTHhC1GH0f41YBDhXYJ3W7ttlBJ5piXI+3q3XDWRqfdiVF+h4XAk8ZLhPjJfSqy/m+FOC6iUfwwStwUESoAsA9UQsBCAHAbQiOOSr0CyRI5wtFogpTZ+gcnu+OHRZ7Vv+z1Ex0DlpcUfbzvL9lDiK1hl0ydkKyxlcHEridHYbG39VcWqJ2K0GA3YT5+LfA3B+E/wqay9wM+VDrNI/ATxdbcDuHLSR9YgnctFYXOntjg6NRc6KxS4ctDrLKxzS99ObJy0Ww4XeYH/Epli6B4cHgy2uwmIePuj7J/Pr7XDDfhVSlaX8fueUI/2hZqIpNS3bwE8TrIipTKCPQ+D9Lfy9X4Y4FaUgP0D76YbC8a4HsFHcM4wlukNmxxrRkfXKUMHcE9KuqJYHkXSpiXnGxLS9goQM/IZCrNRhehFzxdKUHGJWzB7Hdr8JOcSsldI4bZgDLIc8ZNNtCELPRXpwiyDwxcHr/402G07Iw7Awhu0nDoXIUS+YW2/w0IbCDXLBVjWAYMXxy1Gbhh3QC2Wc8hcePoLKKT+frK8xOM62MFuJQTq4OYhPIfDwAIUgDaQEQKya8gcsjwH8kdsXKZ/cBakskBEhNQCYUUaS0j/gDCHep9dOtqwRSh/cMCRDcy77GdFHK4bGjDRbaMKg8DXJMfQZYOvXtBv+cq1uc6jHwYLz2eFBVABBB+hfgTA6vIcYG0BWXWcz0Hx5EqcNkXpoeJzhdkthp1FUsTcv+JSnhqBSonWoKwzYIDK0zXkWpBi44Qm/DghB8KQIpowus1m+ckKUjqmzV2JSR2S/s8mOO1g1mPJfjK2GcKOG1exxSmUJT6wCfb+qvzd3eIW72RDPSJhd5WjCgsb9rZRYqxKG7h8xM4z+I2OwNa7DrE4CaZLRNMB1SkVJvv4XWZOdtgaN/yewwXZxbNCxlE5St9v7JQX8rQiVQcAhsrzsRJWHu8+bbCpVKboy8FxnxZMT/j6fQG0TXMdzAJADQ6rU1hrG7qvtFnMLgTX3VmDY+DRxcnx5Ory08X12ad311cwczp5c3J5Pj77dPLP8wnMwtDl+burTxcnR6fjt+OrybuzPlIqgN1u6LKWRkz2+Eq8RvZ0ZuKwYMa1mCR9LLFuvjk/g1hfcFInqc+VXG2yzE03lW0yZxT5sCyN174yuRJGCJa3VDmnbq0oUERI6imEb99Qa+zK25vYHldhYru+yH4WKT7YYHID/IuAIpfuqAFlPwNm0/kBJRpVApJzs3xAYeaM8ilbZqzD1jJ9mhXhDYSBeNLTh5dtjutfLQhlfRPdXzWmKXQaRhKys5VQrtboveTVhYeRLWdYmi/EfDc2Fz6DKr9bAfddLk5cX0wY1a6rXHKqXx4+e5ash5YraN0WujnCf4MR8PcoR6PQVQemlnsWwaZdrqUA50fsqPITunpSKAFss6B2SY/1qyd9bUYRv8Lj7kl6SbY6/EacFVEle23O+U8f/FYTX7JsEQvLj0LVH5+ALsWrn8MQjyZHIr6AsJeFt+mgfBx7uZVggAW/LCiMXvBE998Ccr8sHDTyPhj8/bKLJeeOFVsqZq1khphkV/eq07TQQ7CrZvgcaRYFGozhLUSoz0FA2FsIE2aC3oSIyTpLqgqHsgLvKcC+IR9Fa2QKvDt+WNDWR3KNTM/7yMMtUFPDt0ilBz3ckND/sMzctyc9XLfFhx5FZskN+aqqYi21r3En9JxIT6XFLJahZ0Qt32h0TJslFQR2us4PSwE30NBtBmDtWRS2uuMg5zVLfD1q3tdSRvB7D2jvJRwkY2nWZQDK5jGHJBkc+BQ9OCjIBhL2YOsQIvsibJs+VlLc6h3lUPD90TsICFxZpFV7713p5Ob9+HSCAdTkzH51SMDIRYCtPhc70eECjzgWDdiUzpxiVXNaAsC2AkERSjViU1iudRZKCgt8ecFOikjEwmWwvTFoE7cTDHZZuZwESqaQAMjIl6jaV7emOuWdavhWexfgo7/lxXZniRs7guyITIcVQJCGAqRVRBsRfWe0e17uuTQiH+0RxTc5+EuR8HSIgkNlNMdKu2jmwgnX3+EwBKkHcDZ8VpiN7MOk+hFlFyFtM9PO+pQp8hof7/XED4Uo73Eqil7ZeySmYBkXuUPKqg31GbSpaRYnHxNIb6sf9D6JUULb8x5mY8K+xKPsPemdXgNMGfZNTwBZlWdxo2LmrXl4+c6/+lPktHuk6/MqVV5g74VRj0azEt5Xb9x+tBOpIkm4ghG6PysEdVfHI/oibNGsblVy7WLUl+UUitp3wAZKbN3jfQRgm9tF2ceCegOLXnV1srzm0QUETRCKBY/saHH2Ymdo1V8e8Cggs9xC/GVHC47r6mNpZuih47Z0Aa8OXrWXn2XmDWhtNKgLonV6BW4WD5njAnRG1ZLx+QQnITFD/Y2qFKDaOvq9co2aQ8D2QpxB/v61AE+pxgW+Ufz6EV11AlFPhh2RC2pZw+QQfjyrG5S0UCvXFFlghSNYGpNj4sdzOaIocWRjxJHs6KCgGXZevsozmycAQylOcLhdUqJJhPoYVrQixKDsDCMTQouwLEUfb5w+fb41xBDpCoUlY0osEOwuBJFcCXFeuZhS2JBudZN4n+SyOEtg/1ZPoOm1L70w93z05z+MDig2zbQBl4lHls15p173bhPBu1qw/t8w/G9tGC5lD1F8BnAleazC1vismmz0di/hWnHo7g7rVdcqvr/HYdtmicrjzEdwOIeQtfk66d/zj+kl7qQHWBc0u5zLeCGg14L9sf6v6Sjewoiqc/qRPHhkn/EWjGxr8yPReXyX8RaMqvbmRyL1O2gx3kLdRqN0TeFH/GE7Bchzgr5DxoOFGdBsu3NMhs3b1QoDNvztzyf4SME3HV3Dsfk5Ok/X3tlgZWjFVXYjUrA0Dn2DvwEQuP5/ASlrsZ8= +api: eJztGmtv27r1rxD80haQnfSBYTAwbG6S9hpL08xJegdcFDUtHdtsKFIlKSe+gf/7cEhRkiX5kbTd7oZ9SWSJ5Hk/eR6oZXNDB79RY/OEK0M/RzQBE2ueWa4kHdAxWM1hCYYwIrixRM3IlV9MuCR2ASQ3oEmspIV72yfDLAOZkMlf75S+NRmLYZT8ZUKs8ttrexkpl1Tbr/IsU9oakrE5lwyxIEwmZMaFBc3lnOQG/yLgiQGm48WEZEyzFCzoPrleAPGvq7eExTFk1pCZBughHPItB83BkJTZeAEJYXPGZYkekSwFB9ZCmglmgdyMzyPCDLkDIfD/LazulA54GTJTmkyQE6NkQp4Xx8QamFX6hTtqYiyzuZmQ53GuNcgSmH//ok8jqjLQjuZRQgf0nBt7yiwreEYjWpKEQnugiCYd0BqnaUQ5ig3pW9GmMH8t+S3zFDSPCU9AWj7jyLpfFyCJSrm1kESloJgGJzlIOuVNI2riBaSMDh6oXWWID5cW5qBpRGdKp8z6V396Q9frqETaC2k3vu9KeRUi9dxGZXKCa4ptgmdPPLeD5G60mNTU6ufIrcUCY1FXNwhO2f1uaj+we57mKcpmChoNTYPJhTVIrwaba9knpzBjubADMnl5fDx5BPtfv9rARs1mBuxuhC66EDG3PHNcqwy0jtX34MSs1XyaWzC78froHpgg5QayZCIHh98UCJexyJNKYTWYTEkDNTWYCDYFYSZ9MnaMNYRJAmlmV/4o8rxYMSAyF2LygvBZsI1OApnWDDHlFlLTVoSIgsxT9LT+WHS09z1811syjfSbzY+WW4H7K/v/B/JiGCim6/X6c0QDaQ7kq+Nj/Ndg1t9pRJ21SotfWZYJHju5HX01uOShRo2GbznXkNRjQkStskxc8d/BYeYJU9OvEKMCZRq9luUeh7BpP2e2HQDGFA6wzcRN0oId+h3Er6q7NLqONpzjAS7qcS7zIhcCNQO1rMBmCkLJuVPFtrNcOxcO0p4sIL7NFPcy2QQ5kh4nF/qmKrfuIL+PxOVGD5ebAPiOGe+4ICEzrVKn0ffcWGRKtQ21d7cEqrWHsWwd1bZcOFNu+cFol1zxq6Nhy+Z1lzmcWtW/bPJyHVFkeFOT2ZJZhphDyrhAXcRAiSsdxL1KzQ/lQ3lkF40eeNeXAr+dlN9gjJIztc0KipjlFY5XKuSUTnbitOUkXOx2bXw9cHPtZb8S7I3uILx5ws34HK0GkzVjvOPOpUTt3TR0d26s0iy3cCaXbQM68d8IyCXXSqZoNzWOkLsFaKjbrM6l6bILJsTHmcu0HqEflVi7uY4+QDCL6HR+1DDvZHhdGU5K6k+np1ZRDKINI9bg/BQTZovJoWM85Z1at+4MQDWgDiQNKVaXBKRlXKImpmwOVRpdFwMmETUh1KS130dpyJThVunVfr1qIlPtxay+RCPg6NSLx4fofKGx9d0Ed3pAhf5jkrgrIdAQqzQFmUDiAGQaYnTiuOQ+A82RIwy9Vi6Nz18g2ZI/PPmstrQ/gUZju/L4o7SVOsCIr5USvnxCtq4yIJlWS47Z2HTl41XJqufQn/cj8uxrnq0s6GcReaa9v8DHpYlVAs9e9LcEgOugfc4byBmf5752aqtjMHMwKtcxECaEiqvasu4nNk7ar4fzLMd/KZeYutPBcbQ7TLx+tSPLfn95YwJukATN6nJ+PxLqyaFQU0gLe/sewMNU5dK1Efx5mKR/4G8PwwC3ogYcnng3wxgd4noEnzDLeoLLWzI6NcQdXZUMHcBrWtKVxbIk4b4sudzQkHZUyIVgU1Rmq3PYil5dKZdMc9yC1WvP1ycZ49oQA3YHxrGSCTvbRDtl9+cg53ZBB6+O3/w52u87E0YyFt+i5zQZxHxWVA/Occa5sSoNC7CtYywTosXIDee+jqjgMzAZk7+oXJsfp8sLPK6DHeSOC4FhnkxhpjQQlluFYShmQqyIsSrLuJz3ybAo/9QMS1nCZYLUgiG5FDzlqCEB9W1+6WTDF6H+MQsnPjHv8p8lcbiuZ3kKbafKUzCWpRmmLht8rSX9nq/M2Jss+Wmw8HySewAlwCvL9M8AWAovADYekDfH2Qxiy5dw3lSlx6rPNVa3mHbmaS5YXcSFPjUSlQKtqOgzYILK5IrAvQWJH4zDjznkTpSUiKaSO0vierGClA7d5q7CpEpJ/2cLnHYyW2PJYTq2mcIOG6LYERSKFp9YES+/sn4PUtwRnXyq50jY3+Uo08KGv220GMvWBi7vk0tlDMdA4PtdA2xOqiyDZBK5PqXGYh+fi8rJv/bODZ9njAu/eJpzkRRv3fM7/6mW8rQy1QCARrQ4HzthxfHh0SebWivtngKc8OjBbElffyyAtmuuktkUjGHzbjWufOih2uYxGwMz3VVDYODJ+Ox0dH31ZXxz8eXjzTWN6Pno3dnV5fDiy9k/L0fjs1Ma0avLj9dfxmcn58MPw+vRx4ttpJQAu8PQVaWNWOyxJbxF9nRW4uuITpmBUbqNJT7MN79PlRLAnDlxc6n5cpNl4XPT2EYz4jIfoqRY1Y0ptDBiJoPJBXNrZYGQIKnnXN5+R6+xq25vYntapont/iJ5DxIvbLC4YQYSomQod3Tkqp+I+HI+coVGWYBkzC4e0Zi5cPWUbzNWaWtRPk3z+Basq7lePL5tc1r9akEo+psY/sp3xqVOvYSbWC1Bh15j7Savajz0fTvD0zyG2X5sxnUGlXG3BF4PufjhZjwirndd1pIT83pwdJSuep4r6N3mpvmG/T44OmJxjHrUj0N3YOK55xFs+uVKC/B7n5yUccKUVwoFgF0e1C/Z4v2qj3VrRhW/xuPWTnudbnXEDaHypNS9NufqVx/szji+KDUX4PmR6+rhC0irWfmzF+PRLpDAN9CsaLxNouJy7PVOgtkd3h94UJi94InhvwcUfnk46OTrYPD36y6WXAZW7OiYtYoZxyS/eqs5TXLTA2Zs7yXSDDk6jN4dGPty8qJPPrAV3jDJYBdGpWWHQ3uFrxnAoSmfy9acK6jJ+HFJ2zaSK2S23I883gM1LXyHVtagxxsa+h/WmXX7Yw3XXflhjSK7YNbFqrJjzU3d4s7cdaK7Ks2ngsc1J+r55t4O3WbuGgJ7Q+evC7ALaNg24aaA4NLWcBy543aBt0dNeS14koA8ANonbviUC25XRQJKZoLN+2Q0IxOM4JNoEwl/sA8Iib8R9kMfSw53Zk87VANLPkqxCm2RVu9968qgN5+G5yNMoEYX/qlDA/ohA2zNufgPHSHwhGHTgEzcmRPsak4KADhWAC5DKd/4EpYZo2Lu0oK6vuAkRQICQgW7NQdt4naGyS4pljuF4nLJBE/qGlXF6tanTn13PXxvvXMN5ntubPe2uHEiyL/hslcCjKjJ4xgg2cjoO7Pdy2LPlYWsf0AW3+TgL3nKZA8Vx7XRAiv9omlIJ8J8R8CQGATn02eN1cghTKouUfYR0nYz7apP2zyr8KndntRTIVf3BBPFqFy7JHbJMi4KhxRdGzdn0Kam2Zx8SiK9q3+w9UrMFbRb7sN8Trit8ChmT7Z+XkmW8njb55G0oDMlGh2z2prHt+/qoj9HTodLum1RpawLvFyIm9FodsK39Rt3Hx1UKk9TplfEy88rQTXV8YS5CN80q0aVwriYm8sKBuXGd0isOY7usW0E4JjbuJhjQbtZR/RN1yTLW5aM4VsOxj51oiX4i72p1fb2QI0C55ZbiL/uGMEJU31EKusuOu6KEPDm+E17+YWy71Quk6hqiFblFTfukBkuwGBULhlejvBjwg3ab1KWAOXW/h+Va244JM41tysX798C06CHOd5R/PYZQ3UKdqFwInLuRtawOKQDelQNKBnQyzAUmWOHgy6szbDwYxnvuyyx73PEPu+YoHBfyGVxK098nTC8HLk8IeB25QpNR2gdw5JWhBgmw5wLcYuwLeUe3gV7+npnHUN4aBQWjCmwQLD7EERyeQymWOxK2NhJdZP4OslFc9aB/Vv1AV2vv+mlA/qy//L4Vf/YJafK2JQ5rSim885r47tNDB8qzfr/xPC/dWK4UD5E8SgTjLuQlfsmn7eTjeHuhTIWXz08YMPqRov1Gl/7OUu0nuA/6GDGhGleT9bl/HOGiTvpuYVVa8y5SBiouy44HOv/mpHiHYwoR6efyIMnDhrvwMjPNj8RnaePGe/AqJxvfiJSf4AZ4x3UbUxKVxR+xh9+VMCFzogugLnOzG8Pxc6hc2y1Xa08YCPgvj/DWwq2Gekaka1epDO5qp398OBXXKtbkOs1Dehb/E3Xn9fr9b8AhrOxxA== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves a list of Studios in the user context. Append `?workspaceId=` to list id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-dataset-versions-v-2.ParamsDetails.json b/platform-api-docs/docs/list-dataset-versions-v-2.ParamsDetails.json new file mode 100644 index 000000000..1132c3126 --- /dev/null +++ b/platform-api-docs/docs/list-dataset-versions-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier.","required":true,"schema":{"type":"string"}},{"name":"mimeType","in":"query","description":"Optional MIME type filter (e.g., `text/csv`, `text/tab-separated-values`).","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-dataset-versions-v-2.RequestSchema.json b/platform-api-docs/docs/list-dataset-versions-v-2.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-dataset-versions-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-dataset-versions-v-2.StatusCodes.json b/platform-api-docs/docs/list-dataset-versions-v-2.StatusCodes.json new file mode 100644 index 000000000..34521a21b --- /dev/null +++ b/platform-api-docs/docs/list-dataset-versions-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetName":{"type":"string"},"datasetDescription":{"type":"string"},"hasHeader":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"createdBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"lastUpdated":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"url":{"type":"string"}},"title":"DatasetVersionDto"}}},"title":"ListDatasetVersionsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx b/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx index 68bc4038b..a6b260fd5 100644 --- a/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx +++ b/platform-api-docs/docs/list-dataset-versions-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Lists all versions of the dataset identified by the given `dataset sidebar_label: "List all dataset versions" hide_title: true hide_table_of_contents: true -api: eJzNVktvGzcQ/isETwkgr5w0LVCdasdOK7Rpg8ROD4YAUbsjiTZ3uSZn5QqC/ntnuA9R1kZWgB560ooz5HzfvDcS1cLL0Z3MFCoP6OVkIDPwqdMlalvIkfxDe/RCGSNW4DydeWHnApcgmjtCZ1CgnmvIxGwdJAu9gkJMG4VxNk3EB20QHCt8HH+8FrguQaAVDtBpWIHwJaT0Rirm2oCYW5cr7CwmciBtCU4xpnHWoLqqn//aKH19S1qlcioHssSsNrKgP6T9ZN2DL1UKdHcgNdN6rMCt5XOyf7eKoqhycASnI+cYhE+XkCs52kgmQBd0gbAAR6Iacn300zu53Q46850fWuOlwuWB7YaO8OSRYvHMsIPHSjsg6ugq6AFS39ozm+scblh6lPJf4UOZKC7zOlavIFkkAzFF+AeHqV9N229UszMP7GqE7GylTAV++rrXPx2sCXPwJcUJPMvfnp/zzzMsv9MbqSWfFshSVZZGpyHqw3vPKptDE3Z2Dyly7B3nCOraQJs7kaZyTrEDNELuX35hF7ZDPoNW+mfw9bflVzHBHrWl8r+ByiiFdtKZtQZUweKGxUkZR65zwCG5XLP+LmXupFoRGr5DrtOGXcC5WHlwAT8F57grdHYigu7JPq618T5Jg68vnSVqNHx0S0+Pi7llfaM83pYZkz28FOFijTOkOuBL3Fm+iS2HTKtQLX3SuIGc6AjXxzSis9+9rpB4xeKeBve5qR9WJM13fRV0qTLBgQeP31NKca7k4L1anJAUreJRmtfOWXeA/Iee2m/7uygs8ryxT4SH1T2kldO4Dh39EpQDd1FRAx3dTbitULtfWp4JCwgYubeO5LCdaMNNV8fbYdcU+FW3asdECJZcIpZ+NByqUiepsVWWeHgkUIm2B13zS5CIT0Yhx168Z31x8WksGVKL+As7uHZWjLvzF1tsu2Yo/KBEJ/XHhzar7p8weEJz+vP1xrkNCjb7EkCmq1PwjTJnhkpDZuyTjyk39RrM/rITxG1Jvkl+/jE557PSesxVSKxmAHEOh82h3RQi92f7fbHL1P/NvtGEKAy80ihdRFVd51i0NQ3kKB7yHU/KhSW5hXU3mxnJb53Zbvm4HsacfJn2ama49ubKeDjimpe2k17ID7A+2IDCyKZTydvC6fb/01XhCNhocdkhnfAfpxnqd7rt1eemu70WR3esXkTt6lCsYzQt0l3QtxMe5s0kJ3i1/CJNocTo5kEb3utgv17fkK7abxLPmkJ4vRcVZVjQuLEPUFCWtSCR/zPA7fZfJDcfwQ== +api: eJzNVktv20YQ/iuLOSUALTlu0ANPtWunFdq0QWKnB0OARuRIWpvk0rsjOQLB/17M8qGVxcgK0ENPonZmd75v3hUwLh3E95AioyN2MI0gJZdYXbI2BcTwp3bsFGaZ2pB12hROmYXiFan2jtIpFawXmlI133rJUm+oULNWYZLORuqDzpisKHycfLxRvC1JsVGW2GrakHIlJXqhE7XQGamFsTlyb3EEEZiSLAqmSdqium6e/9oqfb2ACEq0mBOTFVYVFJgTxPBs7KMrMaFJChFoofW0JruFl2T/6RRVsc7J6mRHzgoIl6woR4grEAIQgy6YlmQhggZyc/Tze6jrqDff+6EzXiKvDmy3dJRjq4vlC8OWntbaUgox2zUNAGlu7ZnNdU63Ij1K+W//gVkQl0UTqzc0Wo4iNWP6xuPEbWbdN+P8zJG4mik922C2Jjd7O+ifHtZUOLjSFI6cyC/Oz+XnBZY/IILEFEwFixTLMtOJj/r4wYlKdWjCzB8oYYm9lRxh3RjocifQRGtRHKCZcvf6C7uwHfKJOulf3tffl1+HBAfUVuh+J0zJBtK5MRlhIeKWxUkZF0FiSUJytRX9XcrcA26QUe5QjjoTF0gurh1Zj38aveIKnZ6IoH9yiGtjfEjS4htKZ2DNmRzdObKTYmFEP0PHd2UqZA8vBbhE44x1TnJJOst3seWUavTVMiQNG8iJjrBDTAM6+93rmg3UoXigwX1u60cU6wjeD1XQFaZKAk+Of6SUwlzJyTlcnpAUneJRmjfWGnuA/KeB2u/6uyoMy7wxz5T6pxwla6t56zv6FaEle7nmFcT3U2krOfHKyExYkscovTWGcTfRxlVfx/W4bwryqt10Y8IHC1bMpYvHYyz1KMnMOh05eiKLI20OuuYXL1GfMmSJvfpV9NXlpwkIpA7xF3Fw46wQd+8vsdh1TV/4Xgmi9uNDl1UPz+w9oSX95Xrr3BaFmH0NoNDVCblWWTIDE58Z++RDym29erO/7ARhW4J3o3fnF6NzOSyN4xx9ZrUTSJLYrw7dqhD4P91vjH2q/m8WjjZGfuKVGeoiKOsmyYK1KYI4nPI9z2kEK+NYdKtqjo7ubFbXctxMY8m+VDucZ1J8C8wcHXHNa+vJIORH2h6sQH5mQwwg68Lp9v/TXeEI2GBz2SGdyh+rBeoPuu3N57a9vVVHl6xBRN3uUGxDNB3SXdDrqUzzdpTfV638Mkmo5ODmQR/ea2G/3dxCBLjfJV50Bf/6IKqqajRuzSMVdd2DZPkvAOv6X4gdH+Y= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all versions of the dataset identified by the given `datasetId`. Filter by id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-dataset-versions.ParamsDetails.json b/platform-api-docs/docs/list-dataset-versions.ParamsDetails.json new file mode 100644 index 000000000..2b2d15221 --- /dev/null +++ b/platform-api-docs/docs/list-dataset-versions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier","required":true,"schema":{"type":"string"}},{"name":"mimeType","in":"query","description":"MIME type filter","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-dataset-versions.RequestSchema.json b/platform-api-docs/docs/list-dataset-versions.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-dataset-versions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-dataset-versions.StatusCodes.json b/platform-api-docs/docs/list-dataset-versions.StatusCodes.json new file mode 100644 index 000000000..34521a21b --- /dev/null +++ b/platform-api-docs/docs/list-dataset-versions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetName":{"type":"string"},"datasetDescription":{"type":"string"},"hasHeader":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"createdBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"lastUpdated":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"url":{"type":"string"}},"title":"DatasetVersionDto"}}},"title":"ListDatasetVersionsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-dataset-versions.api.mdx b/platform-api-docs/docs/list-dataset-versions.api.mdx index 9488c8a61..2ef2a2061 100644 --- a/platform-api-docs/docs/list-dataset-versions.api.mdx +++ b/platform-api-docs/docs/list-dataset-versions.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [List all dataset versions](htt sidebar_label: "(Deprecated) List all dataset versions" hide_title: true hide_table_of_contents: true -api: eJzdVk1z4zYM/SscnpKMbaXbbWfqU5MmbT3tbnc2SXvwemYZCbaZSCJDUk49Gv33AhT14Vhxkj32ZJkAiIcHEEDJnVhZPp3zRDhhwVm+GPEEbGykdlLlfMpPTq7X0jLIE61k7hh+J6ANxMJBMmFXAGz+p7SOiTRl4Rq2AWPR3C6O1s5pO42iRMV2YuEBjJhIFelUuKUy2VhoGaVoPg6m48Z0vBm/O2aow9waWFwYA+i9gTE5OfmSf8nJsfWeGzOmlt5gJTeQs6/h1lnydcJHXGl0T3HNEoyMjC9q+d/BGnW0MCIDhwfIS8lz/IO6j8rcWy1iQMsRl0SMFm7Nn7L1T6PH8iIDI2MmE8QtlxIMKht4KKQB9O5MASNu4zVkgk9L7raa/GBosPKqxI5w9dGP73lVjVowbVAHoYTQmHVG5qs34qiNdrxmMoNrkganDwWY7Z7XD7MPl4wuYUuZOu/s+csXhMRqJB4syd+dntLP7o1//YF3xAqJyR1JhdapjH0aoztLKuW+C3V7B7GjdBpKupO1g6ZKeprCGEFhSAeZffmGjvv9eEaN9KNn7Hn5RT/AAbW1sL+DSJC9TnqrVAoiJ3GI4lVlg9QZoKd6viX9LvFzLjaIhmyQOpkSBVRQhQXj8WNyDlMhk1ciaK8cirV2PiQJ+IaKkjvpUjq6watn+VKRfiqsu9EJBbtv1MNFGmOH1UxGWKXwLLYMEil8zQ9J+z3hlUSYoUh74ey2owuHcfXFAx3rc3g/pIia74de0LlIGCUerHvLU+rXSgbWitUriqJRPBjmpTHK7CH/fuDtNw2b5cpPGPWIeEi9m0FtDwMcEtJtfds+B2HAnBXYF6fzBTUa7OlrRW1/BR41tcwpj9ok2qjsJbSKmokYle2Tr6JNNyew8DbNkPB55c2ow5E2iVNVJN2822uTV17CPoUxyH4hfXb2acYJaxPKFeWi5rUfUEsteWwarO8RXglP6o9fmwK8e3SeNEkvhcxDHgIKcvsSQApXIktBmYpIxL6IdoPvhxyetnf7cyfodzD+3eSnHyandKaVdZnwNRgmztFFm+Rj9uyO8RR62VX4/2p5CTl38K8jBDLvdZS6muddSyJWprtLS7vioaS/QbQ8YuGtMQd0T1neovzGpFVFx/Wop0pPpBW3KT26pUgtHKB+YBEYjOAetrvLxUakBan5l7ARRpLDNzo/+hx61zF7YSMbxNSsBvm2j6fB2qeV9qNvgnVoO/sGTF1CqwUtEGF7QNJq+Vkcg3Y9y73Wv9Mjf7u8Rl2x222edBd/+yAqrB6vca3uIccKakA6+k8Aq+o/RRNS6g== +api: eJzdVktT40YQ/itTfQJKtlh2KwedAoEkrn1ka4Hk4HXVDlLbHpBmxEzLxKXSf0/1eCTLWLz2mBNG/fr6MV93DSQXDpIpZJKkQ3IwiyBDl1pVkjIaEjg6uloqJ1BnpVGahHIiw9JiKgmzsbhEFNNPypGQeS6CG7FC65TRbnawJCpdEseZSd3Y4T1aOVYmLnNJc2OLkSxVnCtHo2A6ak1Hq9HJoZgbK2iJIq2sRU0djPHR0Xf9XXNg5yO3ZsLMvcFCrVCLH8HrJPsxhghMiVZyXpMMEmDj843872ANEZTSygIJLdelBi0LhAQejL1zpUxxkkEEigtTSlrC42r90+oJXRVoVSpUhprUXKGFCCzeV8piBgnZCiNw6RILCUkNtC45jtKEC6/K1ZG0+fTLB2iaqAPTJfUslJCacGSVXrwRx8ZoJ2qhCrxiaQh6X6Fd70X9PPl8IdiJmKucfLCnnc8YiSuNduhYfnJ8zH92Pf71ESJIjSbUxFJZlrlKfRvjW8cq9X4Ic3OLKXE7LTed1CZAOyU9TWmt5DQUYeFe9rCt/X4+USv94iv2tPy8n+CA2lK6P1FmaHvSG2NylJrFIYtXjU0EqUV+qmdr1t82fgpyJUmyDRZS5VwCHqjKofX4Z9ELpVDZKxF0Lody3QQfkgR8Q0MJpCjnT9cO7UTPDevn0tF1mXGy+0Y9XKwxIlUgG81Vjk9iKzBT0s/8kLTPCa8shB3KtJfOLh2dk4GmLx5grG/h/bBiE8GHoRd0JjPBjUdHb3lK/Vkp0Dm5eMVQtIrPpnlhrbF7yN8PvP2WsIU2fsOYB8y8q+0O6jgM08oqWnvaPkNp0Z5WtIRkOmOiKZCWhml/gR41U2YCcddEF9e9hjZxuxHjunvyTbza7gmHdtUuCd9XaFedLNU4zU2VbffdHk1eeon4Gtag+I31xenXCTDWNpVL7sWmrv2EutJyxJZgPUd4JYjCj9/bAbx9IF80xS+FzUMfAgoO+xJATlel6IIyD5FM/RDtJt9POTxtH/bXraDPYPBu/O74ZHzMH0vjqJB+CMPKOTjvunwonjwyHmOvtyP+v7peQtMJ/yVGoHSPUjbjPN1yElcl2b1auhsvgqR/QnR1nEWwNI7YT13fSIfXNm8a/rzZ9TzqmXLyJudXN5e5w2dKP3AJDGZwh+vd62Il84rV/FNYSas44BuDH3wL5HUoXjjJBjG1t4Fe9/G0WPtl5QPpp2A9d579BKZtQ5sZXxDhfJjWQX6aplhSz3KP+3dI8o+LK4hA7tLNI3rx3gdR1fVG48rcoW6aDiTx/wywaf4DzM1TDw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Lists all versions of the given `datasetId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-datasets-v-2.ParamsDetails.json b/platform-api-docs/docs/list-datasets-v-2.ParamsDetails.json new file mode 100644 index 000000000..a011b3e6b --- /dev/null +++ b/platform-api-docs/docs/list-datasets-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, lists datasets in a user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-datasets-v-2.RequestSchema.json b/platform-api-docs/docs/list-datasets-v-2.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-datasets-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-datasets-v-2.StatusCodes.json b/platform-api-docs/docs/list-datasets-v-2.StatusCodes.json new file mode 100644 index 000000000..95e15817b --- /dev/null +++ b/platform-api-docs/docs/list-datasets-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"datasets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"workspaceId":{"type":"integer","format":"int64"},"organizationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"lastUpdatedBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"description":{"type":"string"},"mediaType":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"version":{"type":"integer","format":"int64"}},"title":"DatasetDto"}}},"title":"ListDatasetsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-datasets-v-2.api.mdx b/platform-api-docs/docs/list-datasets-v-2.api.mdx index 6200fbab1..e44145f25 100644 --- a/platform-api-docs/docs/list-datasets-v-2.api.mdx +++ b/platform-api-docs/docs/list-datasets-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available datasets in a user context. Append `?workspace sidebar_label: "List datasets" hide_title: true hide_table_of_contents: true -api: eJzdVktvGzcQ/isEz6rkpmmB+pLacVIINdogsdtDESAj7kiizSVpkitXEfTfM8PdlXatleMEuTQnaTmvbz7OgxuZYBHl6b+ygAQRU5TvR7LAqIL2STsrT+WljikKMEbACrSBmUHRagttBYgqYhDK2YT/pbE48x5tIT68uHfhNnpQOC0+iOSEIUcPLHcqe/O3GCtDcgVWzFDMtUkYsBCztYgIQS3FXYVhPRLRhYTFSAAF87DQFuhzLEfSeQzA4KdFA/+iCfr3MxJ7CFAiOeW8N9LSB6l1wJKO5sRzHPmQjn92kG1VYtBK6AJt0nONYSymc+FKnTIwk4l7hCryHdUSS5CnG5nWnnFoEi0wkGjuQgmpPvrludxu6WYCRu9sxMgWz05O+KcP768/yDQHsIml4L3RKtMxuYmssjkM6mY3qBJzE5i8pOsAu5rYa0IIwJzohGX8vAdddHRiCtou5HYkmQUWBLyrNF0uFyAVVwLOm6BpwyH4IljzT74hSv4LQh1nseNyCFkdfEjS4DsUkSzpZPjomlxP7dyxfregngbMhQVY/XFXuk8ysscyMRDTtS+4Kc7X3zvZvR4Y8FdioeEqnw5ImaSXAZmqQ3knK9b7IWnKps/v040KNNg3mDlnEGztcYbmWzXbV9XMCkw1LKHB46qgcBi5jhc4BxrbR8VriqnVMfGUwAbvDBzl5iuuqFMql8zsxewiuXy8otnfr5RHpu7eS7NFai9d750N87YZ0KxBKs+HRvQ5FIKbEWP6klnd7d8SY4TFExq1VXy0k16F4MIB8p8Glku7WYV1iZ8E7p7wsHpEVQWd1nmlntOexnBWpSV9vue9Rft26XgbLzBjBBbJyW7BsIOwaldyFWgqyGVKPp5OJuD1WBlXFeOIdxR/rN3BUn6XJeINVRBfoHjJ+uLszVRy9BbcO+ay5qULcUcNR2x3cq6/rEQn9Z/XbWnc3KectObpw+YNjw0KDvs5gJyuVhgbZS4CULkI+sl3U27GZQ77217QLWj54/jXn8cnfOZdTCXkGmqeOJfd99dDhJt9If7/XnzN/bG7iTeg88jIRG6aWus/cJfEDZ9tNjM6uw5mu+Xj+sHHFVjoyFlTxc7BRHyEq2/7HBxM5BbXBw/UZlLLXN8rCJrh5m6j7BAKfl9RHrXpmVLoU8fqYND0evT3V1ekC/3eeNAL2Xu7puy645s4zRpX7hYt8driT/xNgWi6fAJO/0nM +api: eJzdVktv20YQ/iuLObOS4wY96NLacVIINdogsduDISAj7khae7lL7w7lqgT/ezArSqIkynGCXJqT5Z3XNx/nVQPjPMLoDjQyRuIIkww0xTyYko13MIJrEzkqtFbhEo3FqSW10VbGKVRVpKBy75j+5YG6KEtyWn369cmHh1hiTmP9SbFX1kQ+sNyq7Mw/UKwsR5WjU1NSM2OZAmk1XalIGPKFeqworDIVfWDSmUKnVYlz45BJDyADX1JAAT/WLfyrNujf55BBiQELYgqSdw0OC4IRdMBCBkYST3HgkI5/tpBdVVAwuTKaHJuZoTBQ45nyheEEzCbinqEKMoj5ggqEUQ28KgWHcUxzCpDBzIcCef30y2tomkkGgWLpXaQoFudnZ/JnH95ff0AGKYBjkWJZWpMnOob3UVTq46B+ek85CzdByGOzDrCtiZ0mhoDCiWEq4pc9GN3RiRyMm0OTgbAggkCPlQmkpQBxiYySNxVorISQDyGaf8oXmmRfE+o0ix2XfcjWwfskLb5jUZMBG7bydBspjN3Mi363oF4GzIc5OvPftnRfZOROZWIx8m2ppSkuVz862Xs90OOvIG3wJr32SIWkN4GEqmN5JyvR+4lNQQf8vtxIk6V9g6n3ltCtPU7Jfq9m+6aaWaKt+iWBoq9CTv3ITbyiGVaWT4pXDguTnxKPHVMovcWT3HzDJ+qUyrUwezW9Yp+elxTifqU8M3V3XtotsvbS9d7ZMB/aAS0aTQav+0b0JWolzUiRv2ZWd/u3oBhx/oJG3Sg+20lvQ/DhCPnPPctls1mV8ywngX8inVxFyqtgeJVW6iVhoHBR8QJGdxPZWwXxwss2nlPCiCKC4XbBiIOw3KzkKlgYwYK5jKPhEEszyK2v9CDSIwUcGH+0lD8miXpvkeUDqjeiry7ej0Gib8B9FC7XvHQhbqmRiJudnOovKUHW/ni3KY37J05JG5k+Yt7y2KKQsF8CKOmanGKrLEWAeSqC/eS7KbfjMoX9bSfoFjS8Grw6Ox+cyWPpIxeYiqi9ca67B9ghxHpXif+/k6/9gOJuWFo0aWYkJuu22PYv3IWPLG91PcVIt8E2jTyvLz4pQW2iZK1hNEMb6Rmuvu892JvIA62OLtR2VEMq8CUGI3BTu2WwINRyYN3VrelFnlPJHaujSbPXpL+/vYEMcL85Dpohed/sKbfq+K7rtcaNfyDXNLDBz/I/NJOmaT4DEA1J8Q== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available datasets in a user context. Append `?workspaceId` to list da id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-datasets.ParamsDetails.json b/platform-api-docs/docs/list-datasets.ParamsDetails.json new file mode 100644 index 000000000..183210b92 --- /dev/null +++ b/platform-api-docs/docs/list-datasets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-datasets.RequestSchema.json b/platform-api-docs/docs/list-datasets.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-datasets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-datasets.StatusCodes.json b/platform-api-docs/docs/list-datasets.StatusCodes.json new file mode 100644 index 000000000..95e15817b --- /dev/null +++ b/platform-api-docs/docs/list-datasets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"datasets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"user":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"workspaceId":{"type":"integer","format":"int64"},"organizationId":{"type":"integer","format":"int64"},"name":{"type":"string"},"lastUpdatedBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"description":{"type":"string"},"mediaType":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"version":{"type":"integer","format":"int64"}},"title":"DatasetDto"}}},"title":"ListDatasetsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-datasets.api.mdx b/platform-api-docs/docs/list-datasets.api.mdx index 595b8895d..86ad43073 100644 --- a/platform-api-docs/docs/list-datasets.api.mdx +++ b/platform-api-docs/docs/list-datasets.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [List datasets](https://docs.se sidebar_label: "(Deprecated) List available datasets" hide_title: true hide_table_of_contents: true -api: eJzlVt1v2zYQ/1cIPiWBP9KuKzA/NanbwVixFU2CPbgGSotnmwlNqiTlzBP0v/eOliwplpO06NP2ZJl3vPvdj/eV8yCWno+mXIogPATPZz0uwSdOpUFZw0f87Ox6pTwDI1OrTGD4LSF1kIgAcsCuANj0g/KBVSZmJ6sQUj8aDqVN/MDDV3BioOww1SIsrFv3RaqGGq/0qyv9Tf/lKUMZCytgSeYcoKfK5eDs7LP5bMiJZ0JrJjZCaTHXsPfJlIlX762786lI0Ig1Af5BuBJNqYUCyebbqLNUGzDsy151Ir8MeI/bFGFSzBOJUZOzccVJj6fCiTUEcERWzg3+QaWGCdRRxFYqwoo/pPDvPSqTrcGppEblUNnB10w5QLfBZdDjPlnBWvBRzsM2JT/IASyjKtEnwu7o9SteFDO67lNrPHi68fL8nH7a/v/6A69GQkwgqUhTrZIY7PDWk0p+6NTObyEJFLsjaoLaOdgnSq0pnBNbIiDA2j9tQcmGjg9OmSUvejzzGCEKajamHB86CIoboSlNLoho0vyTXgCD/w5Xx1lsmOxCtnPeJSnxHYpQFlTQdHSDpidmYUm/mTDPA2bdUhj17z4xn3XJHItECx9uUkmVe7n9r5PdqoEOe2uQSlzH0w4pkfTWAVF1KG9ERXr9oDCaNr/PvyRBQ/vC3FoNwuwszkH/rGL7oZzZCJ11S7Dx2Mwl0I1c+TEsRKbDUfEWfarkmHiCYF1qtTjKzQ88USNVPhCz4/k42Hi8wd7ezpRHum5tpZwROytN64358als0KSBKq+6WvSlkIyKEXz4nl7drN81eC+WzyjUSvHRSnrnnHUHyH/pGC7V3GTGBhrP9h7xFDGxqzVhP9kAZ7sK2zhEL0E4cBcZDszRdEaTDCfsytL0XUJETbN0xIf7rumHeaODFkNZD2is+001nTOHDYRXSwguG4NE20zWm8jBgL6KEvaxXFDYW9JnFx8nnGBVqK+I9h2FTex7FskjL8d3TNWohCe7j/dVFt3eh8iPokZF10vKSxTk9imAFK5CQkplyheRxHxpB98Mueys0e2bWtDMff5i8Nuvg3M6S60PaxHTrdx2Tsb79zxlceM73MMeAs/rVP7fLJJlNtAlQqpir4rPkpcpPa0XAWJs1N4jm6v4Cl+B9PN8jmc3ThcFHWOfcFREM2rPTlEEMfOl8vSNJbQQ2sMjj3Hyqewcp+yJ7bQznGoYGRpF5YTg+HkH2wd7cTFD9RUISdsdQtxpXCQJpKFx96DNtfrB7++uUVe0y+1BeUXrnbiQvKhxbe/AIIEVzED/CWBRfANXWIAC +api: eJzlVktv20YQ/iuLOdkGLTlu0ANPteO0MBq0QWyjB0VARtyRtDa5S+8O5SoE/3sxK4qiLPmRoKfkZHnn9c3HedXAOAuQjkAjYyAOME5AU8i8Kdk4CykcHV3PTVBkdemMZWWC0lR6ypBJD9QVkRp9MIHV2sX4YM5chnQ41C4Lg0D35HFg3LDMkafOF8dYmmFuAh+vTY4Xx6eHauq84jmprPKeLHchB0dHn+1nK0GCwjxXuECT4ySnLqYyNpo+OH8XSsxIZc4y/cvKaLJspoa0miyjzswsyKovneql/jKABFxJHiXnSw0pSLCLNScJlOixICYvZNVgsSBIoecCEjDCVok8h8cU/tOhslVB3mQbVB4S8HRfGU8aUvYVJRCyORUIaQ28LCWOsUyzqCr0Ia+efn0LTTMW81A6GyiIxenJifzZjv/3n5BAJMSySLEsc5PFZIe3QVTq3aBucksZS+5eqGGzCtAVykYTvcelEMBUhJc9GN3TCeyNnUGTQBXIi2DDxghwgYySNxVocgkhRIvmX/IFxsm3hHqaxZ7LfchWwfdJWny7oiYBNpzL000gf2mnTvT7BfM6YM7P0JqvXWG+ysg+lUmOgW9KLZ17vvzRyd7qgT3+CtIGr+PrHqmQ9M6TULUr72UlesdsCnrE7+uNNOW0bTBxLie0K48Tyv+vZvuumllgXu2XeAqu8hntR27CBU2xyvlJ8dJiYbKnxJeWyZcuxye5+Y5P1CuVD8LsxeSCXXxekA/blfLM1N14aXfEykvfe29/fGoHtGg0CbzdN6LPUStpRgr8LbO6378FhYCzVzTqWvHZTnrvvfM7yH/Zs1zWe1NZx7Ke3QPp6GpzJnSbjbLKG17GJXpO6MmfVTyHdDSWTVYQz51s3xlF1LJLUxh2UzMM694EbYZ6s6AD+cV6O1c+hxTWRwiWZpDlrtKbS2RnQV9FifrYHijqneirs4+XILDWqK+E9hWFfewdixIR2vUdSzUqQdL++H1dRbcPHPkxMqjEvKW8RSFhXwIo6ZqMQqss9YJZrJft5Pspt5M1hv1tI+jXPrwZvDk5HZzIY+kCFxjrrT13Di66D3qo4sm3e4g9Rl5vavmnuSTbchAjQWrisIrfpW5rerS5BISxdPuQ7N/icxdY9Ot6goFufN408nxfkZcuGst89kYyiKWvTZDfGtIp5oGe+RgHn9rRcaheOE/3prPeRlZ2UbsiABK4o+Wjw7gZNwnMCbWcd6O61TjLMiq5Z7sz57YGwh/vryEB3O63R/0Vve/FVdcrjWt3R7ZpOpgs/wvApvkPPVKAJw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Lists all available datasets in the workspace context identified by the given `w id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-labels.ParamsDetails.json b/platform-api-docs/docs/list-labels.ParamsDetails.json new file mode 100644 index 000000000..30c0e6c37 --- /dev/null +++ b/platform-api-docs/docs/list-labels.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Pagination max results","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Filter search parameter","schema":{"type":"string"}},{"name":"type","in":"query","description":"Label type","schema":{"type":"string","enum":["simple","resource","all"],"x-enum-varnames":["simple","resource","all"],"title":"LabelType"}},{"name":"isDefault","in":"query","description":"Label default flag","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/list-labels.RequestSchema.json b/platform-api-docs/docs/list-labels.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-labels.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-labels.StatusCodes.json b/platform-api-docs/docs/list-labels.StatusCodes.json new file mode 100644 index 000000000..d2f80519d --- /dev/null +++ b/platform-api-docs/docs/list-labels.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"totalSize":{"type":"integer","format":"int64"}},"title":"ListLabelsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-labels.api.mdx b/platform-api-docs/docs/list-labels.api.mdx index b5b3eb689..aef11056b 100644 --- a/platform-api-docs/docs/list-labels.api.mdx +++ b/platform-api-docs/docs/list-labels.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available labels in a user context. Append `?workspaceId sidebar_label: "List labels" hide_title: true hide_table_of_contents: true -api: eJy9Vttu2zgQ/RWCz46d7WWB5mU3bdoi2AANNlnsQxGgY2lsM6FElqSSeIX8+85QF0u2rLgp0CdbnEOemeGZ4ZQywNLLk69Swxy1lzcTmaJPnLJBmVyeyAvlgxegtYB7UITSKCqsULkAUXh0IjF5wMcwFafWYp6Kb388GHfnLSR4nn4TwQhNx/T2tYB2s5xIY9EBE5+nNfVF5dZEWnCQYUDH3pYypw+CdGgIo9jh7wW6tdwO49+WLi8ydCoRKsU8qIVCR2CfrDADeVLKsLZ8sCKfltG0MC6DUC39/kY+PU1a9gwex1kvYanyGJAgrHDoCx384XyvX/X4zGLhMRxM2cJfxuYRXLIaZ/ukNF2JqKCivaMhTh+cypc9hmgZPT9ev6hx+46cSKRLZRF7lVnNUMq0KVzCf0m6rOrHIwYd3YNjcv8MOqigseG/Zrau38qf4QLoKg9xPq2gYqFhORTE3BiNkBPBTfTEmtyzf6V8dXzMP/1Dv/xFh8SSyQNbwVqtknjhs1vPkHKXw8xvMWFvreMSC6oiqGt+gwPngONQATP//H6VHlQxkzpvO1KYyHvQxbClvZOBTE06N7DPvCZOlewzn5OzzhoNAdNhTEqmDw63AK3i2hgZdxRUFhXS183Z/CyYatkE0FfqPzyww2zOaVvg37UyyMyAN0PaeA8p9RgSow8/IhLeohzH+VVSaXhYYqyB0btvgEMF3rr/0Tnjdjx/PaDqpvGL3AR+bcwD+cNwj0nhVFjHrv+e+gy60yKs6POGC4bazcrwY7GMnc4Cm+RMN88GvU73zZtROE22VQjWn8xmYNU00aZIpx6/E/tUmZ0KvooWcUk64UsSHxgvTi/PJXM3rl1xJqusdB1sE8OMTeVHlUUQrVR/PjXXf/sQYsgqX5i4vc5i7QXTPucgh6sS9DWYJQBJlEA/+G7IpAKlo/oW5s+NgauTMlfx/DZ993Z6zGvW+JBBVFDdDS82T/u2f+VGhL92kKgzz58zq0HFko4pKGuNdCeeFcXEK2U5B4//OP30xMtVV2flpMqzv6SzBWiPI1E+M2cM+nWH651Rpm6MUvKzczj93oFjhLiaYn6esB03RrhazAvp9s8bI6TtIPNC0t4QMsJTI36KZWtaGGHrDiEbyhv+cIo5Y4skcSOklCGWcbXxNEnQdnftvA69xvr54zXPRf2WttXC4unNDJGvO2dTSUXEtbnDnMqqzRV/ExE9Cf8DWk1I/w== +api: eJy9Vt9v4zYM/lcEPrtJr3fYQ1623vVuKFZgxdphD0WAY2wmUStLrkS3zQz/7wfKjvPbyXrAnhKLn/SR1EeKFTDOAowewOCETIBxAhmF1OuCtbMwghsdOCg0RuELaoMTQ6rBKm0VqjKQV6mzTG88UJdFQTZT3399df4pFJjSdfZdsVNGB97Y1wG6zZCAK8ijEF9nLfVN41YCBXrMicmLtxVYzAlGsEYDCWhx+Lkkv4DtMP7p6GyZk9ep0hlZ1lNNHhII6ZxyhFEFvCjkYG2ZZtE0dT5HbpZ++QR1nXTsOb71s97iTNsYkMrxTXkKpeFwOt/Hiw0+N50G4pMpO/j72AKhT+f9bN+0YfKqgarujvZxBvbazjYYoqX3/Hj9qsUdOjIBsmUuIg46L4xAPQVX+lT+ojGi6rczAZ29oBfycATNmg0t+e+Fbd1vHa5oiqU5chWN81kDVVODs31BTJwzhBbqehw9KZwN4l8FF+fn8rN56J9/QAKxZCyLFYvC6DRe+PAxCKTa5XCTR0rF28JLibFuCNqaX+HQe5Q4NFMeju/X2UkVk7R525FCAi9oyv2W7k72ZCpZu4FD5oXFXKeHzNeWyRfOIFO2H5Mh0xdPW4BOcV2MgjtjnUeFbOrmanLFrll2jOZO/0sndpjVOV0L/KtVBtS1AD7t08ZnzJSn55IC/xeRyBbtJc4HyCkEnFGsgd67XwL3FXjn/lfvnd/x/OMeVS8bv7KO5bVxr5TFowKlpde8iF3/M6Enf1nyHEYPYymYnHju5LGYxU5XoJhgaJbPRiD/snwzSm9gBHPmIoyGQyz0IDWuzAaBnsnjQLudCr6LFnVrkOWS1BfBq8vbaxDupWt3kskmK+sOdokRxmXlR5VFECTtn2/L63985RiytlMXt7dZbL0Q2mMOSrg6pdCCRQKYRglsBr8eMuWoTVTf1P22Mkh1kg8Nz4fBh/OLwbksFi5wjlFCbTu8Wb3t2w5WKxX+v5NEm3r5HBYGdazpmIOqFcn6yDN3gWWlqiYY6G9v6lqWm7Yu0sl0EH8zGE3RBOqJ8sigsdevJ1rszDJtZwSQd+d0+oMTRw9xM8b8PGE3b/RwdZh30h0eOHpIu0nmnaQbU0gPT4v4KZatcaGHbX0KWVGO5cNr4Yw9MoE5YUY+yrjZeJmmVKzv2nkeNjrr71/vZTDa7GlbPSyevhwi7GLt7KpqEPfuiWxdQ5cr+YZ6XNf1D8aSSSQ= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available labels in a user context. Append `?workspaceId` to list labe id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-latest-dataset-versions-v-2.ParamsDetails.json b/platform-api-docs/docs/list-latest-dataset-versions-v-2.ParamsDetails.json new file mode 100644 index 000000000..92f078e52 --- /dev/null +++ b/platform-api-docs/docs/list-latest-dataset-versions-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, lists dataset versions in a user context.","schema":{"type":"integer","format":"int64"}},{"name":"mimeType","in":"query","description":"Dataset MIME type filter (e.g., `text/csv`, `text/tab-separated-values`).","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-latest-dataset-versions-v-2.RequestSchema.json b/platform-api-docs/docs/list-latest-dataset-versions-v-2.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-latest-dataset-versions-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-latest-dataset-versions-v-2.StatusCodes.json b/platform-api-docs/docs/list-latest-dataset-versions-v-2.StatusCodes.json new file mode 100644 index 000000000..34521a21b --- /dev/null +++ b/platform-api-docs/docs/list-latest-dataset-versions-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetName":{"type":"string"},"datasetDescription":{"type":"string"},"hasHeader":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"createdBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"lastUpdated":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"url":{"type":"string"}},"title":"DatasetVersionDto"}}},"title":"ListDatasetVersionsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx b/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx index 65e405214..8d7bfb649 100644 --- a/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx +++ b/platform-api-docs/docs/list-latest-dataset-versions-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Lists the latest version of each dataset in the user context. Appe sidebar_label: "List latest dataset versions" hide_title: true hide_table_of_contents: true -api: eJzVVk1vGzcQ/SsETy0gr9x8FKgviR07iRCnNRo7PRQGNNodSbR3l2tyJFcQ/N87w92VKGmjKEByyElaznD43psPcqkJJl6f/KszIPBIXt/2dIY+daYiY0t9oi+NJ69oiioHQk9qjs6zSdmxQkinqtmqTBm8Zh6dSm1J+B8l6rSqsMzU8NWjdfe+ghQH2VCRVTmH3YroJQSolec6yluTE0cdLdTHwccLRYsKFXBYj+AYwcMM3SLRPW0rdCC4B1mD/DKccF5D/Nyc8/kZ+1bgoEAOK/yXuuQP3hPBZB8jAoToeluWf1Yoy1mBzqTKZFiSGRt0iRqMlS0MEWa9wNSvVNrkuiEWn+HTKRagT5ZaOPIxhk0TdGwaW1cA1Uu/v9BPT70V6MIUeC3+exE3IkQSjmtZf8FkkvTUUED0Uz8ftv8JRkceRSgmcjSHfIZ++GsnTk/OlBNGxfXj0FfMEL3Ynx0fy88mlL8+cIxAuySxQlXlJg2Z6995cVnuHmFHd5iSZM5JnsnUB7SCRp7gHAh/Q1j4r0doUiM1s8On11r/DFJ/2X4eE+xwm4J/j5BxKtfWkbU5QinmhsVBmWfpHEpKzhbi7/BhZhxm0sYwZzSyh6UzuUggZSxVFvBzcvZLYbIDEaxCdnGtD++yNPg66oaRGcpl6YZDD8qxFf8cPN1UmZDd3RThEo8j4jaQTVzW+EVsBWYGQrN0WeP2P1AI18U0orM5e86JecVmGVJb4+nvpn/EkT1fdHXQGWRKEs/D7VtaKa6VAr2HyQFF0TrupXnhnHU7yJ939H47o1VpSUGe20fGI+4e05kztAjz+IxHO7rTGU3581bGCg/rqZW5PsGAEcSk++3N1V8NAonk5u1gDwnSU6LKn/T7UJkkze0sSzw+MJDE2J1B+SlY1BXfTpJv9Ub81enVQAuMFuUnEbUWKMa60khObCdlaPbgxCv1n7dtJd09UmBvpORleyNog0KO/RpAoWtS9I2zVAOkoRo2yceUmx4Nx75eG+JRpH9L/niZHMtaZT0VEIqpuXMuo/t7+27bBrxcF+hP9ZxoMhnuwioHU0YNX5df9HDqrW8irpIpCybm5XLE5huXPz3Jcn0zS1lmxsMol04cQ+5xj2I/5qXRye0eFztvoHDt86qWB8fhqL/na2MP1ujpswZ6Kx/OCNIwPDgdzdXLwtf7TtMUK4p27czNjZHz7uKafWGzw7c6OkRvXyDlIorNRRA8ru09llwILXiSbz6Ih+X/9rL/yg== +api: eJzVVk1v4zYQ/SvEnFqAkbPpogdf2qTJtkaz7aKbbA+BAY+lscVEEhVy7NQQ9N+LoSRbtrWJC7SHnixzhsP33nyQFTAuPYwfIEFGT+xhqiEhHztTsrEFjOHWePaKU1IZMnlWa3Le2ELZhSKMU9VuVaYIXitPTsW2YPqLI3VZllQkavbDi3VPvsSYJslMsVWZ8XwQ0UsIVFvPXZQPJmNyar5RHycfbxRvSlJYJMoTujhVzytymwg02JIcCu5J0iK/DSdcNxC/tOd8uQANJTrMickJ/woKzAnG0IMJGowIEKLDoSx/blEWq5yciZVJqGCzMOQiNVkomxtmSnRg6rcq7XPdEws0+DilHGFcgXCEMZiCaUkONCysy5Gbpe/fQ13rLejc5HQn/q8ibkXoSbhoZP2GomWk1UxAjGK/nnXfjPMzTyIUU3K2xmxFfvbtIE7PzhRLqOupBke+tIUnL/aL83P52Yfy+6+gIdAuWKxYlpmJQ+ZGj15cquMj7PyRYpbMOckzm+aATtCeJzqHwt8w5f7tCG1qpGaO+OjO+luQ+uv26z7BAbcU/S+ECbmedW5tRliIuWVxUuY1xI4kJVcb8Xf0vDKOEmljXCOj7KEcTSYSSBlLlQX8U/2GFCY5EcE25BDX5vAhS4tvoG40sOFMlu49uUmxsOKfoef7MhGyx5t6uMTjjE1OsmlhMvoqtpwSg6FZhqz99j9RCDfEtEdnf/Zcs4W6b5YhdTCe/mj7RxxrDe+HOugKEyWJJ8//pJX6tZKT97g8oSg6x1dp3jhn3RHy7wZ6v5vRqrCsMMvsCyUhlKd45Qxvwjy+InTkLlecwvhhKmMlJ06tzPUlBYwoJhh1N9doOwgkklt3gz0kCFLm0o9HIyxNFGd2lUSenslhZOzRoPwcLOpThiz5Vj+Jv7r8NAGB0aH8LKI2AvWxbjWSE7tJGZo9OIFuPz50lfT4woG9kZKX7a2gLQo59i2AQtfE5FtnqQaMQzXsk+9Tbns0HPvjztAfRfAuend+EZ3LYmk95xiqqb10bnsX+OHldoi42lXo/+o90aYyXIZlhqbodXxTf72Xk95dRVMNqfUs5qqao6d7l9W1LDdXs9RlYjzOM2nFBWaeXlHsv3lqDHJ7os3RIyjc+zAGkBfH6aj/zefGK1h7b58d0Kn8cUaQhumhIW3v3oeq3XcZx1Ryb9fR4NybOT/f3IEG3G/xg5YO0bsnSLHpxa6qxuPOPlFR19CBZ/kP9bSu678BRcD/7w== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists the latest version of each dataset in the user context. Append `?workspace id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-launch-dataset-versions.ParamsDetails.json b/platform-api-docs/docs/list-launch-dataset-versions.ParamsDetails.json new file mode 100644 index 000000000..c21409dc9 --- /dev/null +++ b/platform-api-docs/docs/list-launch-dataset-versions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"launchId","in":"path","description":"Launch string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-launch-dataset-versions.RequestSchema.json b/platform-api-docs/docs/list-launch-dataset-versions.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-launch-dataset-versions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-launch-dataset-versions.StatusCodes.json b/platform-api-docs/docs/list-launch-dataset-versions.StatusCodes.json new file mode 100644 index 000000000..18b8e443d --- /dev/null +++ b/platform-api-docs/docs/list-launch-dataset-versions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"launch":{"required":["dateCreated","pipeline"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"computeEnv":{"nullable":true,"allOf":[{"type":"object","properties":{"credentialsId":{"type":"string","description":"Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See [Create credentials](https://docs.seqera.io/platform-api/create-credentials)."},"orgId":{"type":"integer","format":"int64","readOnly":true,"description":"Organization numeric identifier (read-only, set by system)."},"workspaceId":{"type":"integer","format":"int64","readOnly":true,"description":"Workspace numeric identifier (read-only, set by system)."},"id":{"maxLength":22,"type":"string","readOnly":true,"description":"Compute environment alphanumeric identifier (read-only, generated by system)."},"name":{"maxLength":100,"type":"string","description":"Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters."},"description":{"maxLength":2000,"type":"string","description":"Description of the compute environment. Maximum length: 2000 characters."},"platform":{"maxLength":25,"type":"string","description":"Compute platform provider.","enum":["aws-batch","aws-cloud","google-batch","google-cloud","azure-batch","azure-cloud","k8s-platform","eks-platform","gke-platform","uge-platform","slurm-platform","lsf-platform","altair-platform","moab-platform","local-platform","seqeracompute-platform"]},"config":{"description":"Platform-specific configuration. Structure depends on the selected platform.","type":"object","properties":{"workDir":{"type":"string","description":"Work directory path for storing intermediate workflow files."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"},"description":"Environment variables to set in the compute environment."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"discriminator":{"type":"string","description":"Platform type discriminator (read-only, set based on platform selection).","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"moab-platform":{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"aws-batch":{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},"google-cloud":{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"azure-cloud":{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},"gke-platform":{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"google-batch":{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},"aws-cloud":{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},"slurm-platform":{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"k8s-platform":{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},"altair-platform":{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"lsf-platform":{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},"azure-batch":{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},"seqeracompute-platform":{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},"eks-platform":{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},"uge-platform":{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]}}},"oneOf":[{"title":"AWS Batch configuration","type":"object","properties":{"storageType":{"type":"string","deprecated":true},"lustreId":{"type":"string","deprecated":true},"volumes":{"type":"array","items":{"type":"string"},"description":"EBS volumes to mount (format: `/host/path:/container/path`)."},"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"AWS region where resources will be created (e.g., `us-east-1`)."},"computeQueue":{"type":"string","description":"AWS Batch compute queue for running jobs."},"dragenQueue":{"type":"string","description":"AWS Batch queue for DRAGEN workflows. See [Illumina DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview)."},"dragenInstanceType":{"type":"string","description":"EC2 instance type for DRAGEN workflows (e.g., `f1.2xlarge`)."},"computeJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to Nextflow compute jobs."},"executionRole":{"type":"string","description":"IAM role ARN for ECS task execution."},"headQueue":{"type":"string","description":"AWS Batch queue for the Nextflow head job."},"headJobRole":{"type":"string","description":"Role ARN to grant fine-grained IAM permissions to the Nextflow head job."},"cliPath":{"type":"string","description":"Path to the AWS CLI installation in the container."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated to the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job, in megabytes."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nvnmeStorageEnabled":{"type":"boolean","description":"Enable NVMe instance storage. Requires Fusion file system."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"fusionSnapshots":{"type":"boolean","description":"Enable [Fusion Snapshots](https://docs.seqera.io/fusion/guide/snapshots). Requires Fusion file system."},"forge":{"description":"Batch Forge configuration options. [Batch Forge](https://docs.seqera.io/platform-cloud/compute-envs/aws-batch#automatic-configuration-of-batch-resources) automates the AWS Batch compute environment and job queue configuration required for deploying Nextflow pipelines.","type":"object","properties":{"type":{"type":"string","enum":["SPOT","EC2"],"description":"Instance type. `EC2` deploys uninterruptible on-demand EC2 instances. `SPOT` deploys interruptible Spot instances (lower cost)."},"minCpus":{"type":"integer","format":"int32","description":"Minimum CPUs provisioned in the compute environment."},"maxCpus":{"type":"integer","format":"int32","description":"Maximum CPUs provisioned in the compute environment."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"ebsAutoScale":{"type":"boolean","deprecated":true,"description":"If true, provisions an EBS auto-expandable disk in the compute environment. Not compatible with Fusion file system."},"instanceTypes":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of allowed EC2 instance types."},"allocStrategy":{"type":"string","enum":["BEST_FIT","BEST_FIT_PROGRESSIVE","SPOT_CAPACITY_OPTIMIZED","SPOT_PRICE_CAPACITY_OPTIMIZED"],"description":"Determines how Batch selects EC2 instances to carry out job executions. Default: `BEST_FIT_PROGRESSIVE` for on-demand instances and `SPOT_PRICE_CAPACITY_OPTIMIZED` for Spot instances."},"imageId":{"type":"string","description":"Custom AMI ID to use for launching EC2 instances. Must be an AWS Linux-2 ECS-optimized image that meets the compute resource's AMI specification. If omitted, the latest approved version of the Amazon ECS-optimized AMI for compute resources is used."},"vpcId":{"type":"string","description":"VPC ID for networking."},"subnets":{"type":"array","items":{"type":"string"},"description":"List of VPC subnets to isolate EC2 resources from each other, or the internet."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"List of security group IDs to define a set of firewall rules that control EC2 compute node traffic."},"fsxMount":{"type":"string","description":"FSx for Lustre mount point."},"fsxName":{"type":"string","description":"FSx for Lustre file system name."},"fsxSize":{"type":"integer","format":"int32","description":"FSx for Lustre file system size in GB."},"disposeOnDeletion":{"type":"boolean","description":"If true, delete AWS resources when compute environment is deleted."},"ec2KeyPair":{"type":"string","description":"EC2 key pair for SSH access."},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"List of additional S3 buckets accessible to compute environment."},"ebsBlockSize":{"type":"integer","format":"int32","description":"EBS volume size in GB."},"fusionEnabled":{"type":"boolean","deprecated":true,"description":"Enable Fusion file system (v1)."},"bidPercentage":{"type":"integer","format":"int32","description":"Maximum allowed price of a Spot instance, as a percentage of the on-demand price for that instance type. Spot instances will not be launched until the current spot price is below the specified cost percentage. Default: `100%`."},"efsCreate":{"type":"boolean","description":"If true, creates new EFS file system."},"efsId":{"type":"string","description":"Existing EFS file system ID."},"efsMount":{"type":"string","description":"EFS file system mount point in containers."},"dragenEnabled":{"type":"boolean","description":"Enable [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) support."},"dragenAmiId":{"type":"string","description":"AMI ID for [DRAGEN](https://docs.seqera.io/platform-cloud/supported_software/dragen/overview) instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"Boot disk size for instances, in GB."},"ecsConfig":{"type":"string","description":"Custom configuration for the ECS agent parameters used by AWS Batch. Appended to the `/etc/ecs/ecs.config` file in each cluster node. Altering this file may result in a malfunctioning Batch Forge compute environment. See [ECS agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)."},"fargateHeadEnabled":{"type":"boolean","description":"Run Nextflow head job on Fargate container service. Requires Fusion file system and Spot instance provisioning model. Fargate is not compatible with EFS and FSx file systems."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 (Graviton) instances. Requires Fargate, Wave containers, and Fusion file system."},"dragenInstanceType":{"type":"string","description":"Instance type for DRAGEN workflows."}},"title":"ForgeConfig"},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Batch Forge (read-only)."}},"required":["region","workDir"]},{"title":"AWS Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"allowBuckets":{"type":"array","items":{"type":"string"},"description":"Comma-separated list of S3 buckets accessible to the compute environment."},"region":{"type":"string","description":"AWS region for EC2 instances (e.g., `us-east-1`)."},"instanceType":{"type":"string","description":"EC2 instance type (e.g., `t3.medium`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"The AMI ID to use for launching EC2 instance. If omitted, the default [Seqera-maintained AMI](https://docs.seqera.io/platform-cloud/compute-envs/aws-cloud#managed-amazon-machine-image-ami) is used. Use Seqera AMIs for best performance."},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"logGroup":{"type":"string","description":"CloudWatch Logs group for container logs."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 architecture (Graviton) EC2 instances to run compute jobs."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances to run compute jobs."},"ec2KeyPair":{"type":"string","description":"EC2 key pair name for SSH access to instances."},"ebsBootSize":{"type":"integer","format":"int32","description":"EC2 instance boot disk size, in GB. If omitted, a 50 GB `gp3` volume is used by default."},"instanceProfileArn":{"type":"string","description":"The `InstanceProfile` ARN used by the EC2 instance to assume a role while running. If unspecified, Seqera will provision an ARN with enough permissions to run."},"subnetId":{"type":"string","description":"Subnet ID for instance placement (single subnet)."},"securityGroups":{"type":"array","items":{"type":"string"},"description":"Security group IDs that control network access."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Seqera Compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"region":{"type":"string","description":"Target execution region. See supported AWS regions [under step 4 here](https://docs.seqera.io/platform-cloud/compute-envs/seqera-compute#create-a-seqera-compute-environment)."},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"defaultDataRetentionPolicy":{"type":"boolean","description":"If true, intermediary files are deleted after 28 days to manage storage cost/usage."},"nextflowConfig":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}},"required":["region","workDir"]},{"title":"Google Batch service configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"location":{"type":"string","description":"Google Cloud location (region) for Batch jobs (e.g., `us-central1`)."},"workDir":{"type":"string"},"spot":{"type":"boolean","description":"Use Spot instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Boot disk size in GB for compute instances."},"cpuPlatform":{"type":"string","description":"Google Cloud Batch CPU platform."},"machineType":{"type":"string","description":"Machine type for compute instances (e.g., `n1-standard-4`)."},"projectId":{"type":"string","description":"Google Cloud project ID."},"sshDaemon":{"type":"boolean","description":"Enable SSH daemon for debugging."},"sshImage":{"type":"string","description":"Container image for SSH daemon."},"debugMode":{"type":"integer","format":"int32","description":"Debug level (0-3) for troubleshooting."},"copyImage":{"type":"string","description":"Container image for copying files."},"usePrivateAddress":{"type":"boolean","description":"Use private IP addresses only (no external IPs)."},"labels":{"type":"object","additionalProperties":{"type":"string"},"description":"Comma-separated list of labels to apply to Batch resources."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"nfsTarget":{"type":"string","description":"NFS server target for shared storage."},"nfsMount":{"type":"string","description":"NFS mount path in containers."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"serviceAccount":{"type":"string","description":"Specify a service account email address other than the Compute Engine default to execute workflows (recommended for production environments)."},"network":{"type":"string","description":"VPC network name."},"subnetwork":{"type":"string","description":"Subnetwork name within the VPC."},"headJobInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for the Nextflow head job."},"computeJobsInstanceTemplate":{"type":"string","description":"Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs."}},"required":["location","workDir"]},{"title":"Google Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"workDir":{"type":"string"},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"projectId":{"type":"string","description":"Google Cloud project ID."},"region":{"type":"string","description":"Google Cloud region (e.g., `us-central1`)."},"zone":{"type":"string","description":"Google Cloud zone within the region (e.g., `us-central1-a`). If omitted, defaults to the first zone in the alphabetical list."},"serviceAccountEmail":{"type":"string","description":"Service account email for IAM access to instances."},"instanceType":{"type":"string","description":"Machine type (e.g., `n1-standard-1`). If omitted, a default instance type is used."},"imageId":{"type":"string","description":"ID of the image defining the operating system and pre-installed software for the VM. [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) Google public images are supported. For GPU-enabled instances, a [Deep Learning VM](https://cloud.google.com/deep-learning-vm/docs/images#base_versions) base image with CUDA pre-installed is automatically selected. Optimized, Seqera-owned custom images will be available in a future release."},"arm64Enabled":{"type":"boolean","description":"Enable ARM64 instances."},"gpuEnabled":{"type":"boolean","description":"Enable GPU instances."},"bootDiskSizeGb":{"type":"integer","format":"int32","description":"Size of the boot disk for the Compute Engine instance. `pd-standard` is used. If undefined, a default 50 GB volume is used."},"forgedResources":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Resources created by Cloud Forge (read-only)."}},"required":["region","workDir"]},{"title":"Azure batch configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"region":{"type":"string","description":"Azure region (e.g., `eastus`)."},"headPool":{"type":"string","description":"Batch pool for the Nextflow head job."},"autoPoolMode":{"type":"boolean","deprecated":true},"forge":{"description":"Batch Forge configuration mode properties. Batch Forge automatically creates Azure Batch resources during compute environment creation.","type":"object","properties":{"vmType":{"type":"string","description":"Azure VM type used by the Batch pool. Must be a valid Azure Batch VM type. Default: `Standard_D4s_v3`."},"vmCount":{"type":"integer","format":"int32","description":"Number of VMs in the Batch pool. When autoscaling is enabled, this represents the maximum number of VMs to which the pool can grow, and automatically scales to 0 when unused."},"autoScale":{"type":"boolean","description":"Enable auto-scaling for the Batch pool."},"disposeOnDeletion":{"type":"boolean","description":"Delete Batch compute pool when the compute environment is deleted."},"containerRegIds":{"type":"array","items":{"type":"string"},"description":"Container registry resource IDs."}},"title":"AzBatchForgeConfig"},"tokenDuration":{"type":"string","description":"Duration of the SAS token created by Nextflow. Default: `12h`."},"deleteJobsOnCompletion":{"description":"Automatically delete Batch jobs after completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"JobCleanupPolicy"},"deletePoolsOnCompletion":{"type":"boolean","description":"Automatically delete Batch pools after completion. Default: `false`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."},"managedIdentityClientId":{"type":"string","nullable":true,"description":"The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage."}},"required":["region","workDir"]},{"title":"Azure Cloud configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"waveEnabled":{"type":"boolean","description":"Enable [Wave containers](https://docs.seqera.io/wave). Default: `false`."},"fusion2Enabled":{"type":"boolean","description":"Enable [Fusion file system](https://docs.seqera.io/fusion). Requires Wave containers. Default: `false`."},"nextflowConfig":{"type":"string"},"instanceType":{"type":"string","description":"Azure VM size (e.g., `Standard_D2s_v3`)."},"region":{"type":"string"},"resourceGroup":{"type":"string","description":"Azure resource group for VMs."},"networkId":{"type":"string","description":"Virtual network resource ID."},"subscriptionId":{"type":"string","description":"Azure subscription ID."},"managedIdentityId":{"type":"string","description":"User-assigned managed identity resource ID."},"managedIdentityClientId":{"type":"string","description":"Managed identity client ID for authentication."},"logWorkspaceId":{"type":"string","description":"Log Analytics workspace ID for monitoring."},"logTableName":{"type":"string","description":"Custom table name in Log Analytics."},"dataCollectionEndpoint":{"type":"string","description":"Data collection endpoint for logs."},"dataCollectionRuleId":{"type":"string","description":"Data collection rule ID for log routing."},"forgedResources":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"Map.Entry_String.String_"},"description":"Resources created by Cloud Forge (read-only)."}},"required":["location","workDir"]},{"title":"IBM LSF configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"unitForLimits":{"type":"string"},"perJobMemLimit":{"type":"boolean"},"perTaskReserve":{"type":"boolean"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Slurm configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"title":"Amazon EKS cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"AWS region"},"clusterName":{"type":"string","description":"The AWS EKS cluster name"},"waveEnabled":{"type":"boolean"},"fusion2Enabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Google GKE cluster configuration","type":"object","allOf":[{"title":"Kubernetes compute configuration","type":"object","properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"server":{"type":"string","description":"Kubernetes control plane URL (e.g., `https://your-k8s-host.com`)."},"sslCert":{"type":"string","description":"SSL certificate to authenticate the connection with the Kubernetes cluster."},"namespace":{"type":"string","description":"Kubernetes namespace for workflow execution. Default: `default`."},"computeServiceAccount":{"type":"string","description":"Kubernetes service account to use for Nextflow-submitted pipeline jobs. Default: `default`."},"headServiceAccount":{"type":"string","description":"Kubernetes service account to connect to the cluster and launch workflow executions. See [Cluster preparation](https://docs.seqera.io/platform-cloud/compute-envs/k8s#cluster-preparation)."},"storageClaimName":{"type":"string","description":"PersistentVolumeClaim name used as scratch storage for workflow execution, e.g., `tower-scratch`. Must allow `ReadWriteMany` access mode."},"storageMountPath":{"type":"string","description":"Mount path of the persistent volume claim used as scratch storage. Default: `/scratch`."},"podCleanup":{"description":"Pod cleanup policy after job completion.","enum":["on_success","always","never"],"type":"string","x-enum-varnames":["on_success","always","never"],"title":"PodCleanupPolicy"},"headPodSpec":{"type":"string","description":"Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"servicePodSpec":{"type":"string","description":"Custom configuration for the compute environment service pod, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`."},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)."}},"required":["server","sslCert","workDir"]},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"workDir":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string"},"region":{"type":"string","description":"The GKE cluster region - or - zone"},"clusterName":{"type":"string","description":"The GKE cluster name"},"fusion2Enabled":{"type":"boolean"},"waveEnabled":{"type":"boolean"}}}],"required":["region","clusterName","workDir"]},{"title":"Univa Grid Engine configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Altair PBS configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"title":"Moab configuration","type":"object","allOf":[{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig"},{"properties":{"discriminator":{"type":"string","description":"property to select the compute config platform","readOnly":true},"environment":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}}}}]},{"type":"object","title":"Local execution configuration","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"environment":{"type":"array","description":"Array of environment variables for the compute environment.","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"value":{"type":"string","description":"Environment variable value."},"head":{"type":"boolean","description":"Apply this variable to the Nextflow head job."},"compute":{"type":"boolean","description":"Apply this variable to the Nextflow compute jobs."}},"required":["name","value"],"title":"ConfigEnvVariable"}},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"discriminator":{"type":"string","description":"Property to select the compute config platform.","readOnly":true},"waveEnabled":{"type":"boolean","description":"Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)."},"fusion2Enabled":{"type":"boolean","description":"Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)."}}}],"title":"ComputeConfig"},"dateCreated":{"type":"string","format":"date-time","readOnly":true,"description":"Creation timestamp (read-only, set by system)."},"lastUpdated":{"type":"string","format":"date-time","readOnly":true,"description":"Last update timestamp (read-only, updated by system)."},"lastUsed":{"type":"string","format":"date-time","readOnly":true,"description":"Last usage timestamp (read-only, updated by system)."},"deleted":{"type":"boolean","readOnly":true,"description":"Deletion status flag (read-only, updated by system)."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["CREATING","AVAILABLE","DELETING","ERRORED","INVALID"],"title":"ComputeEnv.Status"}],"description":"Current status of the compute environment (read-only).","enum":["CREATING","AVAILABLE","ERRORED","INVALID"]},"message":{"maxLength":4096,"type":"string"},"primary":{"type":"boolean","readOnly":true}},"required":["config","name","platform"],"title":"ComputeEnv_ComputeConfig_"}]},"pipeline":{"maxLength":200,"type":"string"},"workDir":{"type":"string"},"revision":{"maxLength":100,"type":"string"},"configText":{"type":"string"},"towerConfig":{"type":"string"},"paramsText":{"type":"string"},"preRunScript":{"type":"string"},"postRunScript":{"type":"string"},"mainScript":{"maxLength":200,"type":"string"},"entryName":{"maxLength":80,"type":"string"},"schemaName":{"maxLength":100,"pattern":"[\\p{Graph}&&[^/]]\\p{Graph}+","type":"string"},"resume":{"type":"boolean"},"resumeLaunchId":{"maxLength":22,"type":"string"},"pullLatest":{"type":"boolean"},"stubRun":{"type":"boolean"},"sessionId":{"maxLength":36,"type":"string"},"runName":{"maxLength":80,"type":"string"},"configProfiles":{"type":"array","items":{"type":"string"}},"userSecrets":{"type":"array","items":{"type":"string"}},"workspaceSecrets":{"type":"array","items":{"type":"string"}},"optimizationId":{"maxLength":32,"type":"string"},"optimizationTargets":{"type":"string"},"headJobCpus":{"type":"integer","format":"int32"},"headJobMemoryMb":{"type":"integer","format":"int32"},"launchContainer":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier associated with this launch."}},"title":"Launch"}},"title":"DescribeLaunchResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-launch-dataset-versions.api.mdx b/platform-api-docs/docs/list-launch-dataset-versions.api.mdx index 81c86f4c5..9a1d91e24 100644 --- a/platform-api-docs/docs/list-launch-dataset-versions.api.mdx +++ b/platform-api-docs/docs/list-launch-dataset-versions.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the details of the datasets used in the launch identifie sidebar_label: "Describe launch datasets" hide_title: true hide_table_of_contents: true -api: eJztfXtzGsmS71ep0MTZI8UKsGWfibP+6yIk67AjbK6Q5Tjr9RUNFKhH/WC6uiUxDn33m5lV1V39ABokj21cG7FnLLoeWa/MX2ZlZn3Zi52Z2HvzaW/ixI7gsdj7fLg34WIcufPYDYO9N3sXPI5cfscFi284m/DYcT3Bwqn8U1VjieAT5gb0o+ckwfiGuRMexO7UhQ+jBX2YuXc8YEP5vTsZNvcO98I5jxzsqjuBzs5dEZ/T5xPZ8hWPBHwUUHLuRI7PY/gBCP6yF8AfUEM3BgVcJHfuxDd7xTHIJpmAkQSzjLAICYj4H4kbceg9jhJ+uCfGN9x39t582YsXc+xB1tp7fDxMO70Po1sxd8Y86/ePhEeLUscfdUEWJD6P3HGh81JnbhDzGY/g0zSMfCeWP/36Grr/jLSKOUwGF1jj6MUL/E++w/e/QdVxCK0EMX515nPPHdMEt34XWORLudNw9DsfxzjFES5H7MoO5NTiv7I5op3COxGH/8Wxz90599yA475Z3Zo7wf/1nYdzHsxgjd4cHR0WpxhJ9+dJzE+DOywdJJ7njDyu18bxvPdTWn2TIhju1J1Bh7Q60K/nxDh7lb+sKKw+rR3JGPrFRXQ80Z2UN0pxD3Sy4sbqM+iUqdEyHty5URj48JE5CRwVKCQXrcku5EgF4w9wOHD/jr0wmTCg6Q6ai1r/6neYQVKTDThnn+QSmR8+79/E8Vy8abUm4Vg0Bf8DTl7TDVt6ChrO3G2NqV7DqHfQxIUJo1lusEs3Ku5SZ/I+8BZ61Qo7NJo5gfsnja7iVLB9rN4Iof4hAwaAvEMsRMx9SYd59J6BmlUHdB0pNXb0uu47VRvAm984a6iZ8QDZpmStJk2SQeWoevniRZmsPBkfAhf4F8PKtC+RWVfszSbrJSKGL4GArYgy4GUDWs9RfAgyQdwcMmglCWB7inEYQWM3wLzHyLuJylzv+Sl8sZ7ak+wvLYeqiXUeXD/xmUdtv2HYdpGS9PgXyPhHmQgOI0R249yLxsiJxyhm8N90HOHfszCcebzhuVOgz+XBmIvsV11B/anrOH8mUfZR/qW/3f5TNAzuxG9zf85uuflnMsv9KbwEzrPxgyem5p+OB2I8Mn/xQ2eUqxCOHS/XJPELNdG5tlbPR62RbzTWdYMrzEVxZOWx/7VjfcIqf7ORl1ChZly6RCqOmlKKkyQtoZO+ljRizsfA1cZMlkwiJewGwCTHMcwPAM05DyYANCWmFNwDUQz8TneI6Gm1mEZJceJG6wU0ygA2ARk7jsNowRBBEhcU8CfhRRAukc8nLgpUbHXqhfds6npc8ZCIXyTBgFpc31t7MmEOk7/A0JwYBDsfw1wKjZ+DaUNBaFVqHrnIlEMocBfeIknv+ENMVMCQgc8AIlRivw9T5wQwTaGIG1ESqCZqCH/akC3ZccuZ3DnAwCa/wNga0F5Dt9dQ7Ulpg78+z9CdKcwxCBKvYmjsxrmTLN4D+D/5JiM1BIsxTieKHAT9LshfsR5Qa+G8epZODSxw50QuAmASzUTIneMl2zZCdamVG4ASRiOjMPS4E5QXDLQHVN1ckTUC2xA3abpM2BT7PRw1Dfj+TE1rqQ6t40l7PMzBfgXg5YQc5v9EDO/GqDgAp0IOA/NxpbopAZDKyRJIDYI+dSirEAYBLkVsJ2V5a8+Ai/90PHOcBhPEflFrW6h9XihFfGfbPa6Jbci2GtiW3N8TF4n03cABprd+FJqRMyzGcpXLqNlB2wAMLJUVkplDSwfNEkJ+rCJGHaPFO6l+57+DnIP5QioRw+VEHo5DbYMefMhPdIUAyfTLZxIt6eLd52WMkmpjD/A0j/4umABYCrOEC6LwvALbI+RyzBmJ0CN5i8IJ2Z6hoDEfCxKTpKm/j4AfMWeM3NMKqJ9EQO0IH5Ila52tk/Q03d/wyBAbMDfimU4P605Z6LsxrCootnzqJF5MkmGoWMCQqE4Ej97VEu4foGSqZg8G/8LZDCQzxGbRlkMCNQgnSlLDatdr+l9QkpqGlrt95kwmEQwBNeRyq/MwiteaT14dlfpAirFuk53IyXjDhkdHwxRT/N+E10EnlzfK2KDU9z+wWoEpSpMyzIliNTlkII8lqgwG6tii88qOoc/7Gxe61MZNAiAMGDQTyUjuhibrwMaC7RXe8ShyJ7CbtJU7rZXXbZBQ33kgIgfun3yb6UfSfWXVCBJ/BMTCIIi67HgCXZJMjafkIAXUAv0v4GEi8FBnC/jyxYtsBf87HL2n7sRGPET1GMqqqRGpGiWiMHVmoE39a1mHy1AjHEcyo7FhntYhrQ6cZsmzXLlzTAoa6dJVwEoNEtojGKkzjs9gRRUjRat/XvhvCJU0dpF4EoFPDk8qbmqo4AU8ZHWPndI94P8+P5qGJAOjtj8O2DH+uBao5tcWDRXOjF9SoarVAegwpgsbvaWQ00V82e1FqfgdiE+fixq7L7vJKeyJ4wFTreBU+2ECm2NfsjtgQS0Ucy0Uz29aeHvlAP+M6O/hVvrJ0w9dxGfKOr2GB8KaybIKhoDQDZMI0AO7dwEtjugOhkz1+7w5awLrSkSDO4DhXqqxbSa+zE0iRyP5O7JcQD4Bom+1aaEq7otg45azFk8u2men71Krl0bxXQ+WEhZDfa+LA0UyR/TAJ9cinMb3wLNbksIWitE7l98fGGR3AxEjXly+r3M7rHME6oesIdXSKvrTRZi+bB49eE404/lVAJlyEXo1+sNSrH3xDrfYLHJgO09h0zbgn/CfCeu2ewy2oO8Kur/GUst4C3B4DWfqdY1tR7p7HOVpZ8BiR9wWcNEGiKxq7ZezWiV8v9ZEreDxntvHC/71BgpE+qopHFvnvCt3h+dJ7SY16yhmk14uVuoeVon+KZRota8780RsA8/fpZC80/8gcJwhydHVe1p12uM+6LK90TYdy7q6Q9zeS8/vIe4/n8+c0SJW9xcWX+4SvgQuBgfpNMA/68yDLMk+fZTHT7HD5QcMWz8w1ccpqF1cKpDTBHn40eadv6WKpvlzaf+yjwPDMaZA+RLagjvYMQOJlDcm8N1Vj2foQuFtg4Qy/dKaFc7OojCZ13ASQm71kQTweTgTICihmvIRUgNj0JrYJVufXMlB4MzFTRjXUf8L2yWtumaztGaJO+EtoYsfrF85GNCMly+wJUR6ix8LM6gsH032yShTd870fTtwYtFKVcNf6H8bRErDKKKZ3wH6ioUgF5RvZlkzyLkVBcTKFL7LE69ZD2040P+8cJHHH8qkJdbfusdLwLr2nhn031/Cn4DWy04FXRO+N9kQCg0VOYIlAd3DRwmUxk0QBo0J93FUJvKHBRhiF1m9fK3BPIyzwmwfRsfxjIlY7klQaraV/j03IMMcyX5yh8CdlbnFLrtB9J2HrbtUtsBNu5zNk41Z4Fn/gzHLhBtGog0bcDB2vGVSMW9JWGrNS0kXaK5HWwHu7AZ/mMP6Uu+g/9+uGhV7F8b0wZHrfO8C/l9ytl1Dr3yKTaMT+r7TEBwdkxHlecopDmHYPc/vS9rSctoIpQ1irDNbrDoqx6eDy+u3XTwu+p/X/Yv3Zxeng0H36hR+xp1+3Wn3253u5b+v3/cvu73u/5ye6C/9i27ntOp76eSdoF+1jyec3cB5l1xEGk5E/nyhqBjDTC1YmMTEUFKdMyd5qygeEn/JDm7WKP41XEmzrJs/vnI1fRDFtfxwE5DbPmv3uqx7gsNIhNRzpcRChlfgJMYVEvLWczdIHhpHqG03kN377p941LB/qef4HF3hzS2qjUF/F9SvdntS3k7m5ZJ0nAdWHqMkhvMATd9J53d9S9L2nT/hr3z32KzpSpyZn1zplS+R9XxcZ4qu+h2cG2wv4DFqw1CKGhDJKODxU07LuTod2IdqjZRdEeKwaeoz2qcRrBR3YBOGMPKI3ElxCoiZQ1VJE+y7yI0XBLGegzTdoEJf3ROicMLRXoEqLadSU5CU96jDRgm5ieDKI0iLQo9GoVcCL9uAvzlTWHCJKcRDD+2e69fh7eCBFuGczLTKWjoPXcW+oaF6V4KFdgxGmCld0Ni211ErmhfQJPLrs2NtvgWNm78PToCnaLffunc9E6wj4Y1hXL3hQSXOgW0vK8idz8dHv/FF36lzo4yrd8vRA9CN0gtaw4+CGPtxMr59npPgZLB88IqNZLuqP1fpjMskOMjeYxAjt9suXWaPLy6VhMyr4cFqsa4AQ1n6sv27lxJmjdxJn8M6gmoz24p+jXy0rJ1H7phudJ28jDhkDkwpGhhVZ5qZZlJIVpUGEyfOS+xmETCSTT8ISSxIuQGdw+l0Pcn3kyjCTSiwlmwY9uOII4gmN1YpAOgSEjZBRlbhPvZvUmflUyHjODY5LvK6QQAHv2enbwcl+AON1pEFpzrcpNAGsEXdTE1uVmzAYGe47wzNPbP9b25CePabCKbKGFS1fbfO1CmIgVvqK5BVAuHHYRhvywewrgTXxAaQ5LT9Q4Mr8LGoa21QOCuvYWp7JN5U4Hhg/dNwPunpMVpkCmyTtefo/p2ZToctHo9bQAX+f1O2PZS7CogkpKDdN8jJhbU9+DduXzLDUUHfWaAAgUOGdRz425vCCUb6sGBet69QMcg0kg0gN8DCAoMO33QIrgGtfksiN6jakhCvNeF3wBPg+EvLBIypQY0qI0nzJvY9ZSRxIu0pUf9MXCRB2YiJbi5vZWuGUUngthqvtmURPM8xwkxjw5nzYca9Zto4zHdQoY0hG8CGCDVkjSvRGvm/vt740Lcver++ZvtnkXPnxmFgng1jPJKsw6Kd8FBSU60jbnMD2V17+5j3NqGtlrqZSJPT5EIjnE1M8RmS6BvGGHWTXQzn1QhKX0vDwTO3fua+e1C2S6tb8eym7LD8E7o35AJgDA+HM/qdkbVzQyeHv9wDwF747f6F36oL3x2xstvbPXu7t/u3e7BdcePWQec5GaTqaaWmrtdXrg3l/mW4d6FSFzmedvAC7Fdj4+faxCoEm5TwWN5Hw4FelvqpY92pG4GuSS2q1ihge8QxyYBHZmtlTyMo2B6PUUE79R3XW0/1QFZCswWpdRyrEfhBxx5pzJAyLme03QhY9Rw0zypcpacgeNnANiZONCFPutwUOHoSCi5hpk20tuEYVDllNJC2XjIIStWCM5W/BP4ysDIKHeVtBABLq3KpEnTVa7JPH0YwXQk7vxxkh4F4e1OCJ1IcFB+hU9Ki3kUrFA2VheWXhNq4hrU+YGr7zJORh3kDqKzyWVc6ZRMRHt7jNLg8wqaq54CqyvmcnXMnosFd9VbQNYGiDU8Vbdz5JoG/YMDXtbJdA2H4p5o50gM6H07ahRmCZVFXmbgjgbvqcN8me68t3YcgNJFLNMJ7vOEaSy1TjVO7Wjp3MC/EdEjDmyYUSxxBa0DEkxWN/B5+nks0qBCfgP6NCvzZVs4/WFNv0FGqzuu9pgO1T4OZG2Q+DE02nE/SAzRMDwaeIszbgCbv3Dn6xwt2dqxNhuYx+oZqi2SVz6i2mKH5pl82/vxjKC3bezCux/0WTFow+VOAyXWa38YARjKQq540smoEM1Dc9/rkSFzfvVJgcRkEpU+SCdb0KZO96kqGS9lVT/uR0R1vrZthN4oTAIuqStaqAs4iGaXFa5nIiTazlm7JdwIQ6ZMuxWfGizqNYVBlwxHCnSEyUA2o1EnxokRroYeO58I/6vTTK7Y8pqra1l/I3KUcAD9WJqxa0sN5OGNtkIcLaEWwNNeV7sEPA1cmJdGtX+KhqHcZrOzyccpIESPlOpSWTyd2OqGnIvRPgwld1KxvHhP2wdHSFRlXNaWLhXZdzLd+kXi1pqXYNt686zmBphns7FhPyhPwSF5M3fIK75zlose07PacefMU1LPF9YA+NuV/rst3wU/DNdrdO4dsKn4kk6yZSqhskj377TS9QdkgTYJq5LdkRH4ZOI4cWNlBoGQtv7tg+UVjB6+x03I7Wzr5QL+gSX24OE8luSZwAWe5gRm9MJwRFWUl04XwOjyqMaGDwTkb46kgJzGCgoZU4TpkSWcMIH0afzOplIc4zQZIAmSjcaa1iL+mCa+y2DIDNSn1cGjC3kHOjrRR16JgTTK89CoCuXPx+UupQmT+vCSpFdBAXbNN3LzqnJcnLc3LqQrD7iS/0fLdcT0vcdhlv6iOG0Zbar/JAIWO57h+PXDQR3ONwKyxV6TiU1WJEuh23hF4HKVbqGx8yeY4ZOpMxOhZ3VCVhsqZktx12PACluQj5tkARLUYaiuhr7NTqB7IvaReuF9PupRg0J+yhMzTAWmjxZiGtGQ05u5ppURLljjpoEIiEXdh1sIJNEsfgW157nih+B5etyv+RlAwc+oNg2uR0HhJkN47C/xHwO/I1LPq6+dySsqHBjbbAM2Rzuy69g11sJ+Oqk9064MCvw/mfPxELw+YszQWeUkUmrbiwpoPSICH0VC6AaPDJMBc2BeYaDTGMNHYdMZF/d2dMEUp+3e7d46ZnVXeQFDLIjLHEm8cosPVm6Fp3n6eEVZ5HmpOAaP/FuOztpndss18rWDUWqHdf1E0ajkYdSdu3QvbQGHNDAea6tqKj5+/g+Qz1qBsmdYGTKuG6bTuHTsmuzKtEuoKvIGxIA26zpYZIehrPZRbbJLGVscYvdZU/qjeZ6i4czIprLyBqi5guNGVEgUpm40O05Kw4zs3uKRmqc0cIVIZsi/n64CEiRw5JT5b7naxinWhg36N0/RBFENGn+nStuB3TY7WuTiufIfjedI3bXf150/OFEAAI3M22cDJpWIL/4tKIiu9Ml6rdXgm3xwhbk4cgBZ1YofUZRHG70yojopsHiWzWRrSJm66fj78ZJkmkHpLSzcGHRokm5Z2bWy6B2B/m81wgpWZhz7hbP9F45Xc43EUJpiI+Aa2iqZ5HM4XTyAaq6PukOUuB3W4H7l3AAzbMl9kzUMxl5WMRJMcc7WD6NkPQgZCANNcevBZ6LyeI+5t4ASwNohqWfCt7CgFffgPeQTS0LGmNfH+HCZeq0D9sAoUDGMqLjE7W40t+u7tgEktisVURb7eIDNqa/uearNmyBo26Wc2xXKUmtVbdktvsY4wVbSJDa9NBhTeuqBY+Sq34DQnNQb1ozQJqnwUtcthHGpZY+ZvjDhsA18GB+I5hyM1SbTLQbrJ06zo5K5Sw7+l30l9W9KzJdMU1GtgkJaVtyaG7za0bUqGNKiM+8gdaxxePa1xmrk6YtPE8xaNPxLHk/HEEZ/yCB+dkkHQn656huuz6qm2o7Gq2NAVxcEhDQhTflA0pv4ATQ3xKmvqPhyal3VrOQLMg/gZJqIm79rEkSN7d8p0UcUclz+Cg+oz5VBYBv+XJlJYlQ5pi1y/MuvqUYUGXMzuu5mnYDmLrW43ftXEN6gS/6vGOqCFrG6GnHICG03IJ+Wq7+PdlkzzCo1unQ2Nfv5Fue01ZFx1Q1kwGjQ0+NE9yJzYyWxDzWO/Mh39iMuEC4S9kfp1JiKrIu6+irgjypLVRqw2svvayFfKpvqUiDAnAiEUc+maYeShKKXMQ05WSvv+5AiypS1vnfUq9zbRsujNJ+acyWGcUe4iRKecKQAcGXw2nM1fDQshaOgurVBHDm31oxC3YjuqedE47OYrDiljve5BZq4xkRlweSGQDkdm4r+/wY2vfJ5UFF2a7EmHLsowxTR1CuUVhF7Ik4cHYTK7KWbChwYNTbQOgJN6qHaOz/K1eM6YE7/dF1DN4yoHn3aGfaZMeoOKDHpmfjytIhtJ1XYpfrDwPq+hnw3wi31/0CJpi6S/ayRt3x+07w/a9wft+4P2/UH7/uBuWhfk+4MYpFaFU20gpwWePxbwtIGcNpBzW5JsIKcN5LSBnDaQ0wZyWrxtAzmtH/JXDOQEFh47blSpdLXpE+sfD+wNgVXUdlVR2wmGYG8I7A2BvSGwNwT2hsDeEOyqxiJvCDwxrQSr3eMeOx+8tUjVIlWLVC1StUjVIlWLVC1S/UGQahK48dswOoc+42qHZuhAmk2pTMU8yjKXjri94GTzqy5jMfHuYWL5PkwpHZd8zIB+tt4yFtp+z9C2dqizejsk9+ocxjUnYphl1+nDUV3flsy/NIeya2QZvgGGTRbyaC1/eV6Hj5Qv9POPOZtQHJ0TWHYKm7nHb/OvkOmX1OVkFNJIsUmCo628QKaKyl9gNQO48y8XdeLC0xdksFguLimb3fLVs0m4qmuClewBmtf0AI0UF36n4FqzxU3lVS/lAiZ9H28A2uEcC5hgnDzg5eotukPJ2SNcYYEJPKhyGaBhyymolC4KsK8QqM2i8F6+6Vx4Sw7+I0PlXqB2E7AkSOPiseQAv9cPwMMqDU2/3s/GICkoyhVw/Pj74IRLx5EazVNR3ZLeVDQ4InqZrwLM2YRLfiLFqYpvvOCz7uRpGRZ0pCRyASiVe0inCPb+JLoLL1rH4S0PTrQsXK+E6iOqNJlBe8CoCTNmS3OOHOg+Ui4+ciYwt8j7oJN67ZS5Qzu3QSbmzEv1ZCqfQfmO/X7QoaDo9yMHghy0NP512Gr5hOAWrJiR6hBdC3p3CfTaQPTt3of7QeyDG7yDFiQePasqYVeVKUU+kuuwT6Xn1+Qjadslf8n0rTT9i273gDlx7IxvMvOEiXaQCR6mOCmdz5IbdpirheBhkCYM3DYImIamx1EZDCyjwTvhDxFgUTtft8y9mJoTlfYgt3T6CDHLkigJ9gmfmo0YHNI5e83Q8rzVNpGlGuq3XyRaaGB6KPP3hiGc1ieIfobc9srGjY/XXXB0YIYxK2G9gXUO0XeEmZ8cQGCUuJfscwr0KcF89E82AaCAiyzPSercPQYyW4lIU2Cuz89uZfguyfAtmRi/rY4Pa1PyLXb628C+FmjNZj+N2cwGmdkgs21JskFmNsjMBpnZIDMbZGZRvg0yKzNjG2RmXwu0rwX+lEzrGV8LzMyKNAObvgqI1U2jhn4ZcM2rf3WeDtz0ZUDj4T/PnQKlLr5mIEwrjHomDT8z/f17N6EsW0j4hG85bnJV/bjqNcH1XIj7MKpR5Z3/4zZv+z2ufOLucfXLdY+rHqIjI/IGD8s9rnwh7rHec2+Pz/Ba2/Ow+w0xzXZ4pB4bWvEc1eOqh6Ws0NoxoYVNJbPqe70PARwthg7P+ikjGyRlTeI7ahLfCdXLBknZICkbJGWDpGyQlA3n313E+plQKyjZBT8MNHocbxG1pG7BLhfLIhdKURrI6KKlD9CViss7uKd4r58eD9RNnnSKohu/fcnt8NIOpVwLpfObVuruSX+rO/jvxjyy3M6lUEgWkEKvy4CE0N7yy14k3Ex6mZtEjkayd+S4+tYufXdogvsi2LjlrMWTi/bZ6bvsvVeFBbseLCUshvpeFwamXofXIpzG98CyW5LCFkrRO5ffHxhkd5/4UmMV/ekiTF82jx48NCHkVwFEykXo1egPS9FzQbDFZpED23mKzx/OIvm+YrfdKz4etIy1AIPXaKZe19h2pLuXL18OWOyI2wIs2gCQVa392mumrzVRK1i859ZzKcBSqR8yvsV63pW7w/OkcuPqEB7FbJ7ogGp16F3Qob/Wpe3KPf3X3tkeli9tLbzcJXhpg4SWBAndwY5RwSQbE/juqsczdJF6naUklOmXxqyv80Lmjpj65EoOAmcubsK4jvZf2C5p1TWbpTVL3AlvCV38YP3KbRzGrgwfTfbJKLP1C9syxIr+t0GkVAbN6MBqLlKck9cMTP82lKLosyPxXZ54zXpow4H+54WLPP5QFi2xPoA+XgLWtQfloP/+Ev4EtI6MrIBrTfjeZEMoNFTkCJYEFHkTJfKymIVBY8J9HFXucVeohl1k9fK1BvMwe5cdtAEP/VwpKEfF4LnBttK/5wZklyPZnz4qipF3S6PFtU1w6y6VKXDTLp/80K3EDSPRXhOvn7ckLDXmpaQLtNajrYCi+vnDHBMiYO/0Iu2KUbF3YUwfHLnO5F+55Gy7hl75tIh838egNvLehkn3XBFT0CW6SfMJK2mk6n1jRGmDGOvMFquOyvHp4PL6bRePi/7ndf/i/dnF6WDQvTqFn3GnX3fa/Xane/nv6/f9y26v+z+nJ/pL/6LbOa36Xjp5JxyD2vCEsxs475KLSMOJKD+ePIaZWrAwiYmhmE7ymeStonhI/CU7uFmj5Fq7kmZZN3985Wqic0Wdl3iVR3C718XgWCM2QUosZHgFTmLcICFvPXeD5KFxhNp2A9m97/6JRw37l3qOz7nKk6G3qDYG/V1Qv+oFYonR83dLWMtDVh6jJIbzAE3foRd8ln9Bx3rlusdmJUzI9yj0i8wSWc/Hdaboqt/RLxWrl4GhlHS/pteJn3JaztXpwD5Ua6TsihCHTVOf0T6NYKW4A5swhJFHh0ypM8TMoapyCX+mV5I1aaLiteQQb/3wMgdUWk6lpiAp71GHjRLKY2K+p4yj0CuBd23A39BhfCwxhXhY4pVSJOjt4IEW4ZzMtMpaOg9dxb6hoXo3goV2DEaYKV3Q2La3USuax8fD1dvh2yZgSaWDSn8hLa2pcRWTsNRIwLL1y+v5R9dTzn1/nIxvn+ckZL5bbPCKjWS7qj9X6YzLJDg++Q5i5HbrN99Te3xxqSRkXg0PVot1BRjK0pft372UMGvkTvoc1hFUm9lW9Gvko2XtPMLYDcp4kJMRhxgt5KCBUXWmmWkmhWRVaTBx4rzEbhYBI9n0g5DEgpQb0DmcTteTfD+JIgomwVqyYdiPI065DuB7+gQ9QU6DrMJ17N9UUMhUdOjyYJPjorNkBfyenb4dlOAPNFpHFpw+wDYloZhvA9iibqYmNys2YLAz3HeG5p7Z/jc3ITz7TYTOkWBQ1fbdOlOnIAZuqa9AVgmEH4dhvC0fwLoSXBMbQJLT9g8NrsDHoq61YWXkFd5U4Hgw3C8CEQTiXKRpQVIFtsna8zkPJpnpdNji8bgFVOD/N2XbQ7mrgEhCCqmrOPq4sLYH/5YRbHACqaDvUMosOGRYx4G/vSmcYKQPC+Z1+woVg0wj2QByAywsMOjwTYfgGsYRtyRyg6otCfFaE34HPAGOv7RMwJga1KgykjRvYt9TRhIn0o4S9c/ERRJUROvAMryVrRlGJRX2ttIiIvOwmIww09hw5jD002umjcN8BxXaGLIBbIhQQ9a4Eq2R/+vrjQ99+6L362u2fxY5d24cBubZMMYjyTos2gllbrolOuI2N5DdtbePeWeTQnY2svNMLjTC2cQUX+0Frm6yC1sjRVBGEjdz6++TE1wYeIuKWKia6SryLg1k2/zewyGeCdstswksBXirzDRb+CDI22BTX1/mdeA+8XZdtxu/amI2nASzJeQ0Wkf7SxYqmnppbeWdYoJqau5lxVoT8klmemr4GLUrr5+h0a2ttPRzmghL8ntoGyniDRoa/OgepCNmH4BulWwK+pVeciMugSAJaqTeXkTbi+gdueGxN8v2Znn3b5a/0i3vUyCxE4EQirlMOmHg45IpHzlZyR3tyddDS1ve2hqXC5lQGWdIQj2jLpzDOKOcYqxV4QLA+ccL+JENZ/NXQ21NczN1VqGOHNoCfI5bsR3VgHWIeYbdfMUhedKZ+cbzyAy4vBBIhyM9BO9vcOMrv1AiPwlSI9ShBiNk1UpVOrrvgF5Ia+NBmMxuih560KBxLVAHwA2opDaLZHqk54w58dt9AdU8ru4GdJqvZ7LwDyos+6bdXt12mMbeb6iOSYXpa6hjNtOpzXRa25BsM51auPiXZzr9YpNq2KQa6yixSTVsUg3Lur9qUo0SH9Y+YTJL4nfOh5dzzmJfanQScqfhE/uSkR+QsmI8RGMY0/HiPnI8bU5fxY7RG6DGkpN1uOzgtjmvXnPJS6pszmks3+F4nvTNbCr150/OVKf/IV0c5eFKJvF6Nw09WTi7RCsRma5C8LIh1JNZjddqHVYIqZWkq3rau2GVNFtiAUHLxITqKDdqkGmz1H9uqfgr3yBpS5D0LNRGD9l0c2NxWXb1hMrMwwtotv+i8UrucdCCExiEuIGtomleIWXrEI3V8fKANIdmXcFcdSjmspKR1AI2AarEbD8IQe1Dn0DHg89C5xB5omSve6snO0pt6/iPwqt0Nv3OT3JjY/O9/sD3VCuAb2mh3g6YTPrKYml2wulS2btE+lbRKrhc1aSfpUAvu8RZcL1L4Npeo1XTJjZ85WFA1xgLcszPP/LAfcf1svxXGEGA0kQKT237VhkBtWtIHGpZYyaLiDhsA196IuI5hyM1SWSyLuNQppf2dImwnnIMgdA3DunZkvce9RoYpGXlxRje1ChsAG2bkiH1YOM+cscah1dPa5xmyYrYNPG8ReOPxPGk83LEpzxCg5x6Y+6qZ1xBqZ6y/UHcuClT6JI7pDpatHFaumJDVxQHhzQgjC8i10/9AZoa4ssbU/fh0PQCWssR8AHSn2EiavKuVDk2bbEVP+Yd+eyb6haK/xhQ3L6pbt9Ut2+q2zfV69h17Jvq3/EzV/ZNdauNW23822jjO2LZs2+qf4031TO1sHvcY+eDt/ZhBatO7qo6uSOc0D6sYB9WsA8r2IcV7MMKmaU4CdwY9Plz6DOuthdAB/J+ncpUO5JCmUtH3F5wuheuLmOVxl1SGvEJBzOqxksi30JgC4EtBLYQ2EJgC4EtBLYQ+AeBwBaY7jAw/S0ZUbpcCpz8IUK+re/Oz400pWv1+iHmdrbM4QD9glz8cHGe+vJoAhdhEjVu/ykaiHfQ8U659wjhdXhUx9V0cM7GeCqm6ZVK/opFviSlsRYlzsDfTCql/JdwGu/B5864BrszWkhrkQDUTqoGWjGkrkKTQ5N3DTb0rzW6LjrYVvgcGiIwh2yWUoXs9XlJUiuQZtVTiAs3rzrn5UnT57mjCsPupCAft5TSs95tHuyyX1THDaMttd/ktVvHc1y/HuzuYwZ4gRkcrii9DFWVAJMQrCPwOMrITJV2oXpzHDKdrg8fvGioSkOlyVDyQza8gCX5iBpKzwkWQ51mx9e4XvVAUQ31XmHrZVENCozP0wHphDljGtKS0Zi7p5USLVniRPmGlF1f+iHgMPkR2BZ6jii+hzEs37XHSz8dVebxIp0QJ+iOXCMQb1XyXZiz9InIJY+D6chKWPMBCfAwGsrXGTCPfeDGsC+gcUSyoEWIsjueopT9u907h1WMEpmDSsRORNmkiTcOMQXRm5zb//OMsMp7THMKGP23GJ8F2LsEsG2g3w9sASxsA4U1Mxxour2s+JiPi1CPsvw2SAHHBhcBVk+zeprV06yeZvU0q6dZPc3qaVZPs3qa1dOsnmb1tOfS035YPWm9OmGZ1s4xrRpJOjd/FIhmQGLdemj2Uj0mbho1aBxro+XqBLXhJfWSqCOTytVZgc9+O7X2FmtvsfYWa2+x9hZrb7H2FmtvsfYWa2+xqou1t1h7i7W3WHuLZVp/sb0FjSamVULlFWxgxFSD4es/W9lhzCa1DWa9iWWtnWZTG8zhRkaaD4F75zAMdNFpdm1wrDXN7KhpZicggA2OtcGxNjjWBsfa4FgbHLurcL8QHNuGM+lGrH88sOjUolOLTi06tejUolOLTi06tejUotNvjU57oTOyuNTiUotLLS61uNTiUotLLS61uNTi0m+CS3NFqJ/sAbQJnIuOfLusaqpTDoHlGrFLHee3TMmTUb0syLC0iB1/jg/xgqgLocohbMoYWZdEnVoKi/jDfPKMNJxDiyyhJpeQIT9OKkkRz0yHQAfmjchQ7+VVbq7VPern/NB1M06ANXrOrE6PsnjVsIv9lbSWpSW1F3Ln4rR92X13BkXaV+3uefv4/BT+fXJ6fqp+Pr24eH9xegL/6r67ap93T/bKexb2dXMgqcQdXXSfjSLyipWjVoK+ym82m4sD01N6CY1lwg7rF/2MMhhAkSOf/wRRes6DGXqYv37xX78WHaxJUrm+Ey1qLLspRrL5uc4d7+s91En3NEAokHD04kUFBasc8CJ+5wrlTGU09LKyISloLoG/VbZF/vor3LYwwsAXS6s/gy+g77jG57UTA1snWmhkbJT+Z1VhMb7hvlNRmuYK1ALAfbhrP/3v/86/nEXO/ObxP/7j0/9rff6c/fCfexUNA8RO/CqZk347J/gqn0gzB3VUtd0SzzvH52OXvIwh4mQEk7jkI2xs2Aylnl5VbWzQkerOndw4/ShELW2T10GVYjTgoG3FG1bEbU9BSFvVRhjqu3+S1CvPR9XMmzUunWjGl7xfsqFX9nYe1akenL6nWknL5khhK9Furkbupb9q+n99XcJbH3V1VFp45I7VQ39TF00qQoRjlySgimcDWCaHnwfn8iDlfjqhbkbqjF1wMQddQIKsw73XL14RXM+R8h4gsQRDQajikWAiHun4jBNQ/RckSI856BNRO8H98onwms/jmxBGvwdbY49YBnza05aNL5465Y8tmDhH4PbRvt2CWkwiD8prc4kzd5vy9frUZlLWtekL6yvNgHWwPGv3uyRtNbkD5GzyWJpEp4uEPe4pBkgMgwrBL/Ifb/XK/X4f0zS4wTSk6votFkkFdruOQBUAI1RhehJzTJwsP3hzyMCVXY82zjT8P9kHVDYwgov6edn8r380X2gh4jtBps+kO0BbCYzZzxH7hcghDWrvgsNu53dcPhc94XDEvBSh6Aak+UEZPFXj6a5NH9KeuXeg+A/16g+Nx7tjEJVoB3OJOdMMfFHb5pM63lD4ja66R+dZ0v5Zmn2w4JcvI/jtQ+Q9PuLPoMpHcoeCFqqckemR0RXDXXX6ltJ7y6Gb3LlP1b892n9acdqQmH31bOrkgJ0rEzKxnjo0af4fLExiNK3pRBLGQq6LbBOIk5/b4zGfx0ZFshPIAJXW7wKj+s1TfnZ6uUdPfZtnqXB2TMidJwpWjUpc4kvUsHKaRnqZGgl8fPz/pcyJTA== +api: eJztfW1z2ziy7l9BaeqcE9cVpcSZ3ZrrT1eRlax2rETXcpzakzPXgkhIwpgkOAAoW0nlv99qvPBNlETJzs7YwYfdiUUCaIBA99ONfvnaknghWmefWwGWWBApWr+1WwERPqeJpCxunbUuieSUrIhAcklQQCSmoUBsrv80zVAqSIBorH4McRr7S0QDEks6pyRAs7V6sKArEqOpfj4Mpp1Wu8USwjEMNQxaZ60LKuSFenyue74mXFAWi1a7lWCOIyIJB4K/tmIckdZZy3bWarcokJtguWxV56C7REJyGi9ywjgQwMkfKeUkaJ1JnpJ2S/hLEuHW2deWXCcwgm7V+vatnQ16x/itSLBP8nH/SAlfbwz8yb6I4jQinPqVwTcGo7EkC8Jb7dac8QhL/dPff259+/Yb0CoSFgsioMXpy5fwn/KAH35ttVs+iyWJJTzFSRJSXy1w93cBr3zdHJTNfie+hCXm8Dkk1QPopYV/5Wukdgrpc4IlgbknNCEhjQnsm9290QD+P8L3FyReyGXr7PS0XV1iID1KUkkG8QrejtMwxLOQ2G+Dw/DDXH393WP5nKhlxqEYBpufsvqV+vnrhe+D5owjQw8i8YpyFkcklgincgkv6WXtoEu9OgKReyok7DA/ZGmAEs5WNCC8+49xHxVI6qAJIeizXsTig99eLKVMxFm3GzBfdAT5g3DcoaybhFjCfvBwQru+aucV2p10YOkYX5Qmu3UrwT7CwYc4XNt1rewhvsAx/aJmV7Nv0Qto7rE4XLeRIBJOt1gLSSJNR/FwPAI1u47QPlIa7Ll9w/frNkCYLPEeahYkBsammV+RJs1CSlS9evlyk6wyGR9j+kdKEDRW+xLYac3e7KBRKiTyWSyokMClX3mvXr4sUdxGARbLNmIcpXFAuPAZJ8hfYo594K6KytLo5SV8uZ/a8/wvKynqicX3NEojFKq+zxD0XaXE7v0qGX/bR4T9craD7DwC4yVxGgE3w3fCm2Hpg8yAf6uT22q3FowtQpI9Mn/ap/hLyvOH+i/77PYX4WU0t1vktvTn4pYU/0wXpT9FmPKo+EMo5sU/cSgx5cVfIoZnpQbMx2GpS8VEzOrnD35TvDae08WmDBlbbiMS4tM59ZF+M+WG4U0kT32ZcoADCYkDgZiW/IKExIc9b8eBpd7NqoFbnFO+n0kDH0AB5cSXjK8RyHl1EoRkWqrHkvCIBBSYKvQ6D9kdmtOQmH3EyWUaT1SP+0frBQHCSP+C5BJLRO6Jn0oiLMqJ554BOuathFM4mAzReMVugaT35F4qKhLOfCIEsax/zAnCcYASJqTH09h00UAAqF3W1QN3cbDCsU+CnxJOPBwHnu3PM/1pjgO/Ps7U8VwSjnAY1kwNLfFKH/OQSBL8KTMtMJfCPDHnGKAZlSQS+2GPZdC7V2lQkAcrzCnAFMWeFSErHKbHdqLaql6WBBdF6IyxkOB484MlSQgAm4q8E8nUJs0+E3SFfmezTgFkPVLXlrP/zmZw0r61S3BRraZdEACJVAKea/UVSxnEq2vT74bUqV0dAcODpDensE6sKClrqOtnPG7vpqfwTxwWJ1bgejAugOm12diVtxSjOXZTW2I93ZcHfekNHVAgMqIxlqwBj7ScG8FrqNR4EyphUNlYnMtHzb0pi086G7DoWx0x5tys32utqPy83YpwkgCVILhLYgrmYbbBiOFZeaFrJEZT2N9YltSBOmgMTDsTMUdIjcmPKC9qJ/1XlxSPzx+M0q1617Q02orGNJEDG8A02RB6PQF0QbepIPx9I+n0URCe6QqTyT8qOqvl4UoxDVMhARSDwGFCNhvgH0xINQDjaDhGOAg4EZlZqNCvljwxC4jZW1zu1Qpfn25ussk/ELQ1SnkcA6eKF3UTQedkjtNQnqHp6ek0E6T/NyVNRLJ6LdezRDqLqNRD7ZOnDx5hm0gFVnqvmk3oF3LM8llFK06jGeHwmaBrfWZ9HKMZQX9A/wHCErGYIEmjHIP8k80+qJ7EQQeF6TaZvmrXTE9ZCLutgYnjBZbkH9vG2gZPhnOkdPa8azsm5gRl/QawTUprWtgjcxwKMtXAxUql3kxI0EHfcRoYDgHWv7K0OVA2W2GpAQxI2hKAMTCioLlVBLBDt08b3X779g2U7tzgUEBBvU8T9AZ+3AuFyh8TdF+8IFfqpbrPkXDiK0ut3UPAIznZZhTdeH3FwjQiosF2y024lU3wZoJML7C2EUtjiV5odnWGpl0QOV1Q5s+6IEExjQlXf0+PQsAPP2WcLIzRaw+j+zRB+l10tyScIE4ES7lPBLqjYQgsVVtqA/SCdBadNpqmwiNYSO+VmdthcqO4SfRsFMtW7JWncQwSJBMYAeyL+OCe8x7PL3vvBu8zQ4pFosMwTOFjmOdNwZlIE5DeJLgRbC7vMCddTWGXrQhfUXJ3UiB7GAsJIG77vi7tsP4poqaFVnzq6M8+wvxV5/Q+xHxByl/hn2x2ycIG48FbqHf5HrbYguNYojmNibfgsHcDNOyNUEK4EXBq02+X6xm+azY09M3t8DDLQX+CJBa3FaB4AN6p+/bbeatBA99roXYw9ZCO4WZvvwoMdkHTFcytfzHUuyMMNfTNDAeG2WR3FrVw3RkOfwjDodnX/SQVx8Dr9xms7o8/Cpgn8y3u3HuYRiRifD2aHYXrVVs7IGzvree3DfsvIgs8W0tjEneA8kkDynbrDq/IIIY/m0xcv4k+f9LnzfC/7ScKej+pVZXarXkKTPv08MHfqobKXGquRbeOr8c4KVywVyjfQlu8iiMy0dD4YALfX49IDicMwC6QsEm/tviwxTvO0qSB7RHY0yclcS/YQqAFNLNmDT0xFLKFeE5mbP0lJzFOxJLJJpp9ZbtkTfdslu4ipQHpCvv6yf4vN2d8QTYvQTUmegsPKytoTAwd9LnwTtM1sxexJF6JbqYL/oRTySIsqe+VxvLYXL/gZcrFCTLvGoesTa2g5KkQa7OIxnbleVi2o/ZeQJKQrcvYw7j2iP2XuHILULe37JPxh6tWG5D6pn/ZsAjdO2g66J9ODTkCpbG61uVpIinsBxZ7AYlgVkXULzpoCkPk7cqtJgmT+cvoRcjuCBw3IfX2jGh8rOQf0VgZ1pTcVw4GsMlyX7ht91MRvj96SGPLO3TIRZIezA3fjT8WVllhhpnopZJNfBxuk4hlK8JWm11GukA4RmAngJ3tkfsEx4EaPaDidtes0Hsm1QOsv/Mdlcttx5wWdMqH2DP6LIqwJwh4IwLCC42fDUCwO1Lel2pL62VTCG0ioc1iveuovBlMrm7eDuG42H/ejC8/vLscTCbD60GrrQ7TTb837vWHV/+6+TC+Go6G/z04t0/Gl8P+oO75xsk7B2fKCE44WrI7w0W00USUz5eyn2LO14ilUjGUTN8sCeE6iqeKv+QHN+8U/prupFm3LR9f/TUjvNhqxSp9rlRIFqHeaIiG5zCNVGgdVwsvYHgVTqIcqGagfCjeekHj9N47BU3bA84f0S9w1GB8reNEBPxfi1vU8ur/Empc60VjnGeGc8TA4E+CtvGWlURIEMqcrUiAVtrj1V6l9CL8hcWV4aHbondibnqi2hVXo+rEb7JE1+M+rA30FxNprkFVByKdxUQ+5LRcmNMBY5jelKIrGExbLX1O+5yzCBHsLxGTS8KVhxosgWLmMdFcTBA/5VSuFdp6DNJshwaIDc8VhQEBWwWos0S9Naec3IH+ylPlhKAuTlgsOQvVLOyXgIsuJDmez6mv4YW4H4HNc/93eDu5Vx/hQplojaU0YdSw77m4b3Y1V+mnwAhzhWsu7o+9StrRvaBf4Guhd2+s6TZhgnyIz0lIrCdh0xudANpoeFMwrC5JXItzqDAN9M4n/umvZD3GTS5g4evdEnAoozy/LvXBNpFx7rs3qX/7OCcB5wh98hrNdL9mPGr0xW0SnMzEm5D5t8d+utwWX/1UGj3vhge7xboBDJvSF71YvdIwa0aDMeE+iSVePOgW08rahFOfqEUty4g2wgJhMC6awSwzzaWQbqqNJViWJXanChiVPT9mSixouUEClMaShprvp5zDJhTQSndMBZoRANHKK1ILABIoyFkgqyg6X718+R9afSVzoV3DDzku+qpBoJjcocHbyQb8IfNGnvAD68Fe6QMNz203DblZtYMCO4N9V1Dic7v/4daER7+FQOadAlW9iDZZOgMxYEt9B7I2QPgbxuSxfADaanCt2ACQnPXfLnAF4oumhgeDs8oaprVFwi0FzEeiPIZHRwzN1rkC20G9BLyJc7PptEuk3yW+gP91dN9TvatorJGC9TJRDiaoF0rCta8GFfrFCK9BgKSh2nYYRTicp7Fyc4MXy2p+jYqhrCT5BEoTrHxgfCc6WMG1js+irkZug/6kqyFeNyArEoLarI0UxBee6tTo/J2ljEJjL8Hc+kM0PxOXabxpwAQHv7e6t4J9ScC28nebtRQ8LzHCXGODlYtYQMJO1jkVikNWtTFgA9CRQg1550a08ujvPx986HuXo7//jF6843hFJYuLZ6MwH01Wu2oybGtq6nXEY24fh3tvHsuuJWqrZT4l2voUXFqEc4gZPkcS44IxxtxiV2P4LIKyV9KzdWnr586hJ5s2aXMjnt+SgR9DKSKi4MrwTv2OlJXzQG+Gf/tVv7vZe/43e7tudp+Jdd1d47lrvGd4jZdwBju1CfYuCR3TzqosTf25Sn0Yx66C4xaobByH1nXrC4sb7PRSn9BEgSIjLbaP4eHpSdlQGOgFypxk5pQLqXs0vakIzxkBD+9QGaWNtUwBvZ7vg/o1iDANGzj060ZglFBKG4FmCtqAy442VWihVjLJHgSbRhiMrwY12SWIX3nQR4B5oHzkSkuA7SJUnL2KFs/GZuHhuTUJaEuuMvdZJ2+TkiBeFJEwSBnjR0QCZBW1TMW5HnXQ54+zNJYpuria5IdBMfOORktKLTCMQ52SrhpddJnwTGKFn1LVx00oxQky2ydJZyEEGqt3lWdzpjF2AL/BLY1H9BEuKnIYfT4nJEEXBHM1uevRDroCQhIvNK96q6hI4E8QLHRjLNPiRMUOmZVTKL//8bxXWSEqUHapicNwncWGdtAHa8duo4niEh67g/srX+uQZp7WiRKvMFVJALT+Nk9V4CknIcGCPFiNKO/hx7kimzEmz6lQZrp3R7n1QEu7QWeZsm73mo1eGsQLGufOCh00TYLsAE2zgwGnCAK9waBdOkd/e4nevbEGweIx+hOVEs0qj1VKipHYRfdq+PlpqCTHOyLuR/UOKjqo+Dyh4j5F7mB4ojnG9UgbSC0+mRjeenN+Km5Wrw0U3AYw1SPN4hq6hulRbaOCZ9j1yLqDqfvZRre6lMsUh/ZKN+/VwGKRzrLXG5m3FW3FVranCMd4QYKhyoMi1006g/BEDwtBFyD3TQcmk4pcb9BaGaEfUhI30gtG1Z591dTa6SuJfIwf36fa/DXbwjfZAvViHK4l9QXKUt/YESIWU52fwvZ+BYei2UWusanLjHMCAioNqK2WWOI+C03s9iAO1CXL/u4hwxbys4aImJbaPcJ6IJZ7v0zDRstS7Rtuze2ahGyBOEulXZQHoI2yXLolNZ4122VN0So7wklnEEu+vpmohx39n5vNe9yHoRbrpl01phazwmwaU9/9OsguOg6IlTed/JrOlPsEkFwCIs8QBDmb7XOw2YLVgjTYaaWdrX1xkhDHBH28vMiEtiVwzVLuQXImiDgEjdeIbyHCPuFN8hxMLpAPp0L5cimYVxAgxEYVxYblKcUYfitSWYi1B4auZMVB88xaKVaapTnKw78KAMnoedMipJ2UDEIHDS0qZqGCM53dRp4JZgffDOM9vBFvXaIKUPfjkmS+gAXhlm3C5jXnfHPRsox85uWEa/fOzSveZn7dt7+In8zAXqEvs990SEE/xDRqhgPGYHcRkFziWunqqqkGBOoSHQs4jtp7U3e+ZXO0kTkTEhygPdNoanwelVcNml4SHHziVJIRjtdTa+6LbAIHM4LyAmkWkTfSnh8Ql2dMGkk2IWt98NWUtsymuHu6GdGaJQZ90D00uK6sGguQrx+ihIXUXxu+B7fihr8p1Jf73rL4RqRqvkqQ3uE1/CMmwIx+20w3d+9BQ2+FVaoN0aQHI5LHGd1jRZk9CmMWTBLiP9DdImFBFhC8JRTMGlxZQCZKRDM+1f644LkYU7meqiSCEmI1ZdErFrRvGiBDKfpXb3QBeVVNPjghMVeWU8X9puD5dDYtWqIfZ4Z1LoCWFyQs+DPm5ywrT9yy8r1CQBsFVP+bYkA3Q0CfxRV45bsb+JhDu5Ky9aencXEmXseIdjGiBsbMpnfaV8uy8cBcOXsQWeGp62OdW0E9bQZGq12quTUxD+81Xn8zKc5r7niKFNa6oW1k1DGWExvTpKHBX9zskRmHDvMryNj+C71eJ4r/65mrLF/bvRh2sSLwZm9wOj6KanzlI92BVpyUlVdyKeipPKCfpOOiBa35+umV6o8/FrIWK6Oz8lA4wp2hlshaJ4efzXd4JFcXIZbnmESNAm3M7QwEuwSqjQkDnqWLRRb/JZbDqByrsTWhpnUt1l4BNo5Gd60NydD1iAVHeayfQ2MUggM1evHSe633uOQshZywS8Yya7LPkvUDiIbmgO/zvNGpIGNOV1iSnk5y2PBQJLpRITsigTzZ4Rq9iBki9xDThkM0HBujV4hnJDzgTn1vxNG2SFU9UIbT4B/6CGRxVh1naP0xDK1O53myOk+7Fc/FFaQxa7BF37+dIK0VIama6MyjSwzpH6yVzfTZML4Luoxyy95mSJfTQ564HuJcTepoEwfeVkxU8OdaRZLXudVmmZMh5B3ER1zn42dd9iSzwqWY2ZATn0WRDp2Dg51wFqT2Uj/b1Vnma+UQ0sCDZNzPvEeyw6SD+Jt1MMne1ZcVBd/n63G/KAqykCsSATtscFrtsipkYfJQz9MwXHt/pDjU0baczAknsQ0R/nw9KrgOm5EaO+qahp5tKE7aakKQEEPFKtoHZ93uFG6Q5vS+Xbwj28sC/slm4kdYiIbMaourRF6k56ycP/dJuHc+UjKBbdB+a0aBXXmBjkh4q1OPntZot9UUt4e53W2mcrX9ytcdqO2TRt81LACMW01TxWxmcrGEfDZe7RHcLelcp73R8OgMYernn4wPnKcDjD1jnfDU1Dwc0ZPc31uZZFT3MK7Ovz4jOvOAwtVA/T7zj1P/nr/690wUIadpOE3jGWoa3yml6EOipTD3l1QS7QtRyMCwkSwOWNdGsvMHR1dt7fnofE/lGjlbIhsfmG2lBGpmpVsNm2ylgmh0YNZ0kbyeVsKzwNnYwIwSvBpzBluxxxteCk6H5YZTlafdjqBzthShGENYCKAD6/zzd0vY+MbJyESYZWmObFifDuHLkoaojHqX77XrDIlZulhW87/zNC5omU0Qm9YxrWt5nqkkxD5RDPaFoDFcmOgurX/pI+WQm9TkjitmhrPqbyGd2JONravUJi1oXxN44oq4PWkU64q4SVfEzRVxc0XcqgfFFXF7XAugU1aftLKqi7iVaryfuVA7ZwJ8qiZAF2rnQu1cqJ0LtXOhdi7UzoXaOQjtQu2c2+mjhdq1cCgx5bWqUk89QuM3E2c5ftLKj7McO8uxsxw7y7GzHDvLsYO9+yzHoZjXwqHhmxG6mLx1WMhhIYeFHBZyWMhhIYeFtmOhNKbyLeMXNKKy3lEvIVwbe9Q7NQuo37nC4vaSKDNG/TsOdT0D1KXrAmwkidE5rdXP7p7+B4BnT/ievnGQnkkhvyiWFoKIvFRM85wPY8Ya1AHSWUESxsI9lnUo9AJdVrK7bC8ebP2gN68Sy/U4i6ASrkVRfgo7pfqF5VIzthiuXoxKchMUpDDb2ost1dDcVO5mAKvowEICKiix6GCfr+7mlViRcNO2KKfzOgQ/qzoEWj5E/cql/hEXKtejjAsU6fsEdbdhjYWPQ1g8KpApONTWrJzDFxYQZa4aRxsgC3qWDAIH/KW5OmWhAlwLzu50Wc5KwSAfhzrm46Uu/J3GWUQnvDmB580jSaCJZ+m3+7kwydaRFcvPdaHyN0aK6E2lJqeI3naHWqlYngXqXJLFMHhYbLAN+QEuICQv1VOoVCPtfVF0V4qSSnZL4nMrC/fucfumVXkmvQlSXRSDDyznKNW8PjXOBXolIAD+Q9zP/AU2uUOvtEGC4sorEK+5+J/scQA3m1WPA00q8MiNGe6DS9unDJusZs710WQOxz5pHOuCJI+r/PMkLtUPqnATp6Eqh6eRVF1wny5uiNHnjcI6uvzNcZkIchUqy0Vg+z1BWErsL/PK7UUAA1yvnUGfbD03fDpZqZWqPp5lpmoUoKbmYYmuDVTTYYn9p+Ga3TjJq87oldlHDfrX+zerFIny9B0CfYZ6gBwJSRL0M1oS3nhLl/aEfsszv/2kpb0HiUmKv3sF0bM/7egjZEA2bq9Qg+iSgCGastiI4gPsaICeOeQcwWCJhnSQypJmQJsRu6e/oACvFUjVhyJzC/WZkN1UZInV9if1dRL6SUvoJiyK3NbHjfRUUhc0+HXi6jw5o9YPY9RywScu+MQFn7jgExd84oJPXPCJQ+ku+MQFn7g6T67O04/BiB6xzlNu22sdU88JmhdtD7am0556TU2KPh1T0yld1JtvP8Z0hRE4otm06M5b+ilbLpy3tPOWdt7SzlvaeUt/ZyTqoOKThorgwwztWUwqVz4A3N4c4b5sDG7bXRg33DWBRfKtNRQ2Xtfmvoe4sQ3eTIzRUN+uKuPiC82twD4IEqcLxsazbuYkov425v6/7HV9oYzGHdy8FzxTVb7kGcnc5rYV1ThMbBQ3iZ6N4tiKu1rzYSYvAtgX8cE95z2eX/beDd7n1YkMSBuGYQofwzxvis0y94UbwebyDnPS1RR22QrsgOTupED28IHFRurozz7C/FXn9D4EX4vyV/gnm12ysMF48JZKgC0ZWnAcSzSHCh4LrkuEDHujajrs7WI9g3fNhoa+uR1eF2+ZIInFbQUnHgB36r79XvPX91qoHTw9pM1uL+CtzHsJygldDPXuCEONfKn15TXM5oGeLO4G+zncYH8vY/LOPf3vtSW3N43JDk8+aTzpfIm3+BKv4ogYn9ODCXx/Pcqrfec32hkJm/Rrg8/3KfLyLK577G6ZxDgRSyabKPaV7ZI13bNZuouUBqQr7Osn+7/cwQFsxsLQQZ8L7xxdFU57YmcRU15pLI/N9Qteplyc2OgqIjKMU9YKijZtkKBgFdHYrjwPy3ZMwfgkZOsy9jAeQWJ/FJ3cAtSto8Zk/OGq1QakDjytgmmL0L2DpoP+6dSQI1AaK/ddniZSlUBksReQCGZVKlXUQVMYIm9XbjVJmCzWOAzBnUZ59hqvfRofK/lHNFZ2NSX3sxI54Ku/NWTM2vOOHtKY8g4d8sFlmzRmmInenqC9shVhq8kuI11ARSGwE6jQPnKfQFQkjK7qK+2YFXrPpHqA9XdWTh5bjnmxgOX3KNmpvLFIgDa0UVOtCxDaREKbxXrXUXkzmFzdvB3CcbH/vBlffnh3OZhMhteDVlsdppt+b9zrD6/+dfNhfDUcDf97cG6fjC+H/UHd842Td07AMx5OOFqyO8NFtNFEbJYC8zHnawTVYYGhFH3xciFcR/FU8Zf84OadKv+enTTrtuXjq79m00qgxi2paTHQomdRrHjrBY3Te+8UNG0POH9Ev8BRg/G1jhMRYoJl7Ra1vPq/hBrX1NPS+Hyz2qiqvStBKHO2IgFagbNdHoRpXcpLw0O3GjGURxSlcqmrxG+yRFAf2tTdMnWuoBZYKyvf9ZDTcmFOB4xhelOKrmAwbbX0Oe1zziJEsL/URbTbyKgyipnHRBq/tEeq+WVJEzW1vxgUZ4OLaaj2rd6aU07uQH/lqQpmLlYHg1nYLwH3XEhy8FrzNbwQ96NmfrJvJ/fqI1woE62xlCaMGvY9F/fNbuYq/RQYYa5wzcX9sTdJO7qHUnimEt6xUdiZdDARstrKmhlWIRK7QRT20XUEyyUEM879CKWe7XbLi79tr/K8TYJDAcOQ+bdHVzDMbPHVT6XR8254sFusG8CwKX3Ri9UrDbNmNBgT7pNY4sWDLjGtrE04tbXQSzKiDU7JGIyLZjDLTHMppJtqYwmu1JzuVAGjsufHTIkFLTdIgNJY0lDz/ZRz5dEKrXTHVKAZUdGRS4KygooKchbIKsXQv3z5H8YzdS766uLgkONiU2XE5A4N3k424A+ZiyayYHBPhbqJrvSBhue2m4bcrNpBgZ3Bviso8bnd/3BrwqPfQthAywJVvYg2WToDMWBLfQeyHrWS6ZtS8dJSxU3RLnAF4oumhoed7t9wSwHzgagCjiOAnXkZ1EyB7aBekpA4yM2m0y6Rfpf4Av7X0X1P9a6isUYKmasb+JegXigJ164aVOgXI6zyZujC8gijCIfzNFYhP/BiWc2vUTGUlSSfQGmClQ+M70RHl3WHcKWuRm6D/qSrIV43ICsSgtqsjRTEF57q1Oj8naWMQmMvwdy6QzQ/E5dpXONBzGL0VvdWsC8Z3/udxhEduV1khLnGBisHESZhJ+ucCsUhq9oYsAHoSKGGvPOHlzAuVC0ugPd8PpqsdtVkqBPUbNERj7l9HO69eSx7llRStPyJZWSLW//gMrJl3wVdkfYvHqX6SEBumwFgK5rbZZM5wtlAX/sWlfNt7gX0gdfotl/5ugPx8ylEYFYqXJvgwErDohLaWFNXDswN1fRNLdoS8lnnhvAiiBPS98y90fBo66z6OcuToZm7F2GgiHhqah6O6Ek2Y/RREFs1uzcaate3GdGoT0lloN7dOLsb52dys+OukN0V8jO8Qv5O17kPAbyY+0sqiY5rLaDfDUM9sK4NR7MHX/5s7floW1s5PEGHrSuR9IiabgnUzEpqr1V0K4jmby/RuzdoukheT62tjObKqoEZJXg15gy2Yo83yfEEWu2w3HCqfOSKKUXLUIwhLATQgbXv390SNr7x+FTkp3FmYmpb9KFsVpnCpm4zLt9rnYzELF0sq753PI0LRv8miG2i3rRGj1xLDLFPFIN9IWi8gEOqXrS5Qh7Jfj+psdsXrfLmLqNoyv0TlS2tIT1Y2XKZz1zms8Y2YZf5zIHBR858lnOid4wBa7dOAzqXx1+cH1kn2f1jmdlprp351r7QS3Ki5F0hXXHBAAM3OxyH1gSzi0/AdVGDPaAsCpseEABmzqlQd4HvjvIdrtwCKDRU8iooD+gn6bgYzN18/fRK9ccfs49jXKCUGaWZdWqkX86trBtEZl8hfuUJk1jd+9l8h4Qz2IJNUE2JdNPOXn8JsTzHJGp0k21ANIDbQLUxfnazdLHIHCzEchiVL0O3BqxbZUK7nljcrLvW1mvoupK6v/FmOIfGKIQbCvTipfda73HJWToLiVgyJi3NPkvWDyAamqvM7SCPbFDzmNMVlqSng4gbHopENypEHxOBAFWhFzFD5B6cRnCIhmNjcQnxjIQHgLujLcF6oMweA/+o1C44IrOAs/I9RSufS1L0hG2b8VxozWT/DN6/nSCdxghJrcyoyP4lBv9qkaW/Vn02dKCALqM8Fd+mz4RD208abTvTaz1t4sD0ohNl+lorV81ydlESYRrmmUnApxTEh5aW1oRiMhDZ+0PJrHAphg5z4rMo0r4pcLATzoJUp40tnMLsZkcZnpo53lorVXaYtK2sWQeT7F1tTAXrngED1+N+URRkPg0kAnbY4LTaZVXIwuR5madhuPb+SHGo3dk4mRNOYuuD9/l6VDBbmpHy/aHYb2eh4LVykDFnSW2crm3o2YbipK0mBB7nyhnIPjjrdqeQ8nVO79vFq+K9LADq0vwIC9GQWWXa8G4N/0n4djgs/fyx9C5byjNBnA7SOUj3DCHdI1nfml4nlfqolNDcNNF+YXGDnV7qE5oUwdb2MTxc9ZkzQDNLdzKnXEjdo+kNh8kSz4gqFadsSjWweADQtgF2qUXEgBEg+cq2O/fD/AZLltk6G+yr7+o2qItkqTAxZWNUgVs2Wx+wRaziGQo+zSBlTEYYUM6Ny30GIa9HHfT54yyNZYouriaNYRuMLrpMeAGRmIbip1T1cRNKcYLM9knSWUh9Tam+jMtuNztwOQwuF54pyFl0ycfo8zkhCbogmKvJXY920BUQknihedVbRUUCf5phQW5MjKE4QfCnWTnlG9D/eN6rrBAV1YKeCqIByR9sRKJ1O/DYHbhc+joawMzTpsPCK0xVyTPtiT9Ppa5xGxIsyIP9Y8p7+HGCnR9+yQIt7QbN/U/sXqsoobl76zQJsgM0zb1Lla+HDk0snSPttFJ2V3kmHg+utrdTUJ6IguJqe7va3q62t6vt3eTm2NX2drW9XW1vZ/75Ecw/z8Q462p7P7i2d1WtexJ3S67+k2P6juk/NtM/2M6caWnKW9mqzbmadarUrN2auHqkcXbD8D6rqxtwnkf3XY+sr5tywGiUaI1ymeI8MqkA+a3rR/Z6o4wzirZiK9tTRVQ16QwKBnlYCLoAA+6GVKrSeoAwrF4X1Mo7G0VWLlNkYzE/MX6rqig3GeGCLVAvxuFaUl8oLx5dgNmMELGYSsatO3PIFldwKJrlVjNpbmTGOUETLw2odSUscZ+FoS4tPYgDlfeogZaGJUZ+1hAR01KnQrBRpOXeL9Ow0bJU+4ZEdnZNQrZAnKWZj/cDzMZluXRLapJdbpc1RbV3hJPOIJZ8fTNRDzv6Pzeb2vTDzM/73GCGb0boYvLW1ah70mZlV6NOuhp1rkadq1FXPSiuRt3jastpTOVbxi9oRGW9KTwhXAenqHdqFlC/c4XF7SVRQRX17zjF+UkrzlANr5jZIEx55ECWA1kOZDmQ5UCWA1kOZLlCwD8G9Pk1nan6FmDAehqJnZyn44/t6ahD3fdPsbSzdVq2JMQxQR8vL7IrHEvgmqXcu/1FeIA9wJHdXOYIEfYJbwI/JxfIh1Mxz26ry7fXuuxrbAzgyt8dfitSWYBAyqcIbg4OmmfWSgk7G0NcgG8FgWPct6dFZjU5MPy5MHQ1/rkmJNQzGAOKZ5jybhtisEQV8NPHJcl8gSwztgGHsHnNOd9cNHue++blhOukK5s5+Js5Stz+In4yA3uFvsx+0x4N/RDTqBkEHkM4hQDMf61c8FVTjeuUSwUWcBx1piyTXK1+c7SRTbkNFeo802hqnE9VAnM0vSQ4+MSpJCMcr6c2iieyuNqMoLJMNCuZPMqzTBjUnmQTskEFvprSltkUd083I1qzxMD42W06Co5ZgHz9ECXKC8/wPUBvf7J/4DijO/cP1E7ZAcSDN74orK+HkbAgq9i+pVavjaNiAZkoEc34VBdMg9JSMZXrKXQO4JTGUmy6JxtK0b96owskJE914lghMVcahuJ+U8gbelbKu/A4M6zzprW8IGHBnzE/h5mfNGZ2uZSesPNk5bsb+JhDu21Ogqb24a+TDCYcYCB22pXTrpx25bQrp1057cppV067ctqV066cduW0qx9du3qy2o0Lp/oRGFGDwKHDq2aqKWtI2gx0qmqUnyYl24Oax96AryZxWXADvCVaskjl7sSc734dOLOIM4s4s4gziziziDOLOLOIM4s4s4gzizhtxJlFnFnEmUWcWeRZMaJHNIuAbaNoPDCZSD2I4PFUKvKjzCXFLq2pZL8lZK855UGmko8xXWEEwRs2x7KLMHzK5gsXYShdhKGLMHQRhi7C0EUYOrzYNMKwF0pMORq/mTj84/CPwz8O/zj84/CPwz8O//wY+GfE8MwhH4d8HPJxyMchH4d8HPJxyOeZI5/K57FNLhhUFc4Y/gYoclDHQZ2j5ribbVROBPwK4oHUnF2xy5+r41jQX58FfW/ce6BIHB8kEju1zjnHlPip1Mmxpb7N6Wxa/6dyKLN64Te2cLmpENTI22ILpaYc0OoUrUyJmgCKUtJZqlzV8ipBhvYDygftJ98WGDKeHvnGUp8nL3gZYEn6ur5H3TfPoCm85wGw3PiQG0LLVJJVMFRIHCWFSiFtJIiEQiJ6gidG4xLyYxI8Ig0XWEiUqi63kKEfBrWkiEemQ4CX+EFkmPqotXtt94i2fCt4z8pUoHmIF01G1K/XTbs63oZBZ+ub1tW7fznoXQ3fv2u1W73r3vCi9+Zi0Gq3zgcXA/Pz4PLyw+XgvNVuDd9f9y6G563NPTuIV52JphJ2dNWDmXPlmKxnbVTZOtflUtWavTTWEAYaHRHwTWG1Inx/QeIF+Ob//PJ//73quK6gGY0wXzf4llXpoHloq23FRKZf1C7OTels37QAsbZsZEiF1NOXL2so3eUsycmKCuMHV+joVW1HmvArcl/vNakiInZ43EEMRyS2Nn8Ev80I08LjvQtDoGCSta0U3v6l7mXhL0mEa95Wa5VgKQmHLfv5f/4n+fqO42T57T//8/P/6/72W/7D/2rVdMyJSKM6XJI90/YoXbaqOKnTum2ZhuEF1ArfUitCyHR2mdbV6VUBBsoCsDHS67oDwNO46drpjTPmDITgIaWgjYFtQnxO5IENs1pmR7UGo0VEvyiRt7kedStfbHGF+YJsqehxoJP8cQ7umcEzK55dS8vhMOEouV78GqXqa/X0//3nDeyV1bQDcxnh1Dcl8eYU9DwhmE+V+DMRg1SYSLWyDUkfpNJP52qYmTljl0QkLBbaNNBu/fzydWsjKOpDQgzMjpmJ+CKB6lMQP+VUrpUUfUMwJ7yXwn75/BuItojIJQtaZ60FUQqYivxqWc3xa2hO+bculKwTsH1sGKdQPaY8bJ21LHTECe0omJjjx03dWD1BYyNgTJm33nioRK0ldwKcTR/LItHZR4IRW4YBKoahXmq1zT/e2i/3+51Uy0DjOVPNbbESTQUMu49AE4AkzMsK8fuKk5UnX5wyiTAN1caZs/+TPwCFFGLk1DivOq9ennZeWikS4ThXerMtYIMbC8tfovZry+hVqoqe5JSsiFCAJCAS0zDDJ7YDHYxnDDCm82zbKqgGDxZ0RWI0tZ9/2smFhCT3EpQCqrizWoKvZt98Nue71W6d2aYtXe1Q0f6bvjmAF79+nWFBPvLw2zf4+Y+UcL1FAyqM7qMMrjumu+v4baVXlTMsHfzMRtBSG9Bq1wcS88IUVw1OkLmp0bynCU1WAMTrIjGW1mwhFcgCtgt887OpzNjq+T5JZKEhBOmY65vu7wISJxSP+bvBFVyUlg9T5fAUAXeZqK9f9RtX7JbE375lNEr4Gwj89u3/A1Lypf4= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Retrieves the details of the datasets used in the launch identified by the given id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-managed-credentials.ParamsDetails.json b/platform-api-docs/docs/list-managed-credentials.ParamsDetails.json new file mode 100644 index 000000000..2f044f43a --- /dev/null +++ b/platform-api-docs/docs/list-managed-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"userId","in":"query","description":"User numeric identifier. Filter managed credentials by specific user.","schema":{"type":"integer","format":"int64","nullable":true}},{"name":"search","in":"query","description":"Filter search parameter. Supports free text search on `userName`, `firstName + lastName`, and keywords: `is:missing`, `is:added`.","schema":{"type":"string"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `20`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}}]} diff --git a/platform-api-docs/docs/list-managed-credentials.RequestSchema.json b/platform-api-docs/docs/list-managed-credentials.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-managed-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-managed-credentials.StatusCodes.json b/platform-api-docs/docs/list-managed-credentials.StatusCodes.json new file mode 100644 index 000000000..8c792b465 --- /dev/null +++ b/platform-api-docs/docs/list-managed-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"managedCredentials":{"type":"array","items":{"type":"object","properties":{"managedCredentialsId":{"type":"integer","format":"int64","description":"Managed credentials numeric identifier."},"userId":{"type":"integer","format":"int64","description":"User numeric identifier associated with these credentials."},"userName":{"type":"string","description":"Username of the associated user."},"firstName":{"type":"string","description":"First name of the associated user."},"lastName":{"type":"string","description":"Last name of the associated user."},"avatarUrl":{"type":"string","description":"URL of the user's avatar image."},"provider":{"type":"string","enum":["ssh"],"description":"Authentication provider type."},"metadata":{"description":"Additional metadata for the managed credentials.","type":"object","properties":{"discriminator":{"type":"string","readOnly":true,"description":"Type discriminator for metadata structure (read-only)."}},"title":"ManagedCredentialsMetadata"}},"title":"ListManagedCredentialsRespDto"},"description":"Array of managed credentials objects."},"totalSize":{"type":"integer","format":"int64","description":"Total number of managed credentials matching the query."}},"title":"ListManagedCredentialsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-managed-credentials.api.mdx b/platform-api-docs/docs/list-managed-credentials.api.mdx index 271dfb51f..6a69cb8ef 100644 --- a/platform-api-docs/docs/list-managed-credentials.api.mdx +++ b/platform-api-docs/docs/list-managed-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Lists all managed credentials associated with the given `managedId sidebar_label: "List managed credentials" hide_title: true hide_table_of_contents: true -api: eJzNV91v2zYQ/1cIvqzFPDtL2wHzy5Z+ZAiWpEWSPhUGTEsni4kkKiTlxDX8v++OlGzZYm3HGIY9SaKOd7/7vltwK6aGD79xGUNhpZVg+KjHYzCRlqWVquBDfimNNUxkGctFIaYQs0iDoxcZnhujIiksHj9JmzKbApvKGRRsXJNfeN7zi3jcZ+cys6DZZM4qg093ZfwHvdNv3uOqBC1I8kVcy77ybD6shSJZKbTIAVkR/AUv8APJOxKRUpIOpbAp31asZsxq5eesqHLQMqoPEgmaEGl4rCQK50OrK+hxE6WQCz5ccDsvSaosLExBI2midC6sP/rtLV8ueytoSk/XcB4r0PMOns96Kgr53Wn/AyzHyfbm3S38K7kjILTxWMj36EVTQoSEkXPnyxD2eFFlmZhk4C3bRmxA6CjdjbgG5knZKiD67LYqS6UxZhMNwCw824YI7TomoNdIOu6xcSK1sfTBfmaZ8K94LoqYPcD8SenYDNlYmmEujZHFlO7gl4hj8NHa0dZYjXQb1s/F825FrsSzzKucrD9BhVTCNJgqQwWswldb6aLPPkIi8AzhnJ6ERYcN/eZ0MwyTxIDdjec6hMM8yJIhYzT0VBYuRtugXo5pRJllSlUYLDp44/TkhB5bKfE3Xo0Uciks/RVlmcnISR/cGyJZdIWqyT1EpGOpqZq4qoZ/824dWd8RWguyhLSQm2N4Ubk6JObDJaidVaHMX/aaJD5CyA9SO1S6DbShrOReu+DZDvKQHAozihxqAy3+vjogt1XG7Wd3TqRsH8MmbffzuxQHsBMzYYX+qrMD1L25bDjR9Z+wF7rLTOboU8cNg2aGBtchZoAeodZrTNrtuWcVskUn+FBnDR9GTBxnLHUiRmndlDmLY0mvAvt1TeTylnAGijil7e5YjyWxzynpVVATDSL+XGTzpkFu4rlDarbBw8FZYUM2VYQ1DtgrYvSLQk6v+1S0ODZlag68OwFcNeq3ycLDwg0WmY9WkdG2DEUpTx4MtTZvC58BVlmR3crvcEzy3dHlVmkPCcP7UYq2dD5yNbl/oGJUPZGUiN+G6ud7ETOaX8DYlxTS9cjzDSPNGJRMMbqnJtaEoWa4UuWT1kp3kL8JVP5mDmSFsjR9qifEQ+QGokrjuOYGv/fY2EFTuuDniJoKBlaqaHacuj7nJr8hH6wn3MGiMyYuB9HGdInpPGtGy4pqAU+tLc1wMBCl7EeZquK+gUdE2Jeq4/Jb94d9yYSl4GAfiJ6dfbnghK+Bf0vW9pZrK7EyHklsWip9TxwRnviX8ybs7p+sM4ssEuWu15auUZDYfQBJXRmBqYkpTETkwmRT+bbKGCkyc1GfqD/XPxAIWc7L+bX/+7v+iSuEyli0OrGsBxGK6VAybINdrKP2P95Eaj/Q/DgoM4EDE3VD3xl8VG3sTT0+DK0fbdXQ+ykagi4uFhNhAPvMcknHfhCjcMNKSSMxBnCCV7aradsaB6wLQRVwsm3tIzORVUTDaUg8XPi/tS7sQLjaWo6E+H/YD3aot1pxjlTvuK1hByC/pxyJ5vidYVeMNsvKGtSIPrT0W+OL0uXVTd3UXrMDF/8gsmZfKOZtXGsbbleA5QgvpTjY0BSIgD3dWRRB2das0483Wtlfn+6QVmw2iK2G4LgH0WGtcRR36gEKrDcNWEvfBHC5/AdiEEni +api: eJzNV0tv20YQ/iuLvTRBWclxgh54aZ2HC6N2EvhxMgRoRA6ptcldendomxH434tZkhIlMbIsFEVPIsXZmW9mv3ktJEHqZHgrVYyaFCl0chLIGF1kVUHKaBnKc+XICcgykYOGFGMRWfTykDkBzplIAWEsnhTNBc1RpOoRtZi24meN7uosno7EqcoIrZhVonRomyPTP/iZP8tAmgItsOWzuLV90aj5tDIqA1mAhRwJLcNfSA05ylBuWZSBVOxDATSXm461ikXrfCV0maNVUftHotAyIosPpbIYy5BsiYF00RxzkOFCUlWwVaUJU7QykImxOVDz1+8fZF0HS2jGpis4DyXaagvPN5uCVj+89z/BcpjtJry7jd/wdQwY7W5s6O5nlXAFRipRkb/O1yEMpC6zDGYZNpHtI3YINprvRtwCa0TFkhAjcVUWhbHkRGIRBeEzdUJGiykD/Qo5TgMxTZR1xC/iV5FB8zgNBOhY3GP1ZGzsQjFVLsyVc0qnfEa5EOIYG7ZueevIKp2uRT+H592OXMCzysucoz9DK0wiLLoyIyfICItUWj0SnzGBMqNQTI+Phk0PB/r98ToNk8Qh7cbzdQiHu1eFSIwVBaRKe472Qb0e04QzyxVGO3R84vjoiH82UuJvGcjIaEJN/BWKIlORtz6+cyyy2DZqZncYsY+F5Wriq1q46IpDv46szoC1wJFQhLk7RBeXq304P1yC+lk1lPl10CXxAUZ+ktpDpdthH8rS7ldPnk2SD9lhmjFzuA309DfVoQ7kMuNeVnfKouIlhV3avqzvHPZQB49AYG9stoe7l+edJj7+ixPNYaFySNFrK6x5VDHaIWWoy5xbr3Pz7Z57UtKcL6Ghuuj0CFbiNedIEAPBdsqcxLHiR8hEJ+TzlnEOFHFO291cjxWrzznpzaAnFiH+prOqa5DreK6rAsWaDg9nic2RLSMqLYo3rOg3o7Pq7YiLliRF3Bzk9gRw0bnfFxseFi7RFZ/JcNA2AsUpzzc41NqaWDQZQIYgu1I/8JDku+bDvdI+ZCwHiuZKp/6OfE0e7ekYV09Z1yz8Yah+foRY8PyCjl5TSFcjz63M0TlIkTn6Qk1sBYea4dKVL9Yau4X8/UDl7+ZAoQ3x9GmeMPaqHEalVVT5we8jgkXL6SLD2wk3lRxpbnh2TH2f85NfKMerCXe82BoT63G0Nl06tI/daFlyLZBzosKF4zEUahRlpoxHDh/QwkiZrSu/8l/E9wyIySE+sbw4+X4mGV8H/4qj3USu78QyeGyxa6n8PvNCMmgfTjva3T2RD4vSifHH20i3KNjsSwDZXRWha4WZJhB5mqw733cZc1CZZ31i/lx9qAPJkWvsvBu9OzoeHflKaBzl4GnWTiJM6qFs2ES7WNH2P15F2ovgAXJcZKC0b4dNa2hotbY4BTIc2j/6rk0COTeO+OBiMQOHNzara/67mcSYb7FyPBPHMkwgc5vltB+NPfaFQRfuseotJI+QlSwjeUrc3/i/tS/sQLhcWw6E+H9YEHa4t9xxDnTvsLVhB6BmUTkQzeFLwy6OdtvKCtSEX6xq1sZXpcuby7arvRV7bv6DyLqFQVd9XKsYblaAelIHco7gx8DbRSt3EkVY9D3bashrveyvL9cykLDeITY6gtc+iG6xaCSuzT3qul6CJX5ngHX9D4e7Sgc= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all managed credentials associated with the given `managedIdentityId`. Fil id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-managed-identities.ParamsDetails.json b/platform-api-docs/docs/list-managed-identities.ParamsDetails.json new file mode 100644 index 000000000..2cd24b2a0 --- /dev/null +++ b/platform-api-docs/docs/list-managed-identities.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier. Append to list managed identities within an organization other than the requester's default.","schema":{"type":"integer","format":"int64"}},{"name":"search","in":"query","description":"Filter search parameter. Supports free text search on name and keywords: `platform:`.","schema":{"type":"string","nullable":true}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `20`.","schema":{"type":"integer","format":"int32","nullable":true}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32","nullable":true}}]} diff --git a/platform-api-docs/docs/list-managed-identities.RequestSchema.json b/platform-api-docs/docs/list-managed-identities.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-managed-identities.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-managed-identities.StatusCodes.json b/platform-api-docs/docs/list-managed-identities.StatusCodes.json new file mode 100644 index 000000000..8e9fe2255 --- /dev/null +++ b/platform-api-docs/docs/list-managed-identities.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"managedIdentities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Managed identity numeric identifier."},"name":{"type":"string","description":"Name of the managed identity."},"platform":{"type":"string","enum":["altair-platform","lsf-platform","moab-platform","slurm-platform","uge-platform"],"description":"HPC platform type."},"config":{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig","description":"HPC platform-specific configuration for the managed identity."}},"title":"ManagedIdentityDbDto_AbstractGridConfig_"},"description":"Array of managed identities."},"totalSize":{"type":"integer","format":"int64","description":"Total number of managed identities matching the query."}},"title":"ListManagedIdentitiesResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-managed-identities.api.mdx b/platform-api-docs/docs/list-managed-identities.api.mdx index 06456335d..4383fa0e5 100644 --- a/platform-api-docs/docs/list-managed-identities.api.mdx +++ b/platform-api-docs/docs/list-managed-identities.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available managed identities in an organization context. sidebar_label: "List managed identities" hide_title: true hide_table_of_contents: true -api: eJzlWMty2zYU/RUMu2g7I8mOk3am3rSOncRu48SNnVXGE0EkKMEmAQYALSsa/3vPBUiJEhlZUdPJoitbxH2c+77APHJ8bKPDD5FMhHLSSWGj616UCBsbWTipVXQYvZbWWcazjPE7LjM+ygTLueJjkbAlH5OKccW0GXMlP3PiZbFWTty7AbvSLIMU5iadrKk2LV4NWgMGfCcuIz6VwjphfrQsESkvM9djvCiESoh1+DuYz5LhgL1V2WxFEqDHsbBWEm6nW9LCKU5uBRBD1kgwnBopkkHUi3QhjJdzllS+OA8GnC1d1osKbnguIJC8OY8UfoDaY8KpJDeSzFm07ty3TZtVmUNvXLkmlcIM2FGw0VUe7PDeVLpJh/MfdyCZZ+OJyHl0OI/crCDMEiEbC4MjRCXnLnz69Vn08NBbGGYFN/Fks2UvZQZtLJCyhYMG7LIsCm2QUqkRiAgSpCYiF4AKpiTsVsym2iT2kA2LjDsCczjsRGydkWqME1VmPjujQ2dK0cSb8/vNYM/5vczLnCIwAmidwl8WLqK8wL+uNGrAToLbgOhgvxtKt/OeHmwEp9PUCrcZ35suXPZWFr52Cj6Wyke9CfLfY0QrgLoCNYQkh4SD/X36s5bBf4HTV7pydIqizGTs0ezdWCKZt0Ho0Y2IyebCUIH5KsJp3iqtJQs3hpNjpBO5fVyUTLZJ6nYerJTXrKsko4deFbp2Cq5FjZIZMetoezMvps7sLlECqqk188xxafoL0l6U2bT5M9d81Pxts9LkzQ/lWCx/ttr76cUxq08ZgfDIENBUjh93M2r09kSaLXyBOk8zPWXEwRJpIE2bGdU8uSfOyqo52Qk38FMq0a7tDB/zATvHIfVl9DI+sjornUDSu4nvFDHIyac8sywnwgm/o37Hk/7UIFuqDh8cbsS7Ul16XI9jPkowXFj4Qp3UMXEvYij3045gq7Sf8VKhd1VUhZEoSBSnVHf6FkLZwnA4jnAIixaIxvfhwoROV2jr+qZUlQh7/dPEucIe7u0lOrYDKz5hAg2k3quj1I8zXSZ7QfEeT+64ikXyA2zrQ16/ltev5P0cLMfXb2M6T6mv0z7QNi34PtZ5kaHZJ9/FUlWhOl5P4S+bKulf3jAopH8ZJj+Fk7rarDJnjcqn6q6m1GD7QVafZAUzAuVWtXWyqKYpZr5YmgHf2G9UPewsZTqXDlHt1QuEn0LDqgUMPerSCvNmq+b4HpR+2tMEu7w8JW8qmFE5nNrSBCiY0kloSRNEezvRp6D0oiH57ILxJDG04qETt6XSKrLddFzVQYiJd2UtOAhOIA1/l6LcAuoVNZHGmPhEbGtNkcGpYQMMrYaOFiEOZUmjP7TtvEB4d1DeqRg6pxNJ65ssRCaVYDd6hA6AHLPlKGTDgB2HpVnfCWNkgmxio5kXs+BaKScPFBuZB3kpP4td3H/lR+r60ubRLcsTuALMeu8PRlpwYagqoUtLRb0M4JP9/WUE/9Sjt16d/aoeUmnUgdVn90rAfPoBaDWPNJY37sTplxSOtM4EVy2NKEda0npsuIp16KODag49S4bMaSLoL0LHqnTxfhvQhh9hNaH9LzoawVIeu1eIaNVINy0OfVuIGOtRvNY5a+s7tp+GstUb1exkdOL0xzaCj+SxNb/TUkiRb9+LvH+ddjzbKsc6lsErYm5kV8fdC+zxhKZ8lV1mzbLO++K7aqcGJdE+69qqnyNJqivb16zXxIJhkNDimKPnQTFtfI9s3RVhK8ublrwwRpsW8qcd94H6wowe62hN0FPgIXKLToWRMvNX5Oe48glzVLoJfl7TVQPXw4mmS/bY34ZoQuHHnmzeszEz7upLdmkynNdjlxdy4Efscva2e7Y/YRf1tntM9Ozo4iwi/TW8S/Jm8EwT5MI5pLG+WPkK9UT4Ev55WSfVzdR5s6VKtWevPFmhILWPASRzJcZvRUxpgIogYavGN01GJsjM53Sq/1geAAh5Luh5Mvjtl8F+vRYir0lkdR193f3MsI51vkzK//kLUZUWZAdte7jF0x5E8ZlXSbz+vkabDH2dz0fcivcme3igz+HqT6mdSEtORDGk6ORig+u/9/tRp/G3YtZ4/brjGS0jUURvHttb9l+9H21AvHjW2hHybq9IGwCFd6sd0ez+ZrQpqPVj1RLUNf0wMjwcoZWH7QkdkTI5cB2hgoomV2uKrQyAVy+uQMtX2+5am/XS66chNWvIRlV5iiuqV1RWDd3XLxRhdP0Dvkoabw== +api: eJzlWE1z20YM/Ss720PbGUp2nE4PurSOncRu8+FGzsnjiSESlNYmdxksaFvR6L93sCQlSmRkx5lODj3ZIhfAw+MDFrsLzTD1enShTYKWDRv0+jLSCfqYTMHGWT3Sb4xnryDLFNyCyWCSocrBwhQTtbZTxiqwytEUrPkCYqtiZxnveajOncqMZ8WzXtPUUcfW8QxJ8QxssCL8XKJnpJ+9SjCFMuNIQVGgTcT06g9H09Pkaqje22y+4ckriGP03ghudh1v1VvF7gatisGqCarPJZLBZKgj7Qqk4Oc0qbl4WyVwuqYs0gUQ5MhIwuZCW8hRj3TApCNthEbxOdfb5L5v52zLHMnENTWpQRqqwypHrhnsYe/O8KyH/IcJlPR8PMMc9GiheV4IZmMZp0g60qmjHLh69PtvermMVol5BIpnuzN7ZTJGUtVStSJoqMZlUThir1JCVCKQZpFQADkqsIm6wfmdo8SP1FWRAQuY0VUvYs9k7FRH2pZZUKceMZXYxpvD/W6wb+He5GUuX2CCpFyqCH2ZsehCEXJJdqiOK9pG6upgvx9KP3nPD3aCc2nqkXfje9eHy9+YItROAVNjw1dvg/x+jJeRJvSFsx69eDjY35c/Wwr+W0c6VLpleQtFkZk4oNm79rJk0QXhJtcYS84FSYGFKhotdN4prbUJEIEQYxhz/7ArkzxG1F0dbJTXvK8k9TKqP11XgltfTcTs0r62Nw9uGmX3uUJb5tKaIWMwNFgtjXTm0/bP3MGk/dtnJeXtB+UU1z877f3k7Eg1b5WACMhiZ1MzfZjmO0c3x4Ye5uLI5UXJqNDeGnI2R8tKjI2dqsQQxuyoJoXwQ2nHwfZhv9U66XOs8B7jkqu9SDi36SCD0sYzVVmogowjKR1jb10I/Q7vOc3cnSrIyT6AfqjGiOrijKo+VDjPAypt7cJf/jJjLvxoby9xsR96/IwEQ+P2Gg4HcebKZK8KvAfJLdgYk58KwgHYZND4G9T+fq1ydp6/N2lIpd/KPt1NSs3gFlXs8iJDxuSH5GhrVEfb0vpKkodJYuRfaCVUybKk1nxhOXivsDxKim8qTaxUF3roKkTFp/RScVt6pHePKvaPHinsXuJtPD5RUPJMar3qhc3oIeUWZ6XsxCHAzHl+XIAT5zkEcKROzxQkCcngUveXll81Q0iUdQnW2iJ+XP/fEtn4RIltSCh21mLMUjI9ibS3xoOrKi+E5J8Sy0ckFpapFXe+nOSGq1AzXH+YkNW1m9T9KbST747QUlbVn67dxIcIOdwHs7H5gk+hrztSiOuqZtdjZomJAlbOomKT44q6v9zkffDkv6lQXGUTshTyGs6qlL1vZC1NHKbAePK1WBPnMgTbCXaaKhkOorXrJiYQqpXfMLFucNrSSAqZR5HJMtJsWAYOfTjxTBDzazJJ3SF27VQDX2BsUhNvtYQm8Z7tthVsc4SfH0+O2X3qIvgkVG1xLVOIfMzuIB6IZceQPUoyPdPHuRi3BNMz7OfA8awpjTArbmbWe0D5UA9xermUtb/1jXEvIGnOCN8yz4mJIUxkUsnRe5iijBgPjHn1wo6y25m8JHLUQf68ZwBtTmjKOpb9z91hElx5jEsyPA9nshcIhHRY8kyPLi5lts2RZ05OddMwfhcgr/SeaR/sPNJtc6orKdMj3WyNUJhh2AbX+2O3hYY36qwZr45kvTo8O9USv4E3FjYrZtogV+RIxGaSD6UZFumo/udVI6rrOw5pG5u6YF4zWaOQsA8BlHRNjL5eLDKAOMhgM/l2ypiDyYKmU/fn+sUy0sJcFefZ8Nn+wXC/GXVyCDKqD0Bv+g+222AXa1X+z+8kal1IHjKSGRsmFflAi1rF2zc6MmXI08ViAh4/UrZcyuPqsCnaTowXEhM9Cs15B/U/+saiN/kbnLfuW24hk6lAazllPz6z/+rGYgfi1UXKEyE/7d5iB6DqpuSJaJ5+S7HrozbXI2tQl/KDTHVVcXFZj0xIQcmV1WEcY9G26mxjGzvA65fnOtKw2Xe3+mzw3lxG2HnL92JRrTiXel0udQM91K9eXi6Xy38BaW+Kyw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available managed identities in an organization context. To list the m id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-mounted-data-link-ids.ParamsDetails.json b/platform-api-docs/docs/list-mounted-data-link-ids.ParamsDetails.json new file mode 100644 index 000000000..a9401a90b --- /dev/null +++ b/platform-api-docs/docs/list-mounted-data-link-ids.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier. When specified, lists mounted data-links in the organization context.","schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, mounted data-links are listed in the user context.","schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","description":"Studio status filter. Filters mounted data-links by the status of the Studios they are mounted in.","schema":{"type":"string"}},{"name":"exclude","in":"query","description":"Studio session ID to exclude from the mounted data-links list.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-mounted-data-link-ids.RequestSchema.json b/platform-api-docs/docs/list-mounted-data-link-ids.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-mounted-data-link-ids.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-mounted-data-link-ids.StatusCodes.json b/platform-api-docs/docs/list-mounted-data-link-ids.StatusCodes.json new file mode 100644 index 000000000..2ae5a348e --- /dev/null +++ b/platform-api-docs/docs/list-mounted-data-link-ids.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dataLinkIds":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs currently mounted in Studios within the specified context."}},"title":"DataStudioMountedLinksResponse"}}}},"403":{"description":"Operation not allowed."}}} diff --git a/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx b/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx index bf0b8740b..9eafbc6a0 100644 --- a/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx +++ b/platform-api-docs/docs/list-mounted-data-link-ids.api.mdx @@ -5,9 +5,9 @@ description: "Lists the IDs of all available data-links mounted in existing Stud sidebar_label: "List mounted data-links" hide_title: true hide_table_of_contents: true -api: eJzVVVFvEzEM/itRnks7YCAxCUFhDFUMgdjQHtCkpXdumzWX3BJft6Pqf8fOXXvXrivTJibx1OZiO99nf7bnEtU4yINfMmCRahfkeUemEBKvc9TOygN5rAMGgRMQg8Mg3EgoY4SaKW3U0IBIFapnRttpEJkrLEIqtBVwQ17ajsVJFbYr+nkONhUX75wfD9K3F8J5Olw7Pw25SiB+QicM+a0CtWJTTGXJZ6ys/q0YGgdYuYvEkccNdoSHkEOCegam7MqOdDn4aD9IazJfq+iHFPyYYg/SQGa58ioDBM/JmEtLBzKPWOlWcyKuCvCl3EzPtzYkW2TgdSJ0Chb1SIPvirMJWMGY+Jx2IsNwB0XO8hrHmhYTCckEMiUP5hLLnMFpuhqDp6uR85nC6tPrfblYdFYMWgnezeNslco7SbhMIzKFLeCVh8isKj/zKAL4x+MPqLAIu6FXGhOVqRhpgwz5KP5uzfSwjAhrB5I0n2ql8v8y0mnkvBV+QE8CXwMLN4kpUrgfWgiBKzw4ZNnXnmLkXRbRbEHN6d2NhHqX5e8sBef7F3t7/LMh2C8UI9bFIt+qPDc6iXLrXQY2md9+wg0vqam4Tzw3FOrqgbTVQ42x8l4xb42QhS04NzPSZ3suw4psHDVJ4T1hNGV7sCyrdK1xUgtt1VuN2qgoEjUafpX7vPKqG58Bhx91nsiUjff3Xm7J1HJ0COuQx567hrQKHoDQaSzjsPgAJBffL3BCx3OuAk2SieN5M4aYNMVXslfP2F5TVC4n+Nly7BTekN0EMQ8HvZ7KdTcxrki7Aa4ISle722qKN+K7UchdJD6yveh/H0jGsYR5wvWsStYGu6oMv7hUFp+H0Yi+VH+Olv15eY2RvrYjF93rHNco+Nm/AWS6OoFQG3PJVBKFuE6+TZm0qE0cDyP3vrkgIJy56p3n3Tevunv8LXcBMxV1XPfl8falsol13rTF/7716rryZS83isYRJSYmeF6rsdn4HdlKCYlmQvnj+/l8qAL89Gax4M/VNGOVpjpwEkjfI2UC7Mjiky3HrXynULZ2+EyZgm0kD+z7U/jne3EH9PXl/UACT7Idd5BYbfBH4n/wvtyBrVnYDbhzPnjN6OI4p4YAldI0ZOlXbv0kgRxbXrd26NoS+PzplGzV+sjdGLEx+nJ/2rIVm9owWpy6KVhqxSV25DM9RPvrD7wOII8= +api: eJzVVU2P2zYQ/SvEnFV7kwY9GChSt9sURrdo0KTIITCwY2lsz5oiFXK0u66g/x4MJduy13GDBA3Qk0RyOHzvzVcDgqsIk/cQpS7YR5hnUFDMA1fC3sEEbjhKNLImM7uOxi8NWmvwHtniwpIpUPA7y24TTelrJ1QYdoYeOQq7lXnTuR2ZaVWRK8ztSx9Ws+LHW+ODuX354MMmVphT2hJvLEfZOxr4ZmfQGR9W6PgfVGjqYH/d5N4JPUpmAsWKcuF7stsRZOArCsl+VvRk/ui8X6PgDbvNrIiQQYUBSxIKKkYDDkuCCSSskAGrEB9qCls4lefPISRXlxQ4N1yQE14yhZF5tyZnFJOuiywxjJ+gqCofcexpKZGYr6lEmDQg20rBsRNaUYAMlj6UKN3WDy+gbbM9g4HAl3m820v5SRK+ZBGlcAY8BkrMuvArjzpS+Hr8UVDqeBl6l2OmMzVLtqKQX6XvWaUX24Swv+CXadVnqv5vE51DOp+FHyWwWx2Bpcfc1gV9HlqKUSM8u9a072+aZfBlQnMGtcp7Gck8A01/7yJFPX9+daWfk4T9HTJIcXGip1hVlvOUbuO7qCbN0yf84o5y0ToJWlDC3QPFoIYOxhgCKm8WKuMZnKeKTNVew7Anm1pNXodATux22Fh2UXpgWfeJtq+tQ7a1bQbCYvVVrfPuVl/4Cjj+1esEbavGL66+P6PUrnUY50Xbnn+gonMeKa8DyzY1i58JA4VpLWuYvJ9rFEqStdd+s6IkGuoRjPseOz4EVcNJ4X7XdupgYQJrkSpOxmOseJRbXxejSB8o4Ij902xKJ+a1RdEqMr+ovZm+noHi2MF8o/HsQjYEu4+MvrjLLF0vkhFk/c+rXX3ePUiiz27p0/Ve4x6FPvtvAJUu5xR7Yw0Z5ikRj8kPKVOJbFN7WPqfDgdtBqpc986z0bOr56Mr3ax8lBJTIveFeXN+qpyCbQ518X8fe31g9XBcWWSnwiSFmz4dDyM/g4Ek8wzWPoqeN80CI/0dbNvqdtfONE0LjipCAZMl2kgXVPxm0/Es3w1tB0P8Hm2tNqAd+/Mp/OeD8QL04+n9hQS+yXi8QGI/wr8S/xcPzAvYDhP7AG6ui8CKLvXzDNaEBYWU+t21aZ5TJYNbT4bo0RT47de3kAEe99yTHpu87wao2w58N01n8dZvyLUt7LCLrqGdt237EdaWILQ= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists the IDs of all available data-links mounted in existing Studios. Append `? id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-organization-collaborators.ParamsDetails.json b/platform-api-docs/docs/list-organization-collaborators.ParamsDetails.json new file mode 100644 index 000000000..d9975cfd8 --- /dev/null +++ b/platform-api-docs/docs/list-organization-collaborators.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Free-text search filter to match against user names and email addresses.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-organization-collaborators.RequestSchema.json b/platform-api-docs/docs/list-organization-collaborators.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-organization-collaborators.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-organization-collaborators.StatusCodes.json b/platform-api-docs/docs/list-organization-collaborators.StatusCodes.json new file mode 100644 index 000000000..31628eadd --- /dev/null +++ b/platform-api-docs/docs/list-organization-collaborators.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier."},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string","description":"Username of the organization member."},"email":{"type":"string","description":"Email address of the organization member."},"firstName":{"type":"string","description":"First name of the organization member."},"lastName":{"type":"string","description":"Last name of the organization member."},"avatar":{"type":"string","description":"Avatar image URL for the organization member."},"role":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"}},"title":"MemberDbDto"},"description":"Array of organization members matching the query criteria."},"totalSize":{"type":"integer","format":"int32","description":"Total number of members in the organization."}},"title":"ListMembersResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-organization-collaborators.api.mdx b/platform-api-docs/docs/list-organization-collaborators.api.mdx index 148294ecf..92eabeba4 100644 --- a/platform-api-docs/docs/list-organization-collaborators.api.mdx +++ b/platform-api-docs/docs/list-organization-collaborators.api.mdx @@ -5,9 +5,9 @@ description: "Lists all collaborators (members and participants) associated with sidebar_label: "List organization collaborators" hide_title: true hide_table_of_contents: true -api: eJzFV9tu4zYQ/RVCT7uAY6d7KVA/NbtJiqDpdpHLU2AgY2lkM5FIhRwl8Rr+985Qsi3bgq1NC/TJInk4c+bCmfE8Ipj4aHgXWce/o16UoI+dLkhbEw2jS+3JK8gyFdssg7F1QNZ59S7HfIz8ASZRBTjSsS7AkH+vwHsbayBM1IumqaIpKhYORv8Akap0goZ0qhkwnoXjiX5Go+4ZdZHc96NeZAt0AXyR1CT+bkj42qTCaNYPORLTYUPmkeEF3wrS+FSLHQXQNNo2rilTmTJHp+M1OydEHD6V2iGzIFdiL/LxFHOIhvOIZoVo0YZwgo6hqXU5ULX166doseitqOTwuiTyVKKb7TD5C151XuZCgr2qbKoc+jJj15PlTyqd6atTTIH3hur+83HwUkcyHz9skLFp6pH28/nWxsM/6kKxYI73RJvgtSapf8PJI7h4up/TuUM8InwlVaFVqjOOuTBjsbyGCWjjSZWed0VwlZ1MR2cKkoRN8ehbSXpy2kyY0khC7gtrGCnnH46P5Wcrb/5kGbFlwwzJKRRFpuPgkMGDF8h8V4UdP2Asbi+cZDfpSkH9jhpAcA7Eek2Y+64C5J0czsmdtAt3W1N/0YvEj93k1uBvIZjbTt1WestIiY5k105tqKwJ6kPcDos7a4b3kMxUO0/daJ4LVHUhmkFXmZfQUSQ8A4E7LPAk4JTOYYLq9uoyPM99gp3NWnki50DoAi8mBLi6EtJ8XWulPbweCfToGUIMfac7pEm0Sr29Ev388ld7VQqejk/JCr8t8+QpiK9azPHVq2f6weBQMxTf5ZKgIdhKliC71j+wSzXaVn0jlxv1eKlUmx3/9jcMkmZVGeWv6krC54L41FZLvkCipMmgp58pKuu+dMd+957jHzx9oFRUwJa6t+Z/5px1O8w/tlTBZY9WxpKMCPaF+QjcY1xyIGahG3/hYo3upOT+O7wbSYHlVj210tcnoQ2F1jyMBjKADOahay8G8VaL55rxvOzvpeOyEE2JCj8cDKDQ/TizZdL3+MSM+truBPM6nKjvGZCEXX0VvDr5fhEJnyXda/Fu5akm6ZWzROOyech6HEC8U32cLxPq4YWCG7RJbbhee7ZmIWoPERRzdcwNrAJLWkAc0mLT+KbJdb0Man9fHzAR8Vyl55f+b5/7x7JXWE85hKyqe7Ak7uZD2w7CBuf5Oln/rymxjovMBIMi4+YfGpELTaPKqnqs7UXD5TS4aRNHf8qOEOB8PgaPty5bLGS7mkEk3RLtYZzJU0sh87jHDW+b4lqteMTZam58hqwURCQDU3c2b5/h9jBaDY9vJPUfDnF7WK7GyTXLkSy4M4zlKf5UVN9d1bX2verwh6GV1XKyM7Mmp5VPQ2ouRgycIiRcUoRgdXYSx1g0/b3TFjYq6h9nN4yFzbq1VaeC9FZG/AQC4sY+ouFnsCRIshaCi8U/Pu3r4A== +api: eJzFl0tv20gMgP/KYE4toNhp2t2DTps2ySLYbrfI4xQYCC3R8iTSjMKhkriG/nvBkfwWbDW7wJ4SaSjy42NIeq4ZMq/jO+0o83oU6RR9QqZk46yO9Vfj2SvIc5W4PIexI2BHXr0rsBgjeQU2VSUQm8SUYNm/V+C9SwwwpurF8FTxFJWjDKz5AaJVmRQtm4nBVI1n4Tgzz2jVvaPsMr0f6Ei7EikIX6YtxD9rGr6so+hIl0BQICOJI3NtoUAd66BNR9qIHyXwVG87t65T2apAMsmKjgSE8KkyhKmOmSqMtE+mWICO55pnpVgxljFD0pGeOCqAm1e/f9J1HS1RCnhdgDxVSLMdkr/h1RRVIRBjJOUmitBXOXvFThFyRXagznACVc6xuv/tOESpJ8zHkw0YN5l45P0837o4/KMp1cSRKiEzNkRtHerfMHkESqb7mS4I8YjxlVUjrSYmZyQhK4CTqYIMjPWsKo+kRHFTnViAyRWkKaH36DshPZOxma7rkaTcl8569HJ+cnwsf7bq5i8d6cRZRstyCmWZmyQEZPjgRWS+a8KNHzCRsJck1c2mMdDeozVBIALx3jAWvq8CuSeHa3Kn7MK3naVfR1ri2E9vK/wtJHM7qNtGbz2SZEeqa6c3NN4E8yFvh9Wdr6f3kM6JIc/9MC9EVPUBzaGvzq/QUyU8AwMdVnga5JQpIEN1e/U1XM99isnlnZxoqyJMgRcbEtx8Esp81WtlPLweiejRM4Qc+l7fsGGxKv32SuzX9epdU4Jn4zN2wrflnlwFiVWHO7659cZmweHQM1RChpEMBF/ZMeTX5gf26Ubbpm/k47V+vDBq7E58BxsOybBqnPJXbSfRdS0Sn7p6yWdIlQwZ9PwrTWU1l+50gd5DhiHSB1pFI9jR91b850SOdsg/dnTBxYxW1rGsCO4F06DKY1KR4VmYxp8RCOm04qmO70bSYAvkqZO5noUxFEZzrIeygAznYWrXw2RrxHuk58V8ryjXsZ4ylz4eDqE0gyR3VTrw+IQEA+N2knkdTtT3HFjSrr6IvDr9fqmFZ4F7LdFtIrUOvQyWWFwMD3keByEdtf9cLArq4YVDGIyduPB5G9mWQsweAhR3TYK+FZaygCSUxabz6y63/TKY/WN1UEdaItfY+TD4cHwyOJaXpfNcQCirdghL5W7etO0sbEDPV9X6f62JbWJkKRiWORgbJhGFqdGUVbvXRjperIObPo0iPXWeRXA+H4PHW8rrWl43S4jUW2o8jHO5axPIPe4Jw9vWuE4vHnG2XByfIa9EQsvG1J/m7UvcHqLl9vhGqP9wi9tDudwnV5QjeSAjmL+Y1XdXbbN9r3r8YuikWqx2drbOtIxpKM16VEd6ipAiBcDm7DRJsFyP985c2Gipf57f6EjDZuPaalRBeyfRfN5I3LhHtHW9BGR5FsC6/glQb+wF sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all collaborators (members and participants) associated with the organizat id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-organization-members.ParamsDetails.json b/platform-api-docs/docs/list-organization-members.ParamsDetails.json new file mode 100644 index 000000000..10e812a73 --- /dev/null +++ b/platform-api-docs/docs/list-organization-members.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Free-text search filter to match against member names and email addresses.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-organization-members.RequestSchema.json b/platform-api-docs/docs/list-organization-members.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-organization-members.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-organization-members.StatusCodes.json b/platform-api-docs/docs/list-organization-members.StatusCodes.json new file mode 100644 index 000000000..31628eadd --- /dev/null +++ b/platform-api-docs/docs/list-organization-members.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier."},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string","description":"Username of the organization member."},"email":{"type":"string","description":"Email address of the organization member."},"firstName":{"type":"string","description":"First name of the organization member."},"lastName":{"type":"string","description":"Last name of the organization member."},"avatar":{"type":"string","description":"Avatar image URL for the organization member."},"role":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"}},"title":"MemberDbDto"},"description":"Array of organization members matching the query criteria."},"totalSize":{"type":"integer","format":"int32","description":"Total number of members in the organization."}},"title":"ListMembersResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-organization-members.api.mdx b/platform-api-docs/docs/list-organization-members.api.mdx index 6052d2c54..29655a60d 100644 --- a/platform-api-docs/docs/list-organization-members.api.mdx +++ b/platform-api-docs/docs/list-organization-members.api.mdx @@ -5,9 +5,9 @@ description: "Lists all members of the organization identified by the given `org sidebar_label: "List organization members" hide_title: true hide_table_of_contents: true -api: eJytVttu2zgQ/RWCT13AsbO9AeunTZtkETS9IJenwEDG0shmIpEKSTlxDf/7zlCSLduCraZ9siUezZy58MwspIeJk8M7aSz9jnoyRhdZlXtltBzKS+W8E5CmIsNsjNYJkwg/RUFw0OonME6oGLVXicJYjOfheKJmqMU9oS7i+77sSZOjDeCLuDL7vWHha2mccDlYyNDzw/BuITU9ED7YoVPFnHLwU7lNtGlN6CJDq6I1L8sULD4VyiL597bAnnTRFDOQw4X085y9KO1xgpagibEZ+PLVx/dyueytqGTwUhN5KtDOd5h8hReVFRmToJg4XxZdkVIavaG/vrC6L04xAXo3FPcfjkN+OpJ593aDjEkSh34/n29tPNyjygUZFjlMlA5Za5L6HU4OwUbT/ZzOLeKRxxcvSrRIVEo1Z2Zklp5hAko7X3WdYNPUhjoWREilAuKYgnHoWmk6b5WeEKkRF93lRhOSz98eH/PPVud8IRuRodC051PI81RFISWDB8eQxa4LM37AiBOfW+5sr0oH1SVpAMFa4PiVx8x1NcB35HBX7jRelauW5l/2ZOG62q3A30I5t5O67fSWkFydVl0oownuQ90OmztrlveQzURZ57vRPGeo6EI0ha42L6GjSZiBB3vY4EnACZXBBMXt1WW4oPsMW5O28kTqgaDpzzoUuPwktHmawtiQEhvLYv9yxNCjGYQauk7feOXZKyvuFfunu796V7bg6fjUG+a3FR5fBc5VSziuvPdEPwQcVEPQtyQKCkKs3nhIr9VP7KJH265v+OOGItdOld7Jb38jIB5U1XC6qpSEzhnxvk1LPkEseMyg878iKuvJdEd5d47qHzJ9QCpKYIvurfmfWWvsDvN3LSpYz2ehjeeBb56JD8MdRgUVYh7m8SeSa7QnBU3g4d2IBZaG9dTwTJ+EQRSG81AOeJ0YLMLcXg6y1XgntZjVs72wJAhy6n3uhoMB5KofpaaI+w6fiEtfmZ0yXocT8SMFzwUXnxkvTn5cSGZSE73mvJY5atJdpYk91mODn8cBRG/KP+d1Kz08+5AApRMTPq9yWrFgt4cIcrgqotFVgrkhIAoNsRl8M+RKKYPbf9cHRIQzV/r5u//Ph/4xv8uN8xmEfqrmL7ds6xXbZrtYN+if2/OqHPNsH+QpDfEwTmyQ/rI3qlWzJ4f1VlfzoxpOKRyGLBZjcHhr0+WSX5dbBDdNrByMU74qCaQO94T0uj2slf8jzleb3wzSghGSV57ubF6/he1htFr/Xknqj65he3iuVsI1zxE/kLaP+Ur9Ul3fXFVq+ZfosPS3sqp3Mz1vclplNbTlckTAKUJM0sAEy7OTKMK8mfEdYd/QxP/ObggLm/qzpTfBeisjugQBcWMeUdNFqAl6fmaCy+X/A3e/+g== +api: eJytlktv20gMgP/KYE67gGKnaXcPOm26SRbBpt0ij1NgILREy5NIMwqHSuIa+u8FR/JbsNVsT7Y0FPnxMSTnmiHzOr7XjjKvR5FO0SdkSjbO6lhfGc9eQZ6rAosxklduoniKylEG1nwHkVMmRctmYjBV41k4zswLWvXgKLtMHwY60q5ECsKXaav2vzUNXxrlOtIlEBTI8hDfz7WFAnWsgx4daSNMJfBUb4Oua1O2KpBMsuIiQSB8rgxhqmOmCiPtkykWoOO55lkpVoxlzJB0pCeOCuDm1Z+fdF1HS5QC3hYgzxXSbIfkC7yZoioEYowk8SL0Vc5esVOEXJEdqDOcQJVzrB7+OA7x6Qnz8WQDxk0mHnk/z9cuDv9kSjVxpErIjA1RW4f6P0wegZLpfqYLQjxifGPVSKuJyRlJyArgZKogA2M9t1WnRLVXYFOFBZhcQZoSeo++E9MzGZvpuh5J0n3prEcv5yfHx/KzVTn/6kgnzjJallMoy9wkISTDRy8i810TbvyIiQS+JKlsNo2B9pKsCQIRiP+GsfB9FcgdOVyVO4XXxqqj+OtIV76v3lb4a0jndlC3jd55JMlOZ19ovAnmQ94OqztfT+8hnRNDnvthXoio6gOaQ1+dV9BTJbwAAx1WeBrklCkgQ3V3fRUu6D7F5PJOTrRVEXr6qw0Jbj4JZZ7nMHYE7Eia/duRiB69QMih7/UNGxar0nGvxX5dr941JXg2PmMnfFvuyVWQWHW445t7b2wWHA5dQyVkGMlA8JUdQ35jvmOffrRt+lY+XuvIC6PG7sR3sOGQDKp2OF23nUTXtUh86uolnyFVMmbQ8880ldVkutcFeg8ZhkgfaBWNYEffW/GfEznaIf/Y0QUX81lZxzLw3SumQZXHpCLDszCPPyMQ0mnFUx3fj6TBFshTJzM9C4MoDOdYD2WdGM7D3K6HxXK8e6SXxWyvKNexnjKXPh4OoTSDJHdVOvD4jAQD43bSeBNO1LccWBKu/hZ5dfrtUgvJAvRG4trEaB13GSaxuBgb8jwOQjpq/1wsSunxlUMAjJ248Hkb05ZCzB4CFHdNgr4VloKAJBTEpvPrLredMpj9a3VQR1oi19j5MPhwfDI4lpel81xAKKh2AEvNdt6xbdz5qkJ/3aLXBlmG+7DMwdgwTyj0/qY42l0z0vFirVvwjSI9dZ5FZD4fg8c7yutaXjdrhFRNajyMc7krE8g97nHpfYtYJ/8Tzpar3wvklUho2Xn607x/DdtDtNz/3gn1S/ewPZzLnXDFOZIHMgL6k3n97bptl7+rHlt/J9ViObOzdaZlVENZ1qM60lOEFCkANmenSYLlesR3OvtGU/zn/FZHGjYb0FbDCdo7iebzRuLWPaGt6yUgy7MA1vUP9t/AHw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all members of the organization identified by the given `orgId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-organization-team-members.ParamsDetails.json b/platform-api-docs/docs/list-organization-team-members.ParamsDetails.json new file mode 100644 index 000000000..8e415ac31 --- /dev/null +++ b/platform-api-docs/docs/list-organization-team-members.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","schema":{"type":"string","nullable":true}}]} diff --git a/platform-api-docs/docs/list-organization-team-members.RequestSchema.json b/platform-api-docs/docs/list-organization-team-members.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-organization-team-members.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-organization-team-members.StatusCodes.json b/platform-api-docs/docs/list-organization-team-members.StatusCodes.json new file mode 100644 index 000000000..31628eadd --- /dev/null +++ b/platform-api-docs/docs/list-organization-team-members.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier."},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string","description":"Username of the organization member."},"email":{"type":"string","description":"Email address of the organization member."},"firstName":{"type":"string","description":"First name of the organization member."},"lastName":{"type":"string","description":"Last name of the organization member."},"avatar":{"type":"string","description":"Avatar image URL for the organization member."},"role":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"}},"title":"MemberDbDto"},"description":"Array of organization members matching the query criteria."},"totalSize":{"type":"integer","format":"int32","description":"Total number of members in the organization."}},"title":"ListMembersResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-organization-team-members.api.mdx b/platform-api-docs/docs/list-organization-team-members.api.mdx index 20d771d96..7eca47d37 100644 --- a/platform-api-docs/docs/list-organization-team-members.api.mdx +++ b/platform-api-docs/docs/list-organization-team-members.api.mdx @@ -5,9 +5,9 @@ description: "Lists all members of the team identified by the given `teamId`." sidebar_label: "List organization team members" hide_title: true hide_table_of_contents: true -api: eJy1Vttu4zYQ/RWCTy3gtdO9FKifmm2yRdDsdpHLk2EgY2lsM5FIhaSSeA39e2eoi2XLsJW0fbJFHs6cuc9aelg4OZ5Ij5A6OR3IGF1kVeaV0XIsL5XzTkCSiBTTGVonzFz4JQrGCxWj9mquMBazVTheqCfU4o5vL+K7oRxIk6EFlnYRV/L+tgvQ6kc4vCHg11IyYTOwkKLnj/FkLTV90BtjF/R2IBUTysAv5S7LtkSh8xStijbkLNOw+Jgri8TB2xwH0kVLTEGO19KvMtaitMcFWoLOjU3Bl0e/fpRFMWiolHYd5MIW/a8cUnipCTzmaFcdBl/hRaV5IEF+5YBZdHlCcfSG/vrc6qE4wznQ2VjcfToJcepJ5sP7LTJmPnfoD/P5to+He1CZIMEig4XSIXJtUv+Gk0Ow0XKXU0eW81bpBd3oPElglmAZlqKYcqRcZrRDx/j3Jyf8s5Nyf9HLyBAf7fkWsixRUbBjdO8Ysu6qNLN7jNhbmeWy8KpUUJVWCwjWApNWHlPXVwAX2PFU6mRLeLs3Y4uBzF1fuRX4W4hB18nbSm8JydGqu4lpF3BpTVBP7lPJcXHnDBMQxxQ3d0zmXFnn+9H8wlDRh2gCfWVeQk+R8AQe7HGBpwEnVAoLFLdXl6GqDgm2JtnLEykHeBSYZx0CXD4Jac4FYqiNG8sj4uUdQ989QYih6/XGK89auVVfsX4q2OasTMGz2Zk3zG/HPC4F9tUec5ygDIyWRD8YHEpd0FuaIAqCrd54SK7VD+zTRDqtnB+32mitVOmOf4dbBvGUq6baVdVJ6J4RH/f1ks8QC54N6PxrmspmnEzI785R/IOnj7SKEtiJf5v/ubXGdph/2NMF6+EutPG8Jphn4sNwh1FOgViFQf6ZOjLa05zG5Xgy5QZLU35peCFYhOkRJulYjsilbrQOA78YhZVktC5nbjFKmzWBmsdTvSPklvqDXHqfufFoBJkaRonJ46HDR6I2VKYT1etwI74n4Dn+4g/Gi9PvF5KJ1byv2c2ly9rsG6+xxnqq8PcsgOik/POlzqz7Zx/8ofTchOeViysWrPYYQTZXRegqMOcHRCE/to1vm1w1zqD2980FEWHPlXp+Gf72aXjCZ5lxPoWQXtUM5Qzerriw8G1isEV5vUna/2BjrDzs8cWPsgRoivNssWEOlIky4Z2QWYzr3bBcX+mg2dBqqhTTJZnHj9brGTi8tUlR8HG5GXASxcrxAkD5OIfE4QHr3rZb7bXoAVfNNvcESc4IyWtMfzZv36wOMGpWusOkSnCza23AU/6g/hs2qlc596erqqP9LHps9HtNqPcnvWpzakwL2fI6H7dIHVjt30CmytRiSsglQkzdg91VXp5GEWbtIHRGwVYX/fP8hrCw3aJ2WlKQvpcS1UVA3JgH1FQbDUP+ZoJF8Q+3yd4e +api: eJy1Vktv20YQ/iuLObUAIzlO2gNPdWqnMOqkgR8nQ4BH5Iham9ylZ5eOFYL/PZglqYcpSLLbniTuzs588/5q8Jg5iG/BExYOJhGk5BLWpdfWQAwX2nmnMM9VQcWU2Ck7U35OSuSVTsl4PdOUqukiHGf6iYy6k9vz9G4EEdiSGEXbedrp+4czNPpHOLwmLL60miGCEhkL8vIR39ZgsCCIwXJ2nkIEWgCV6OfwEuW6RmWqglgnK3AsMJgeK82UQuy5oghcMqcCIa7BL0qxoo2njBgimFku0LdHv3+EpomWUFq/dmIRj/5XDAU+9wAeK+LFAMEXfNZFFUBMiSVhTK7KvVPeKiZfsRmpU5phlftY3f12FPJ0IJgPxxtg7GzmyO/G83UbDvegSzWzrErMtAmZWwf1bzA5Qk7mLzENdDnP2mQQganyHKc5tWlpmolkypXWOHIif3x0JD8vSu5viCCxxpPxcotlmesk+DG+dyJSD03a6T0lEq2SpS28bg10rbUmiMwooLWnwh2qQBpsfykNqiW83VqxTQSVO1RvJ/w15GAY5E2jN45YstVPE7vewK03wTwVqPP96s5ETGGaMjm3T+dMs/OHwfwsouoQoDkeqvMCD1SJT+iR9ys8CXJKF5iRurm8CF21SzHbfCtOMlUhq8B+NyHB7ZNQ5tIgltFblhXx/E5E3z1hyKE76I3XXqzKqL4U+02zOmtL8HR66q3ge+GetILEaos7ThXok7k2WXA4tLpKWHtijcFXbz3mV/oHHTJEBqNcHq+N0d6oNoP4jjYcki3XbbXLbpJA04jEx22z5BOmSnYDOf+aobJaJ7dQkHOYUYj0nlHRCg7yv47/jNnyAPmHLVOwX+7KWC80wX6nNKhylFSs/SIs8k+ETHxS+TnEtxMZsAX5uRVCkIXtETZpDGPLmRvXYeE340BJxnW7c5txsaQJjvip5wgV5xDD3PvSxeMxlnqU5LZKR44eiXGk7SCrV+FGfcvRS/7VnyKvTr6dgwDrcV9JmNuQraNfRk0s9ltFvqdBCKLuz+e+su6/+xAPbWY2PO9C3KEQs/sAirs6IdcJS31gEupj0/l1l7vBGcz+sbpoIpDItXbej94fHY+O5LC0zhcY6qtbolLCmy0XGN8qCRuY61XV/geUsQuxp2c/LnPUJiwXDougrZRbIYWCIu7JYctfI4iXFK2HOolgbp2XR3U9RUc3nDeNHLfUQKoo1U4YQArxDHNHO7x7G7na6tEDLZZ07gnzSiRAeMzhaN5OrXYgWnK63aBa4SXZWglP5IN1S6leFdxfLruR9qs6gNJvdaEnUGaxjmnpWqiW18V4DdQObv8GMF2lNpMmgjlhShzC1V6eJAmV60kY7IKNMfrX2TVEgJsz6sVMCtq3QqrrVuLaPpBpmhVC+RaATfMTxj3eQw== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all members of the team identified by the given `teamId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-organization-teams.ParamsDetails.json b/platform-api-docs/docs/list-organization-teams.ParamsDetails.json new file mode 100644 index 000000000..5d98b4707 --- /dev/null +++ b/platform-api-docs/docs/list-organization-teams.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Free-text search filter to match against team names.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-organization-teams.RequestSchema.json b/platform-api-docs/docs/list-organization-teams.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-organization-teams.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-organization-teams.StatusCodes.json b/platform-api-docs/docs/list-organization-teams.StatusCodes.json new file mode 100644 index 000000000..255b89f38 --- /dev/null +++ b/platform-api-docs/docs/list-organization-teams.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"teams":{"type":"array","items":{"type":"object","properties":{"teamId":{"type":"integer","format":"int64","description":"Team numeric identifier."},"name":{"type":"string","description":"Team name."},"description":{"type":"string","description":"Team description."},"avatarUrl":{"type":"string","description":"Full URL to the team avatar image."},"membersCount":{"type":"integer","format":"int32","description":"Number of members in the team."}},"title":"TeamDbDto"},"description":"Array of teams in the organization matching the query criteria."},"totalSize":{"type":"integer","format":"int32","description":"Total number of teams in the organization."}},"title":"ListTeamResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-organization-teams.api.mdx b/platform-api-docs/docs/list-organization-teams.api.mdx index ac0ac38a9..5045e2a9f 100644 --- a/platform-api-docs/docs/list-organization-teams.api.mdx +++ b/platform-api-docs/docs/list-organization-teams.api.mdx @@ -5,9 +5,9 @@ description: "Lists all teams in the organization identified by the given `orgId sidebar_label: "List organization teams" hide_title: true hide_table_of_contents: true -api: eJzNVktv40YM/iuDObWAa6f7KLA+NbvZFEG37SLxngIDoSXKnkSaUWaoJF7D/73kSPJTcbLupSdbQw75kfyG5EITTIMeXmtCKIIe93SKIfGmJOOsHuovJlBQkOcqKihjFc1QOT8Fa76DaCmToiWTGUzVZB7FU/OAVt2w1kV601ejeBU8C7yryqBctm2hwGKCPvBdIJWAVRNUkKZsEIIqwZNJTAmWkZBTj87fhRISDH3d065EH41cpA3cfzYsR8+sxTagQGIfHOtCW/5g7YiPpUYiLYFmejf8TVvKVgV6k6zj9QLA431lPLJ38hX2dEhmWIAeLjTNS/FiLOEUPatmzhdA9dFv7/Ry2VtBKeCpBXJfoZ/vIfkLnkxRFQKCUyUZ9BiqvE6JR6q87aszzIDPhurm/cmNgHslmLdvtsC4LAtIh/H83YUj3JlSsWGu2dTYmLVNUP8FU0DwyewwpnOP+AvhE6laW2Um55oLMjbL3zAFYwNFLisxHDoBBfLGTtn9WMobSmcDBpG/OTmRnx2O/Mk2EsdBWBIplGVukhj84DaIymLfhZvcYiIpLr0wmEztoH6FazXwHiROQ7h1fuC6vIOXubebulHMSAfBl72mArvZ6bbAqvHOluxVVzeOogV4AAL/zecv3z+vuD99u/wihZb2E8tb31emgGkNqWkyn1xV1+kl9j3P+LZdNc1Q3PWFrJoM5dgEdDY5I7eXCn0qFRUjz/fTyFWOM0oi0xUbYCIbiIGQI8ivzHc8JoqRXN7oIs/C2I5IGqtEddk8BxaK+F3Xg/gIqZKuiIF+5GWsG+k11yoErpvMo8OMbxU7Hu8a/Gfvnd9D/rbjKbfDRFlHMvXcI+MR9YBJxTWYx/HxkbsL+tOKB8bweixdgmfLzMkAmsa+GWfJUA84n2GwiGNmOaBmFgX0D+0gqoTeekZUhuFgAKXpJ7mr0n7Ae0bSN26vfldRor7mQFJp9Un01enXCy04WphXktU6Q5tgV0kSj23nk+9JVOKT+s95y6HbR4rhG5u5eL3JaINC3L4EUMI1PKwbZaEDJJEO28FvhsyMMHmkcOZ+XwsYiGSu9vNr/8P7/omclS5QAZFNzbAQtm6/qTb5O31pRc7//6LTVE7G26DMeY5J6FXdHmu+XctCI0EO28VmtdTNOEWisFhMICA31eVSjusxKkRMTYBJLo8vgzzggUQdt4h0or/D+Wr1eYC8Eg0tM//1aI5fQw4gWu0/R4I6cg85gGi1/awRjeWDR8JEHuQPVfCny6bT/qxesd92omrXEzvfxLTKX6TfcsyKM4SUG4sArGWnSYLlZm73hsJWP/3j84h1Ybt77XSraL0TEdM9aozcHVqmfAuQ5FsALpf/AtaXfeQ= +api: eJzNlk1z2zYQhv8KBqd2hpUUJ+1BpzpxnPE0bTO2fPJoxityScImAXqxtK1o+N87C5L6tuyol5wkAgvg2cWL3V1ohszr8Y1mhNLraaQT9DGZio2zeqy/Gs9eQVGoYKCMVZyjcpSBNd9BrJRJ0LJJDSZqNg/TmXlEq24dZRfJ7UBNwlIgVBm5uvLKpZs7lFjOkLziHFjFYNUMFSQJJgq8qoDYxKYCy16xU0+O7n0FMfqBjrSrkMImF0mH++/azuFkHekKCEpkJPF1oS2UqMc68OlIG/G0As71tvvreylbl0gmXvlLAkD4UBvCRI+Zaoy0j3MsQY8XmueVnGIsY4akI506KoHboT8+6KaJliglPPcgDzXSfIfkb3g2ZV0KxAxJIkjo66INCSHXZAfqDFOoCx6r299HtwL3Rpj3JxswLk098mGef/Zx+HtTqdSRqiAzNkRtHer/MHkEivPDTOeE+BvjM6vWWqWmYCQhK4HjXEEGxnoOWlaysd8L5JmMzXTTTOV6feWsRy/zJ6OR/Gxp5C8d6dhZRssyC1VVmDg4P7zzYrLYPcLN7jCWEFckCmbTHtC+wpUZEIH4aRg3xg8sl3fwuva2QzcJEdkj8CbqbmA7Ovt3gBLDmo25Ny1dGwo7wCMw0DUVr68/r4tCXV9+lYuW9BOut12vTAlZi9QlmU+ubu/pNfW9rPg+XXXJUI4biFg1Gy6wc+hsdsZuJxT6VG5UNnk5nwatGpuFmaB0FZNhJAPBEXYMxZX5jsd4MZHFa1nkRYxNjySxileX3XPQTSPTH/Y9iI+QKMmK6PlHXsYqkd7oEr2HDKUeHVZ8b7jn8a7gPxM52iF/v+cp98VEWcdS9dwTJmErj3FNhuehfHxEIKTTmnM9vplKliiRcycFKAt5M9SSsR46yvxwEcpMM+SuFnmkx74Q1SJvnTNXfjwcQmUGceHqZODxAQkGxu3c31WYUd8KYLlp9Uns1em3Cy0cPeaVRLWN0DrsMkhyYp/55HsWjHTU/TnvNXT3xMF9Y1MXlncR7Sjk2NcAxV0To++MRQ4QBzlsOr/uMpZgiiDh1P25mmgiLZFrz3k3eDc6GYxksHKeSwhy6qqFyHXzUfXR30pMS3X+/J1Od3VS34ZVAcaK63WbH1vB3UhHI06O+85m2dXlzrMYLBYz8HhNRdPIcFtHRYmJ8TAr5PWlUHg8EKjjOpG99Pc4X/Y+j1DUYqGl6L+d5vg+5ADRsgE6EurIRuQA0bL9WRFN5YOMIP3gDf5y2aXaX9UbGty9VH1/YufrTMv4Bfk10ybSOUKCFADbudM4xmo9tjtVYSOhfvk80ZGGzfS1la7C7nuJFovWYuLu0TbNEpDlWwCb5j96TX4J sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all teams in the organization identified by the given `orgId`. Teams are g id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-organizations.ParamsDetails.json b/platform-api-docs/docs/list-organizations.ParamsDetails.json new file mode 100644 index 000000000..34bccdcb7 --- /dev/null +++ b/platform-api-docs/docs/list-organizations.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"role","in":"query","description":"Filter results by organization role. Accepts: `owner`, `member`.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-organizations.RequestSchema.json b/platform-api-docs/docs/list-organizations.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-organizations.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-organizations.StatusCodes.json b/platform-api-docs/docs/list-organizations.StatusCodes.json new file mode 100644 index 000000000..a95a57d52 --- /dev/null +++ b/platform-api-docs/docs/list-organizations.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"organizations":{"type":"array","items":{"type":"object","properties":{"paying":{"type":"boolean","deprecated":true},"orgId":{"type":"integer","format":"int64","description":"Organization numeric identifier."},"name":{"type":"string","description":"Unique organization name."},"fullName":{"type":"string","description":"Full display name for the organization."},"description":{"type":"string","description":"Organization description."},"location":{"type":"string","description":"Organization location or address."},"website":{"type":"string","description":"Organization website URL."},"logoId":{"type":"string","description":"Logo image identifier for the organization."},"logoUrl":{"type":"string","description":"Full URL to the organization logo image."},"memberId":{"type":"integer","format":"int64","description":"Member numeric identifier for the requesting user within this organization."},"memberRole":{"description":"Organization role of the requesting user. Accepts `owner`, `admin`, `maintain`, or `view`. See [Organization user roles](https://docs.seqera.io/platform-cloud/orgs-and-teams/roles#organization-user-roles) for more information.","type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole"},"type":{"enum":["pro","basic","academic","evaluating"],"description":"Organization type. Accepts `pro`, `basic`, `academic`, or `evaluating`.","type":"string","x-enum-varnames":["academic","evaluating","pro","basic","internal"],"title":"OrgType"}},"title":"OrganizationDbDto"},"description":"Array of organizations to which the requesting user belongs."},"totalSize":{"type":"integer","format":"int32","description":"Total number of organizations to which the requesting user belongs."}},"title":"ListOrganizationsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-organizations.api.mdx b/platform-api-docs/docs/list-organizations.api.mdx index d4bf10efb..14e3dde91 100644 --- a/platform-api-docs/docs/list-organizations.api.mdx +++ b/platform-api-docs/docs/list-organizations.api.mdx @@ -5,9 +5,9 @@ description: "Lists all organizations to which the requesting user belongs." sidebar_label: "List organizations" hide_title: true hide_table_of_contents: true -api: eJytVlmP2zYQ/isE+9ICtrxN0gLxUzZNtgi6bYI9nhYLmJLGFjeUqJDUOo7h/96ZkWTrcLJH+6SDM998c3BmtjKolZfzG2kdPm8nMgWfOF0GbQs5l+faBy+UMQLPVaG/KTrwIlixznSSiZCBcPClAh90sRKVBydiMLZY+UhOpC3BscqHtEH72MVBiVI5lUMARyy2ssAPlHTWAB5q4oDgbiOHzM60QSW07SuDFONNj6EggEicJgmUwc/Fwq4LcIuJWOSQx/hG5HySQa7kfCvDpiSrPjh0Qu52GAcELpEheDp/cXJCjz6Dj38hRmKLAEWgU1WWRidsfnbnSWQ7NmHjO0gC+e0oNkHXBnrR7Ygr5xT5rgPk/mGYUm3IgYNcbDEOquDolQ6QHWAigqtgNyGjlJa9sEZXVuBQeGldrkL96/dXo9h3cyiKKgenE6FTjINeanCRRPA6kcPQDpGuC43p7aeONBliWRnzz6NgzlBSpNqXRm1YX6AHXJtdZAbtKT6E23O0c8RIxtbJfiJMq4bUhEpTrDPPcGuIPab5iWiNlri+OG9IrWwvqd8BOUc5oXO1gk7ivh81gr125pGZQDLUIYZIwuyNMmh9FZ9Xgn+z7pHi2/sw7EprHTJd4JH2Y/9qKhfUdcb3fNhXhF0es7BvN51uo9JcF9x2FPqh+B35Le41rBeRuAQQNz18pkpG/O3PWQiln89mqU185OELttJI2xkWeaDoTBNjq3RGjXuqinQaQOV+xro/dR2cEuaU///C0cmtw6wXdYQ5ApNRVgEjy2OBPJFtgLjhGaNii13dOpoXX6ckOr1Xju6df5RO0IECTZHlkO9a+9u9XexrqBgrrxN8qkSlkPMr3CtTKQr6eFr1IkmInZQgIOWBETkzDWSTkAPs4lg4jnh5nNNkwJwKGnXMwO0rwt/tev/21N/F74Id9Sp5SrOAau85o5hM2aDMpf4GD963ly9G9+2KlOm60a17LoeOv6NV4KKZtyhFcq+OTdy3Km3RnzJ6SUU7Gnw3WJPeY//hdPxwlLaCR7aDgxfvnbNuxPzlkR7S7kGisIH2KbtGPiTuIamcDhveft6CcuBOq5Dh5y2tIbgaZZZ2pxUwR0VHki89bTDg7tvNqaL2LNueoUodcX84NI5RTi/5RHxq+on4g+TF6acPkiy3xC4pjnVMuvT2YSGL7TLFKwcL0RXgl7O2ru7WgR2mxsPqTQwbFmT2IYLkrk7AN8JUACrhAug733UZa0AbLuulfXM4QCIUudrOr9Hr36IT+ldaH3LF9dNsolSo/Wof0tweKvE/78tNTAN8DdTncf9FUlU9eOvcHzb1DLnS93aLzQZwOu929Ltel6kicCFSsaG6Xyrj4Qe0/4dl+ijzz7A5LPPUJEmEqws7qSZyXOfoC2Azdcy61qmNdbRGV7x3O/58f0Vjol+Zg0pk9HavLjYdbIwgS1zZz1BgFFvigb7REN7rfwGCYpzI +api: eJytVt1v20YM/1cOt5cNkO00Lfbgp6VrMxTL1iIfT0EA0xJtX3q6U3hUXNfQ/17wJNmS5TZptifLd+SPP34cya1mWAY9vdWelkHfJTrDkJIp2Hinp/rCBA4KrFWeluDMV5CLoNir9cqkK8UrVIQPJQY2bqnKgKTmaL1bhrFOtC+QosqHrEH72MXRiS6AIEdGEhZb7SBHPdXkLepEG+HwUCJt9CGzc2MZSRGG0nJQ802PoRKAsTpLUyw4TNXMrx3SLFGzHPM50kzIhXSFOejpVvOmEKuBybilrqq7RBOGwruAQe5PT07kp8/g49860al3jI7lForCmjSan9wHEdkOTfj5PaYsfpPEhk1toBfdjjgQgfhuGPPwNEwBG3FgLzf33iK4GL2CMAXGTE+ZSqwSMSpp2Qkbx7hE0oleeMqB66Pf3wxi382hcmWOZFJlMnRsFgZprKukSeRhaA+Rbpx5KLGfOtGMEIvS2n+fBXNeWqsyEwoLm6ivFp5ibXaRI2hP8SncnqOdq4hkfZ3sn4Rp1ZQnBVlGGEKEW+M8GH6Gsz20RkvdXF40pJa+l9TvgFz4pVcmhyV2Evf9qAnsDdlnZuLm8kI6xCGSsjujEbR+ii8rwX+i7pHi2/lw2JXWhlfGKV6ZMPSvpnIpXWf4zg/7ivKLYxZ27abTbSDLjYttB4xjiN+e1OzR4Ho2VleI6raHH6mKkXD364q5CNPJJPNpGAd8QIKx8ZPCAkt0Rqn1ZTaRxj0Cl40YIQ+TqPtL18GRYI7i+W8xOrknVMbVEY4RSAZZRVfmcSyIJ7oNUGx41sLcE7AnmRdfRiI6egSSdxeepcOGJdAS2RjyqrW/3dktyOtEzyGYVCcaUsgwj5/4CLYECfpwWvUiKYidlBTkJQ8RMWamgWwSsoedHQvHES+Pc0oOmEtBkwN74Pa14FdV72xH/d38HftBr9JnMguk9l4yisWUZ7BX5is++d5enw7e27Uoy3OTV/dSDh1/B6vAZTNvdVWJ3JtjE/ctZC36z4xeUTEkg+9W5xgCLDGm44ejtBU8sh3svXhP5GnA/PWRHtLuQcp5ln3KrzGLUAHTkgxv4vbzFoGQzkpe6entnawhOfLKy+60xMgR5ErHRy8bDNJjuzmV0p512zOgMOPYH/aNY5DTq3ijPjX9RP0p8urs0wctlltiVxLHOiZderuwiMV2mYorRxSSJxA/ztu6ul9zdFgaT1RvYtiwELNPERR3TYqhEZYCgDQWQN/5rsuYg7GxrBf+j/1FlWiJXG3n1fjVyen4RA4LHziHWEDNKiqV2i/3Q57bfSn+54W5CSrjF5ZGb5yQKuvJWyd/v6qvfGD5v93OIeAN2aqS43pflpLITIC5lcJfgA34A9r/wzZ9lPln3Oy3eemSIhLL6xHICLlY6IleIWRIkXWtUxvraA3eeO95/PX+WuZEvzQPSjGit4u123Swt9ta4tp/RldVuiXO8l9Xd1VVfQOyM5zt sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all organizations to which the requesting user belongs. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-pipeline-repositories.ParamsDetails.json b/platform-api-docs/docs/list-pipeline-repositories.ParamsDetails.json new file mode 100644 index 000000000..ff412fa96 --- /dev/null +++ b/platform-api-docs/docs/list-pipeline-repositories.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, lists repositories in a user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-pipeline-repositories.RequestSchema.json b/platform-api-docs/docs/list-pipeline-repositories.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-pipeline-repositories.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-pipeline-repositories.StatusCodes.json b/platform-api-docs/docs/list-pipeline-repositories.StatusCodes.json new file mode 100644 index 000000000..d1b0da86b --- /dev/null +++ b/platform-api-docs/docs/list-pipeline-repositories.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipelines":{"type":"array","items":{"type":"string"}}},"title":"ListPipelineInfoResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-pipeline-repositories.api.mdx b/platform-api-docs/docs/list-pipeline-repositories.api.mdx index 2e0db1aba..8d4ca487c 100644 --- a/platform-api-docs/docs/list-pipeline-repositories.api.mdx +++ b/platform-api-docs/docs/list-pipeline-repositories.api.mdx @@ -5,9 +5,9 @@ description: "Lists known Nextflow pipeline Git repositories, extracted from exi sidebar_label: "List user pipeline repositories" hide_title: true hide_table_of_contents: true -api: eJzNVE1vEzEQ/SuWz9GmQEEiF0hRqSIQVC2IA6pUZ3eSuNm13fFsQ7TKf2dmP5LNh4qQOHBKvH72vPf8ZipNZh716KcONkBuHUR9N9AZxBRtIOudHunPNlJUS+dXTn2BXzTL/Up1eHVlSSEEHy15tBAHiiFoUoJMzdAXvOTz1s0Vli4mahwCuEzdv1t5XMZgUphk94q8yhm2d5OyThm1hanUO+K7Ez3QPgAaoTfJWoLXLZ+b3gUMDAZNAQQoIivteMEHeqUZY0XkYwm41ofSf2yLu7IAtKmyGTiyMwuYqMlM+cISKx3U7OMJ+mUE7DOP6QIKo0eVpnUQLpa35oC8NfNYGGo+vTnXmw2/BEIM3kXWwidenp3Jzz7Fr5/4aF3AkeyaEHKb1uYMH6JAquOifvoAKYk/KFaSbQrsQrCDGkQjxliCov89EvKjMsvNQJOlHA4eYuJm/qZlLyiGnZ/if2Eyto3tj/Q3QuSIRcgkuwXEaOYgyX1eXwc8oWIn4hLR4xHzVyec70KonCdlcm4L5iPwCGmJltZ15i7AIOC4pAUv7+RROZALL8GdQ83RyJYebt0f4n6IOUJPXYJLzBm7IApxNByaYJM092WWRHhkNon1Rxm+rXfUdW5IEqY+CF6NrydauHRUb8XZxqU+4a1RUrGLr6ynNYi/NH8+dtl9WFFtgeXnr4+3rrYspOyfCIpcm3IDNWCJBI8TuWxffF8yp8LmdevM/PvdBhMR55o6L5K3r5Mz+cbuUmHqRLUTQZLb9Op2sB08wh7nahfU/3E8tm8my2HIDQ84Fl2bV7Vp6w98mTI9qRyKBfsjmKqamgjfMd9s5HMzIyWFmY1mmkv3zUwe4Rl3/v0EPSluCeujuf5k8lKQdc6fDFqhXPcgKwSTcXxFS3N0nKYQqHfqaPzsde7V5TfGmv0eOeiJ+vZuirp17272tUZ880tw7G3Hn2TNhXjm/AZkD6u5 +api: eJzNVMtu2zAQ/BViz4KdPtCDL21apIHRog36QA+BgTLSyt5EIpnlKo4h6N+LpSVbjo0WBXroyRY55M4MZ7cFscsIs2sIFLAihxEWGRQYc6Yg5B3M4CNFiebO+bUzn/BRysqvzYA3lySGMfhI4pkwZgYfhW0uWJiSfW3wkaKQWxpuXJyY8xDQFebn67XnuxhsjvPipxFvKoqHNxlyxpodzOTeCT7KBDLwAdkqvXnRE7zq+XwZXQAZBMu2RkFWkS04WyPMYFQaMiAVed8gb+Cp9B+74q6pkSk3VKATKgl5Yual8TWJYJEl9vEE/SYij5nHfIW1hVkLsgnKhZzgEhkyKD3XVrZLr15C1y0yYIzBu4hRTzw/O9OfQ4qfP0AGqYAT3bUhVJQnc6a3USHtcVF/c4u5qD+sVgptC+xDsIdaZqvGkGA9Xo/C5JbQdV0GQlLhk4eYu9J/6dkrqsvg5Sn+b21hGO8bjPI3QvQIMRaa3RpjtEvU5P5e3wA8oWIv4oLZ8xHzFyecH0JonBdjq8qvsUhXRcwbJtmkzL1Fy8jnjaxgdr3QR61RVl6Du8TE0eoWTHfuT/kwxBH5YUhwwxXMYCUS4mw6tYEmeeWbYhLxHtlOyB9l+GvaMVeVFU2Yead4c341B+UyUP2qzm5dGhPeGaUVh/jq900CQdb/eT9k93YtyQJypU/He1d7Flr2TwRVLuUYe7BGwuYpEofix5KxtlSl1in9m/1Gl4E6t63zbPLs7PnkTBeDj1LbFKl+JGh0t826m2xPXuGAdLtP6v84H/tH089pqCw5FZ3ca/u4jSe+jpmR1EUGKx9FMW17YyN+56rrdHk7JDWGBUV7U2n7lbaK+Bt3/v0IPSnuDjdHg/3BVo0iU9AfLJNSTk2YwQptgZy0bI+e5zkGGZ06mj8HrXt58Q0ysIdN8qQp0u3DGHWb0d1tu0V883foug4G/qLf0C26rvsFglKr3g== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists known Nextflow pipeline Git repositories, extracted from existing runs. Ap id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-pipeline-secrets.ParamsDetails.json b/platform-api-docs/docs/list-pipeline-secrets.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/list-pipeline-secrets.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-pipeline-secrets.RequestSchema.json b/platform-api-docs/docs/list-pipeline-secrets.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-pipeline-secrets.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-pipeline-secrets.StatusCodes.json b/platform-api-docs/docs/list-pipeline-secrets.StatusCodes.json new file mode 100644 index 000000000..9a0e83d6e --- /dev/null +++ b/platform-api-docs/docs/list-pipeline-secrets.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineSecrets":{"type":"array","items":{"required":["name"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true},"name":{"maxLength":100,"pattern":"^[a-zA-Z_](?:[0-9A-Za-z]+|(_)(?!\\1)){1,49}$","type":"string"},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true}},"title":"PipelineSecret"}},"totalSize":{"type":"integer","format":"int64"}},"title":"ListPipelineSecretsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-pipeline-secrets.api.mdx b/platform-api-docs/docs/list-pipeline-secrets.api.mdx index f53bff185..d81897812 100644 --- a/platform-api-docs/docs/list-pipeline-secrets.api.mdx +++ b/platform-api-docs/docs/list-pipeline-secrets.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available pipeline secrets in a user context. Append `?w sidebar_label: "List pipeline secrets" hide_title: true hide_table_of_contents: true -api: eJzFVd9vGzcM/leuwh4SzL+yZQXil9QtuiFYgQZNiwFLs5a5o20lsqRIvKTuzf97Sd2dc46NNkUf+mSf+JH8SH0iK0Uwi2p8rrz2aLTFfsQ8IEV10VMFxjxoT9pZNVavdKSYgTEZ3II2cGkwa72yxivTNoOsjBiy3FnCTzTIJt6jLbKPx3cuXEcPOZ4UHzNymeGAm45rxNpb9ZTzGEA4nBQNi9Mm61lDtac8BFggYZBaKmX5g7GdhIzRUsRNiWGpHpb2zzqvLRcYdJ7pAi3pqcbA4JjPcQFqXClaegmsmdwsmaYuLIDqo6eHarXitgWM3tmIUTx+G43kZzPf67/ZNZVoSazgvdF5KnJ4FQVSbSd1l1eYkxQbpCWk6wT+QTPuHSAEkFo14SKdB7wpdcBC7ju1iMl+PbguHlN1T9nSJEGoMYUSV73mBiq1gE+v0M5orsYHo5FcFPEtSQ/+O4f+50n/3w8Xe8fj81H/iP/zycWv/+992N87fvL+/cH+fnXQOzxa/aLWPCMFbWeKMxiI9C5il2Bj7PArgLBPmrnItUDx2prlmqMYX/Ap/UiQRMMXPxKEo5AmaZ7aVLZKJkdgzvRnfJz+7mPteClvGmUyTpCHu7T5HIpMhIKRvkekXW0tMEaYPUJeLXCrcd06Xobgwhbz33e8qnZQZNaRDCp3x3wEzkOmDJqWaTg8RwgYJqVo8vxCHixPjrmT4TLDxBHEpIZbI1EChdt2yJTBMGpO5ON4OASvB7lxZTGIeMM8BtptjZmzZMlODZDcW/ZC8Nnk9EQJi5bkmfS07k+X6rpFkrEdSvJ9mUB8Uv/5s1XE1V0tIG2nLrk3/WxYSNpvEZRydY6xAYsYIE9i2Cy+WzLrQZskyKl7dm9gItK5Os/B4OiPwUjOvIu0gKSlZmiLbLf2ykOm1b0wf9peaq5DPofeAK8Xrif1pWoktHurzrlksVXVJUR8F8xqJcf1ZhJhFTpKESzIKZiIXyn9G3trJ8NrXG6txlswpSCTDm8h6HqW8+tgujysOJoQq10neY6eOl5bg2HjTf318i1jYVPDDzSbordbyy47sblJCfHWXaPlRrX8Sb45EU+DL6fOBh8= +api: eJzFVdtu20YQ/RV20AcbpW6pUSB8cZUgLYwGiBEnKBBFTcbkSFp7ubveHdqRWf57MUtKpiyhdpGHPkncuZ0ze3amBsZlgGwGTjnSytAgUO6JA8xTKCjkXjlW1kAGb1XgkKDWCd6i0nipKdlEJV1UokyCSRXIJ7k1TN94mEydI1MkX0/vrL8ODnM6K74mbBOtAu8Gbj220ZCCdeRRMJwVHYrzrupFBzUFhx5LYvLCpQaDJUEGvYKQghISNxX5NTym9ue2rqlK8ipPVEGG1UKRhxRCvqISIauB104SK8O0jKaF9SVye/TLCTTNPAVPwVkTKEjEi/FYfnbrvfsDUogUDYsVndMqjyRHV0Fc6v2i9vKKchayXlrCqi3gHjXjIQC9R+GqmMp47ummUp4Kue/Yonn6RHJVPId1CqbSURCQsa+oSbsbqKHEb2/JLHkF2WQ8lotiJi89+GuGg/vp4NOX+dFpNhsPXk4Hn3BwP//p76Mvx0enP3z+PDk+rifpycvmR9jiDOyVWUKTgsbAHwP1AXbGHr4CmQasSgK5FizeGb3eYhTja0/I35MkwnDF9yRpUmDF0jzYVTZEk2XUF+qenqe/h1wHXsr7TpnQNOJ5ckibr7BIRCgU+L+ItK+tkkLA5TPktXHca1yfxxvvrd9D/vOBV7UZFImxLIPK3lERUwXKK694HYfDK0JPflqJJmdzebAl8crKcFlSxIhigtHeSJRE/nYzZCqvIYMVswvZaIRODXNtq2IY6IY8DpXdGzMX0ZKca2S5t+S1+CfT8zMQFBuQF9LTtj99qNsWScXNUJLvy+gEaffnt40iru5aASmzsDG862eHQso+BVDoqpxC5yxiwDyKYZd8nzKVqHQU5ML++mBoUpDOtXUmw8n4xXAsh84GLjGKqZvaotu9xfIYav2gzP9tMXX3IZ8jp1EZ4RMbU3caOrxWVzaw2Or6EgN99Lpp5LhdTaKsQgUhUUC2QB3oX6g/sbgOIrym9d5uvEVdiWcU4i161Q7z2bxJYUVYkI/A2tBpnpPjXtTeZNh5VL+/+QAp4K6IH4k2Zt+sLbPu5a7r1uODvSbTNLDBz/INzbxpmn8ANzEGRA== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available pipeline secrets in a user context. Append `?workspaceId` to id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-pipelines.ParamsDetails.json b/platform-api-docs/docs/list-pipelines.ParamsDetails.json new file mode 100644 index 000000000..4a41426a3 --- /dev/null +++ b/platform-api-docs/docs/list-pipelines.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"attributes","in":"query","description":"Additional attribute values to include in the response (`labels`, `optimized` status, `computeEnv`). Returns an empty value (`labels: null`, etc.) if omitted.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","computeEnv"],"x-enum-varnames":["optimized","labels","computeEnv"],"title":"PipelineQueryAttribute"}}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of pipelines to return per request.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Free-text search filter to match against pipeline names and descriptions.","schema":{"type":"string"}},{"name":"visibility","in":"query","description":"Filter pipelines by visibility. Accepts `private`, `shared`, or `all`.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-pipelines.RequestSchema.json b/platform-api-docs/docs/list-pipelines.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-pipelines.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-pipelines.StatusCodes.json b/platform-api-docs/docs/list-pipelines.StatusCodes.json new file mode 100644 index 000000000..95b8e72ef --- /dev/null +++ b/platform-api-docs/docs/list-pipelines.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipelines":{"type":"array","items":{"type":"object","properties":{"pipelineId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"repository":{"type":"string"},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"},"userFirstName":{"type":"string"},"userLastName":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"visibility":{"type":"string"},"deleted":{"type":"boolean"},"lastUpdated":{"type":"string","format":"date-time"},"optimizationId":{"type":"string"},"optimizationTargets":{"type":"string"},"optimizationStatus":{"type":"string","enum":["OPTIMIZED","OPTIMIZABLE","UNAVAILABLE"],"title":"PipelineOptimizationStatus"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"computeEnv":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"}},"title":"PipelineDbDto"}},"totalSize":{"type":"integer","format":"int64"}},"title":"ListPipelinesResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-pipelines.api.mdx b/platform-api-docs/docs/list-pipelines.api.mdx index 7dbced1bc..0112d7f15 100644 --- a/platform-api-docs/docs/list-pipelines.api.mdx +++ b/platform-api-docs/docs/list-pipelines.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available pipelines in a user context, enriched by `attr sidebar_label: "List pipelines" hide_title: true hide_table_of_contents: true -api: eJzNV1tvIjcU/ivWPHUlQtLdbaXyVHKrUNkku0laqatImJkDOPGMvbaHhCL+e8/xXIFhQug+7BOMfezznc/nugwcn9qg9zXQQoMUCdjgoRNEYEMjtBMqCXrBUFhnGZeS8TkXko8lsFKciYRxllowLFSJgxfXYZAYEc4gYuMFG3HnjBinDuyoy/paQxKx0bMyT1bzEAbRiDnFJKrYvLOUKS7uBp1AaTCccA2iHNlNCbwTaG54DA4MmbQMEvxAqQoBigiy6FsKZhFs2tmPIkF/ORpaHGFzLlNEhBhFEso0AgLnZsAMWK0SC+ynEVIC0o46bKTwrlj8C2iVddylFtdCFWu86SKZj9512RdwqUmQzoRBrN0iU1Be0mNJKiVeBS7svmNiwlQsnIOIjIcXLVWEJk24tNAJLJIc86C3DNxCe0uN4WSXcBDb2rpFa5Ip3ZCkMb12iRPXMsX4pwJKPvByRMJHc26IRrvnKSecJI3Fq3wmpvsFm8FqteqU71JzgvaH+bv0BEQE6FtMRJA4MRFgiJctHgT6yxQMbk2UibnLln79GNTVx/ylXe0n/iLiNCalY3RvNal5KPqD8S/J0CHxL95g3RuwfHi/hkVNJhZcO5yrEga6XiqdB2GfhGZ4MdN8KhIfGV12DhOOAj02OhkdjskCN+GsHdOlATii2GSZNJsIieFHyPBa/OZTLpJabDPvTOj9EavdZBtR5l5bxzQXVoyFFG7xCq4MRvVemImqs5iHwhA0MjjSRsy5A4pdO+MGA7fDkM0RZrtm6kpQ6OxFCvCh9v7khH7WcVz/6SME6U4c7XKtpQj9Mx0/WhJZbqtQ40cIyRm0oXTnRKagytCvB/wrV1Dy3CNYOjntW8Zv0N2wL8IdGwa0ssIpfLSmbSoke6Mj4atdCGnzUhjrWiWGvEVAmeneWFB25z31RLffbeWJnXfWIqH5fSTWwbq6sVISeEKbEo2+1xFfFyiLRAmHJI4w5YM3MEv+ZfFt4qsmcsfNFFxDEdqQu/Vlsq1WXd/cDT4N/rk4x7X8f/90eIFf91f9v/qDof9qqD3X22pWZeE6OIbE/44dX/F3BIdVqQmh+dmEzRP7zu0F6hThru0BgjVaSb7TMejBzwy8xTFWFe9DYvZ8fO6UX641Bm8jteJjJ4UajSA0O1icNqelGtazElwFeNN/ajvKcXmLnc+ePUZFSb1B/ZKXC+qCUOZjU8E45VHRTbylctARYejVvgZYXy2fgo+IVtILwVaiLoxRZgv5h4ZSV3TmLFGOpgX1jHhI3EKYGp+osCc/xT4BTD91M/x8oCqKDftMUTc/9R2Q5rQVHOtaX4+Jel409amRuD1zTtve8THXohtKlUZdC98QQFeorWbg1u+wm9xn2BnJs/7NICD1BbpbIjMjpo6x5IY0Fg2BDxsvhCvZn8vCCR6fnbdaJBPlj+dE5ihI7WsAyVwRYteSCZMX8NB7wbrxdZPREYT0PjhRv1cblG6QuUzPz93ffume+PhR1sXcO1HeWQ3XJrBNiMvKFX+ocTB/G/o8xpwgfBbzJC1zR9qYbGdoOC0ul2Nu4d7I1YqWsy6S3CsSliyKyiFrJw8//LjYSM4TLDZH4rweBQE12vvb/9pU1qJ+ffI7UP9B41kLqGwePBDM4cNZC6JyKjwQ1PeczlpgloPioTC/17DWgnFtcKxwPtCHEQTUlyNMEMAjTOuUCrKTmfbaqa1KvFbE/ri4Q1m+Xjs2aoW/veg+kzoiTEte4k49QYKpqYDv6BsVYfn9DwJq09c= +api: eJzNV99vGzcM/lcEPa3AxUnbYQ9+mtukg7G0zZp0AxYEOPqOttXoJFXipXGN+98Hyufz+dfF8frQJ/skSvz4kRTJuSSYBNm/lU451MpgkHeJzDFkXjlS1si+vFSBggCtBTyA0jDSKBpxoYwAUQb0IrOG8JESgcarbIq5GM1ECkRejUrCkPbEwDk0uUi/WX8fHGQ4zFNBVmgVaPPORmZ5cU8m0jr0wLiGeY3sqgGeSAceCiT0bNJcGihQ9uUKgUykYou+luhnctPOQZ4r/gtaNEfEA+gSA2NUJtNljgyOpig8BmdNQPFLqmGEOqSJSK0jVajvmKciEFAZEpFmtnAl4YV5SF/0xCek0psgwAgsHM0WCppL+sKUWqeJQMp6L4QaC1soIszZeHx02uYo+2PQARMZsikWIPtzSTMXLfUe2C5FWITWeiCvzIRvMGXB3m5wykQuFMtEroByDDyesPDJA3imMRx4ihRp1rj0yl/M9GDJpqyqKmn80gqCbsf800SCKQv0KhMqR0NqrNAzL1s8KEM4QS8TOba+AFos/farbKsv4LFb7Xt4VEVZsNIRemHHrQglK3z0pHDohcevJQZ6BpbXr9aw2PE4IHXD+dDA8BhKTRFEuFdOjK0XDibKxMzoiXMcQ6mpL9Kz9HhMAcFn025M7zziCeemWEiLsdKEnpEVQNlUwASUaeW2iMEkwOSidVPYibKO2jamBxXUSGlFsydwLWCs/DWaidXZnhhkGToKInVePQAh526Ygsc8TYT1IgWtd1PXgLpL5PIJiKn26uyMf9ZxfPwzZoghNMS74JxWWXTT6ZfAIvNtFXb0BTMOBuf5uSO1ULB6oZ9O+Ceu4MfzgGRJatq3jN+ge8e+yvZseHQ2KLJ+tnObC8nB6Fj4wz6EvPlO+UCdEpfQIWD95GAs1k/23tN+6A67rTmx985WJuz2j0bCtrqRtRrB8KaGQJ9dDusCTZFo4LDECakCo4GLx78pvrv4aoncgJ8g7ShCG3LXsUx21aqPVzfD98N/L85lsvw/eHN5IRP5+cPg78HwMn7tqD0ft9VUTeE6OofU/86dWPH3JEewpc9wt9tUqB/2vdszA4XK9m0PDaF3VsPewGCHv/X4nMCoVrxfMrPno3OycbnVGDyP1BUfeyl0GojR7GFxsvtZamF924BbAd6Mn9aOJdDX6jse5Po2Je0G9VNdLrgLqhL5666C8QbyZTfxnMrBR5Rnr93KAkOACcaM6CR9KdhJ1IX31m8hf72j1C07c2Es8bRgv2EerwqYlT4+VLdz+QbBox+UNJX92zuuogXS1HI3P4kdkAPekqeu1dcH9A/Lpr70WvbllMiF/ukpONXLtC3zXsCv6KGn7FYzcB13xFUdM+Ity4vB1VCy+iW6ayZzQUwbY8MNa1w2BDFtopBM6j/vlkHw5RtFq5UZ23i8JrJGwWqfAsjmqgxDLcxRAFmMgnXj2yZjAUrHGBzb31cb/NygDws9L3svz171zmIC2UAFxCiqW6vLtRFsE+N8FYs/1TxYO4c/T50GFZ+xyNK8jqSN0XZqA/HifD6CgJ+9ripeXrSRHF+5CmxR3kxZe3n46efFneTc42xzJq4LkpTcaR9u/1NjWYf69dHvSP1HzWcdoBYD4ZFgjp/OOhA1Y+GRoH7keNYBs5kUj4X5o6a1Doxrk+MK5x1/eMVAYz1K5BQhRx+fgsXJhfbWqa1SvFbF/ri4kYmE9eKxUSzi7cv207QRzecLiRt7j6aq5BI+8bes7qqq+g+pVNP8 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available pipelines in a user context, enriched by `attributes`. Appen id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-platform-regions.ParamsDetails.json b/platform-api-docs/docs/list-platform-regions.ParamsDetails.json new file mode 100644 index 000000000..16080477b --- /dev/null +++ b/platform-api-docs/docs/list-platform-regions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"platformId","in":"path","description":"Platform string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-platform-regions.RequestSchema.json b/platform-api-docs/docs/list-platform-regions.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-platform-regions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-platform-regions.StatusCodes.json b/platform-api-docs/docs/list-platform-regions.StatusCodes.json new file mode 100644 index 000000000..4b4995816 --- /dev/null +++ b/platform-api-docs/docs/list-platform-regions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"regions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"ComputeRegion"}}},"title":"ListRegionsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-platform-regions.api.mdx b/platform-api-docs/docs/list-platform-regions.api.mdx index edc33d8b5..0f8a35c42 100644 --- a/platform-api-docs/docs/list-platform-regions.api.mdx +++ b/platform-api-docs/docs/list-platform-regions.api.mdx @@ -5,9 +5,9 @@ description: "Lists the available regions for the computing platform identified sidebar_label: "List platform regions" hide_title: true hide_table_of_contents: true -api: eJy1VdFO2zAU/RXLT5tUtWxjk9anAWIT2qQhYNoDqoSb3KaGJDb2TVkV5d+510mahFRFPOwJYh/7nHt87m0pUSVezm+lTRWujMu8XExkDD5y2qI2uZzLX9qjF7gGoTZKp2qZgnCQ0KYXdCTsRCazBeo8Ee1FQseQo15piMVyG0CJ3kAu7lrERXw3lRNpLDjFVBdxQ3bZAK5qEsJY5VQGCI61ljKnD8J2FxFEs1SrcC1f6m+vEx4dK9wJcwR18FhoB0SNroCJ9NEaMiXnpcStZZL6kKyqyY73ybgHb1UEHfFjAW47Yv7bAkVeZOB0NOQecekcIQlbrFdhvfTlmNgXLNVbsgM8n/h4dMR/hny/f9LRyNAtOfKusjbVUTB3du8ZUo5JzfIeImSTHT8F6pqgeeEeUDmnuEaNkPnXL9DxHhcnjYd77JWoMeWls5AlqF+fdnpbnI4mFVeNGwwgxPE+P05VLPiBweNbjOkycSsz8F4lwF1xuNwWeLC0c+eMGyn/tOcl26YQuUGh0tQ8kR6Ge4gKp3EbGuEUlAN3UlDq57cLDgl1ydpwIyUQNHJDzOVs196zsuuaauZ2HebBbdr2KlxKZ9aI1s9nM2X1NEpNEU89PJKqqTajoF+HHbHrtDPGi5PLC8maWsnX7HDtVl/4zjBmbNuCv5cBRCv1P9/bnrh/wmCFzlcmHG/cbVQw7WsCuVwdgW/AHA0VhWgMi++XTOnQaWjJlfnWbZAQdq7m+TD9+nl6xGvWeMxUSFYzNji83XjsrB8oLbuY/u/B27iO8A85HzTHSHYov2xy0/9ZmMj5YN62+ul911Qqg8tyqTz8cWlV8XI9EzlQsfYsnmK5UqmHAyW/MjH3Sn6A7Wgob1RaMDLkb6OcZv43anl31cyB9+LgT8heUe3MzLd9Na3YnpPVgtBrUDHdxfpqwEkUgcXe0dHEGjT7j/MbwqphO71on3D7Xln0bgFxYx4gp7drVSJ/s8CqegZd39ZJ +api: eJy1VUFu2zAQ/AqxpxYgbCcNetCpSZAWQQs0SFr0EBgILa0tJhKpkCunhsC/F0tJlhwbDnLoyRY54swOd1YNkFp5SO6hKhQtrSs9zCVk6FOnK9LWQAI/tCcvKEeh1koXalGgcLjS1nixtC7upLasatJmJfqDhM7QkF5qzMRiE0ErvUYjHnrEdfYwAQm2QqeY6jrryG46wG1LAhIq5VSJhI61NmBUiZDAcBBI0Cy1UpTDa/39ccKTY4VbYQ4kOHyutcMMEnI1SvBpjqWCpAHaVEzSvgQhyC3vi3VPvlIpDsTPNbrNHvOfHihMXaLT6S73Hpc2hKu4xXoVtUufzyCEOUv1lTUePb9xOpvxzy7fz+8gIbWG0BDvqqoqdBrNnT56hjT7pHbxiCmxyY6vgnRL0N3wCKicU1yjJiz92wfo7ICLsvPwgL1Amgpeuoy9hO3tQxhvcXd0XXHbucGAIOHskB8XKhN8wejpPcYMPXEPJXqvVsipOF5uDzxa2pVz1u0p/3TgJvtQCGNJqKKwL5jFozymtdO0iUG4QOXQndeUQ3I/5yYpkXLLQVph1MiBSGC6jfe0GVITpm6bMI9u3cerdgUkkBNVPplOVaUnaWHrbOLxGZ2aaLvX6HdxR2yTdsl4cX5zDaypl3zHDrdujYVvDWPGPhb8vIggkN2fr30mHl8oWqHN0sbXO3c7FUz7lkAuV6foOzC3hkpja+wWPy4ZS6WLGMml/TJsBAnsXMtzMjmZnU5mvFhZT6WKrdXNDe7eYT4O3u9IbYY+/d+Tt7Od8C9xg2jDsmP9Tdc44++ChGRn4Pb65xJy64nBTbNQHn+7IgRebocid1SmPYvPIFmqwuORkt8YmQclP+FmbyqvVVEzMjbgWjnN/O/U8uG2GwQfxdFvyEFR/dA0m7GaXuzIyTAPEnJUGbqorwWcpylWNHp1b2TtpP3b1S+QoHbz9Co/8fSDspqmRfyyT2hC2KokfmaBIfwDofjWbg== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists the available regions for the computing platform identified by the given ` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-platforms.ParamsDetails.json b/platform-api-docs/docs/list-platforms.ParamsDetails.json new file mode 100644 index 000000000..f6b8b99e9 --- /dev/null +++ b/platform-api-docs/docs/list-platforms.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","required":false,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-platforms.RequestSchema.json b/platform-api-docs/docs/list-platforms.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-platforms.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-platforms.StatusCodes.json b/platform-api-docs/docs/list-platforms.StatusCodes.json new file mode 100644 index 000000000..ce1e8c823 --- /dev/null +++ b/platform-api-docs/docs/list-platforms.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"platforms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"credentialsProviders":{"type":"array","items":{"type":"string"}}},"title":"ComputePlatform"}}},"title":"ListPlatformsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-platforms.api.mdx b/platform-api-docs/docs/list-platforms.api.mdx index 46a37c99e..1c09e6ab8 100644 --- a/platform-api-docs/docs/list-platforms.api.mdx +++ b/platform-api-docs/docs/list-platforms.api.mdx @@ -5,9 +5,9 @@ description: "Lists all available computing platforms in a user context. Append sidebar_label: "List platforms" hide_title: true hide_table_of_contents: true -api: eJzFVW1v0zAQ/iuWP1ftgIFEv0A3DTQxiYmB+DBVmptcW2+J7dmXjhL1v3PnJE3Sdi9ISHxq7XvO99xzLyklqkWQ42vpMoVz6/MgpwOZQki8dqitkWN5oQMGobJMqJXSmZplIBKbuwK1WYito9BGKFEE8GQ1CL9wKCbOgUnFzYcH6++CUwmcpzcCrcjozV3XLWbrLwfSOvCKiZynNZXLLdOBdMqrHBA851BKQwdCWb8g9EBqZn9fgF/L3Zy++oUy+nd8WZgiB68ToVMwqOcaPOE93BfaA0WdqyzAQIZkCbmS41Li2nEYTSQXEct0FFZX747lZjPYcukk/jSjn9vs/z2dKfsHZ02AwB6vj474Z0eSL+QalTfIVuVcppOo0Og2MKTcD2pnt5AgV8JzpVBXAdpuaqHKe8Vpa4Te/SNP6LSDCeip1+RmUMt6wJCQOKwXqXPp7YrE8y+J3jxANZOoMeO709jc0DRa39hrwW+1qgwhzPEhXU9UKrh6EPBvBG4Lfi1zCEEtgEfzadEa4IH82gzOvLd+j/mbAx3RzJ4wFnkB2Afiw/AASeE1ruPUnYDy4CcFLuk45WajkVxantcFRI6KTXLkOpNLa2LVjG3hMzIvEV0Yj0bK6WGS2SIdBrgnAkNt94blKlpEUwdxyngxuTyXHL5hd8ViVsJ0OW614YiyniQ+zyKIbqo/n5oxun3AmLU2cxvdayFrFhz2OYKcrk4g1GDuApXELugn302ZGkFncYrn9mNrICKsXBXn1fD92+ER3zkbMFexierVc9HbsbsUy7YV/++Gr4vBR+4QWpGUTVSlrDtn5+u0pEz5sixnKsAPn202fF2tVe6nVAdOod2Vjyb+/GfgILs7WHc+MyuVFYyRvPZfHvuZhf9E4P43pQ0/5YPXHD9OIkkFivZgFKVynSQJOOx47S2h3vx+PvtOWNUfm50xia83W9asO29TgSLiu70DQ0Vq+COfKRBtnj+4ZvV/ +api: eJzFVU1v2zAM/SsCz0aSdsUOuWxt0Q3BCqxYO+xQBChjM4laW1IlOl1m+L8PVOw4X202YMBOiSVSfO/pkaqAcRZgeA8uR55aXwQYJ5BRSL12rK2BIVzrwEFhnitcoM5xkpNKbeFK1mam1olKG4WqDORVag3TT+6pc+fIZOrhw4v1T8FhSqPsQbFVuQ68m7qOWedDAtaRRwEyyhooN2ukCTj0WBCTFw4VGCwIhmD9bJRBAlrQP5fkl7DL6aufodG/4snKlAV5nSqdkWE91eQhAU/PpfaUwXCKeaAEQjqnAmFYAS+dlNGGaRZjBQ7yaun9GdR1ssayQfxtRD/W7P89nLHkB2dNoCAZp4OB/OxI8gUSiMobll10LtdpVKj/GCSk2i9qJ4+UstyEl5tivSrQuakLRe9RaGumrfVXjtDZRkxgr80M6qSR9cBG6inqhXm48Xahs2iKo9XbA+o6Adacy9plNDe1Rtve3LLgt0ZVCakTODuk6wVmSm6PAv+NwN2F30NBIeCMpDXfFq0NPMCvY3DlvfV7yN8dcETbe8pYlgFgXyiLRwVKS695GbvugtCTPy95DsP7sZitIJ5b6dcZRYwoW9B3G50byC/ati19DkOYM7sw7PfR6V6a2zLrBXomjz1t95rlNu6o9h7UpcSr85sRSPkW3a2IuRJmE+NaG6kITSfJ9yQGQdL8+dS20eMLR9baTG1Mb4RsUEjZYwCFrk4pNMHiAkyjC7bJb1KmAnUeu3hqP3YbdQKi3KrOSe9kcNobyKKzgQuMLmpmz/XWkN3FWHVe/L8jvrkN+RSLaCNsoixVY52d52luA8tiVU0w0Hef17Usr+aqGCrTQSh0w/JV4sffgYPonmi58c4sMC8lBmTu/3ntIxP/jcLbj0pXfiwfXkv92IoJzAkz8lGUVep5mpLjjay9KbTVwJ+v7iAB3O6bnT6Jp7dj1iw3zq6qVcSdfSJT19DiZ/mGelzX9W8fsvWk sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all available computing platforms in a user context. Append `?workspaceId` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workflow-tasks.ParamsDetails.json b/platform-api-docs/docs/list-workflow-tasks.ParamsDetails.json new file mode 100644 index 000000000..f0b013788 --- /dev/null +++ b/platform-api-docs/docs/list-workflow-tasks.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Pagination max results","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"sortBy","in":"query","description":"Field to sort by","schema":{"type":"string"}},{"name":"sortDir","in":"query","description":"Sorting direction (asc|desc)","schema":{"type":"string"}},{"name":"search","in":"query","description":"Search tasks by name","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-workflow-tasks.RequestSchema.json b/platform-api-docs/docs/list-workflow-tasks.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workflow-tasks.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workflow-tasks.StatusCodes.json b/platform-api-docs/docs/list-workflow-tasks.StatusCodes.json new file mode 100644 index 000000000..c11c7d530 --- /dev/null +++ b/platform-api-docs/docs/list-workflow-tasks.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"task":{"required":["status","taskId"],"type":"object","properties":{"hash":{"type":"string"},"name":{"type":"string"},"process":{"type":"string"},"tag":{"type":"string"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"module":{"type":"array","items":{"type":"string"}},"container":{"type":"string"},"attempt":{"type":"integer","format":"int32"},"script":{"type":"string"},"scratch":{"type":"string"},"workdir":{"type":"string"},"queue":{"type":"string"},"cpus":{"type":"integer","format":"int32"},"memory":{"type":"integer","format":"int64"},"disk":{"type":"integer","format":"int64"},"time":{"type":"integer","format":"int64"},"env":{"type":"string"},"executor":{"type":"string"},"machineType":{"type":"string"},"cloudZone":{"type":"string"},"priceModel":{"type":"string","enum":["standard","spot"],"x-enum-varnames":["standard","spot"],"title":"CloudPriceModel"},"cost":{"type":"number"},"errorAction":{"type":"string"},"exitStatus":{"type":"integer","format":"int32"},"duration":{"type":"integer","format":"int64"},"realtime":{"type":"integer","format":"int64"},"nativeId":{"type":"string"},"pcpu":{"type":"number","format":"double"},"pmem":{"type":"number","format":"double"},"rss":{"type":"integer","format":"int64"},"vmem":{"type":"integer","format":"int64"},"peakRss":{"type":"integer","format":"int64"},"peakVmem":{"type":"integer","format":"int64"},"rchar":{"type":"integer","format":"int64"},"wchar":{"type":"integer","format":"int64"},"syscr":{"type":"integer","format":"int64"},"syscw":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxt":{"type":"integer","format":"int64"},"invCtxt":{"type":"integer","format":"int64"},"exit":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64","nullable":true},"taskId":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["NEW","SUBMITTED","RUNNING","CACHED","COMPLETED","FAILED","ABORTED"],"title":"TaskStatus"},"dateCreated":{"type":"string","format":"date-time","nullable":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true}},"title":"Task"}},"title":"DescribeTaskResponse"}},"total":{"type":"integer","format":"int64"}},"title":"ListTasksResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workflow-tasks.api.mdx b/platform-api-docs/docs/list-workflow-tasks.api.mdx index 7e3b74bf4..ac186096e 100644 --- a/platform-api-docs/docs/list-workflow-tasks.api.mdx +++ b/platform-api-docs/docs/list-workflow-tasks.api.mdx @@ -5,9 +5,9 @@ description: "List the tasks for the given Workflow ID and filter parameters" sidebar_label: "List the tasks for the given Workflow ID and filter parameters" hide_title: true hide_table_of_contents: true -api: eJylWF9v4jgQ/ypRnnYlWnq7eyctTwe03UPXbauW3kpX9cEkBtw6cWpPoIjju9+Mk0BSXDDtE8Qez2/+e8bLENjEhJ37cK7001iquQkfWqHKuGYgVDqIw054IQz8KreHzDyZsBVmTLOEA9d0eBmm+IGUFRM81gpFiisZgyn+j7mJtMiIJS5WzAIDWqSTQMQ8BTEWXCOp5s+50ByBQee8FZpoyhMWdpYhLDICKQ6Fq1WrgWsyFvEN8HPO9cKJbAmDNE+4FlETewtLpMAndmusdMKgWPrjWwM9YS+7Ua/ZRKTWngHSBpqbXILxx/v6pYGnxmPDwRtyTf4+NKM09Ba70c4Fl3EAKiDiYLRwgTncRtSnQu/mfYtEFCQxBkVkFfrETPQfEX32xeFMR9M9MJYmAIpv1CCwR3exf6BQNZlKDTe0/+XkhH6aXK/+Rh6RQjunQLssy6SIrF/aj4ZIltsQavSImlKSaUpEEAWAFa1GxrRm1i/AE+N3nH43+XWPyjDIKRBpE3MHddrNZMrM1GGMVmlpxwaej7gxzj2sPc51k48SAdtbtTiNGfAjEAhK9MD0AeSRSjKJtcv/RKLiXHIP22+Cz3qdiRTTy6UiAzyZgVcyUhRSSLltFWGljtxOobKIaePcwyzI3R6Lstx4ypXwRGEu+dRLzDdRBKAHqbW7HylPZ04t+AuPclBu5RMWTdE1Q7vuMoFUefyvSt8KaRHxnyrm0hVBHG+WMrfSmGm6kLBKAOXWyxFtHs2YpnQxb1CBAIq1sE9CXG+wbEyZehQgsxGahbTVWuluVFQdpzUE3BbJ7ufZOC8aAE8vaM7kAU6jm2lGl7XTvBiA20rWU1PlI2nzMsMA9CTVZr/qhXCzJtNdpBlnTzfejIn6H3/meB0x7Uk7P4DWLLBmHEA794+BuLcA7muOucbqeciBmZJ9eNlfMwtqkc4OoKYE8UwNEfvwxCDPpWQUfbaRXa0vWU/Lv87WrQJzefYLv27vej8Hw+HZKf6/ubu8HFz+wH/9bv8vu9S/+nl9cVZsn3cHF/ZPt3d1Q0u1YkN9fVkgKPvx8uujP4E7UtR5STrUlczAXRZ/hMmqKWBYXzi1jdaI08ZN2YgVBAqY9LJyjRvNOHa2qbGi/W+urq7H4oDaKG7gkPau3nlh+Tdswvd3XBWhs8eopD+j8r8l+VdHP1oNdkGqIGAShzCUh8gNXpeYkAs7zvWwGea6m+Ps1rl/oFa3yYasFcCUl+0y2tV+TbCop8F6uhucBni5BWMhcU4MahMjNQ4wVTRbTuxkYqfETtiu5sf2cjNJrtpQzpyG61k1cOYaXRxOATLTabdZJo7tnX1s+DNqeCyUo8GnneBaMqA4COz1GnSvByHpV6l/S94qLF83wtr4hFiNBfQ9skS4Uvw5ryLscQ7WrCIdK3u89FQpBcHuE5DUxcvflMS2n4xsmDWVr6uMkSakDfCx+nOzQcUTLVfg/Hb8/ffjE3shYTuRMBul5aT0Ycc2VFpbDfgLtDOJ7TDBWvGXpdM3Lw94utN4QCj8js6Z2rbnPlwuR8zwOy1XK1ouBjmKBmwtqWpgQI2ZNHxLjHWK7nsAcMr7xBHl1RvDjElqn8OQxkx/+DdfAnYAF88LHwdcvwPswFrTvBPO8RCwA239tPBOtD1PA3uQi5eH90K7nwt2QVaPEBvEB/rQorjwDgrjTzflXfI52PmY5pSnmmHThunrcV6m4OoBqafY1tEQi/IVBN0o4lk9RrZuPVJsXeF/nA2RljXL6Kuyabk7xcKUtxRD9cRTTPtKSqBvEnC1+h8ZPwt6 +api: eJylWEtv2zgQ/ivCnFpAjdO02INP6zzaNbZNgzy2wAY50NTYYiKRCjmyY3j13xdDybZcM7acnmyRw/nmSc7MAkhMHPTvYWbs0zgzMwcPMZgCrSBl9DCBPnxTjn4227fCPTmIoRBW5Eho+fACtMgR+ismwwRiUBr6UAhKIYYEnbSqYJbQhyWzyJFVehKpBDWpsUILMVh8LpXFBPpkS4zByRRzAf0F0LxgkPoQVFW8gesKIXEN/FyinQeRPWGkyxytkpvYW1hKE0781tjYXFC99MfnDfRcvOxGvRITpb09o1y8RBZdmZHrjvfpZAPPjMcOqTPkivxtaM5YOp3vRvuiMEsiMhETR6N5CCzgNqY+V3Y37xtjiYMkURalV+idcPI/JnrfFQeFlekeGE8TEcd3NJpH/ugu9g8cqq4w2qHj/ZPjY/7Z5Prjb4hBGk2oiXdFUWRKer/0Hh2TLLYhzOgRJTussJyIpGoAL1qLTFgrvF8Ic9ftOP+u8+seHAkqORB5c5hw6u9mkgqXBowRN5YObBTWSHQuuEdiElx35ShXtL3VitNEEH4glaOnJ2EPIJcmLzKkgLyvnchNUmbYwfbr4PNeF0qjDaooiDAvqFMychRySIVtJa0gGXYKX4uJCgvwXGIZ9pgsStdRrhxzY+ed7ssYElUHYAdSb/dupKinQS3wBWVJJqx8LmSqNN769ZAJMlMm/xr9Wkgrid9NglkoglCXeZNbOhGWHyRXGOLcevnAmx+mwnK6uFeoSBHHGpyxEFdrLB9Trh0FusxHaL221ho7kPWtE7SGops62bt5NinrAqCjFyyK7ACn8cs05cc6aF5ZlNtKtlPTlKPM52WRY96R1Lr9qtfCTTeZ7iItUDxdd2bM1P90Z25lKmxH2tkBtG7u5CG0s+4xkJzOCbuaY2YV4SEHpiY7o5f9d2ZNrfT0AGpOkI6poZIuPGPQZZYJjj5fyFarR7aj5X/N1q0L5vLiJ8Rwc3f6fXh7e3EOMVzfXV4OL79CDGeDs7/80tmP71ffLurtL4PhN/9ncPrjmpdalw3X9c0FwdkvCM8sCsJAigYfyYC6mXB0VyS/w6TaFBDaC+e+0Bohb1w3hVhNYEhknazc4sY9ju9tWqx4/3OoqjsVScRlFDo6pLxrV145OicmuL/iWhIGa4yl9Bd8/W9J/ilQjy4bu0gbikSWmRkmnpVDWVpFc9/OnaKwaAclpdC/f+BSd5MNWyuiFJtyeWys/5qoKepo1d0NzyOhk2isMkIbtTpGLhwoNdxbTnxn4rvEPvSW/WNvse4kqx41PadDO102nKXNoA8pUeH6vZ4o1JF/s48cPqMVR8oECnzeia4yQRwHkX9eo8HVEFi/pfo37K3a8m0jrIzPiMu2gL9Hngji5s+XZYQ9zsibVemx8ccbTzVSMOw+AVldJdE1xL6elD7MNpVvq4y5UJkP8LH5c73BlydaV+N8PPp4fHJ07F8k4ygXPkybVum3Pbuh08pshC/UKzKhNMN6+ReN19ejB4ihvzFBqB3/EEPq6557WCxGwuGdzaqKl+tOjsMhUY6vjQT6Y5E53BJjlaP7JgBBeZ9wvjVkmIqM62cA7jO7w786CtgBXM8Xfh9wNQjYgbWieSNcYBKwA201W3gj2p7ZwB7kevTwVujwvGAX5HIKsUZ84A+r6hfvoDB+d908Ju+jndO0oDzLJlZvmL4d500KVg9VDCmKhLvY+0VDMJASi3aMbD17rNjqiv96cQsxiM179Jd703MPirVY1BS35gl1Va2kJP5mAavqfzEFC58= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ List the tasks for the given Workflow ID and filter parameters id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workflows.ParamsDetails.json b/platform-api-docs/docs/list-workflows.ParamsDetails.json new file mode 100644 index 000000000..7371101fe --- /dev/null +++ b/platform-api-docs/docs/list-workflows.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"attributes","in":"query","description":"Additional attribute values to include in the response (`labels`, `optimized` status). Returns an empty value (`labels: null`) if omitted.","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["optimized","labels","messages","minimal","pipelineVersion"],"x-enum-varnames":["optimized","labels","messages","minimal","pipelineVersion"],"title":"WorkflowQueryAttribute"}}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Pagination max results","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Filter search parameter","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-workflows.RequestSchema.json b/platform-api-docs/docs/list-workflows.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workflows.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workflows.StatusCodes.json b/platform-api-docs/docs/list-workflows.StatusCodes.json new file mode 100644 index 000000000..6e385cf30 --- /dev/null +++ b/platform-api-docs/docs/list-workflows.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workflows":{"type":"array","items":{"type":"object","properties":{"workflow":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"ownerId":{"type":"integer","format":"int64"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"runName":{"type":"string"},"sessionId":{"type":"string"},"profile":{"type":"string"},"workDir":{"type":"string"},"commitId":{"type":"string"},"userName":{"type":"string"},"scriptId":{"type":"string"},"revision":{"type":"string"},"commandLine":{"type":"string"},"projectName":{"type":"string"},"scriptName":{"type":"string"},"launchId":{"type":"string"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"requiresAttention":{"type":"boolean"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"maxLength":20,"type":"string"},"defaultBranch":{"maxLength":20,"type":"string"},"version":{"maxLength":20,"type":"string"},"homePage":{"maxLength":200,"type":"string"},"gitmodules":{"maxLength":150,"type":"string"},"description":{"maxLength":1024,"type":"string"},"name":{"maxLength":150,"type":"string"},"mainScript":{"maxLength":100,"type":"string"},"author":{"maxLength":150,"type":"string"},"icon":{"maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"maxLength":20,"type":"string"},"build":{"maxLength":10,"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"maxLength":50,"type":"string"},"cachedCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"ignoredCount":{"type":"integer","format":"int32"},"succeedCount":{"type":"integer","format":"int32"},"cachedCountFmt":{"type":"string"},"succeedCountFmt":{"type":"string"},"failedCountFmt":{"type":"string"},"ignoredCountFmt":{"type":"string"},"cachedPct":{"type":"number","format":"float"},"failedPct":{"type":"number","format":"float"},"succeedPct":{"type":"number","format":"float"},"ignoredPct":{"type":"number","format":"float"},"cachedDuration":{"type":"integer","format":"int64"},"failedDuration":{"type":"integer","format":"int64"},"succeedDuration":{"type":"integer","format":"int64"}},"title":"WfStats"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean"},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"repository":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"}},"title":"WorkflowDbDto"},"progress":{"type":"object","properties":{"workflowProgress":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"executors":{"type":"array","items":{"type":"string"}},"cpus":{"type":"integer","format":"int64"},"cpuTime":{"type":"integer","format":"int64"},"cpuLoad":{"type":"integer","format":"int64"},"memoryRss":{"type":"integer","format":"int64"},"memoryReq":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxSwitch":{"type":"integer","format":"int64"},"invCtxSwitch":{"type":"integer","format":"int64"},"loadTasks":{"type":"integer","format":"int64"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"cost":{"type":"number"},"netCpus":{"type":"integer","format":"int64"},"netCpuTime":{"type":"integer","format":"int64"},"netCpuLoad":{"type":"integer","format":"int64"},"netMemoryRss":{"type":"integer","format":"int64"},"netMemoryReq":{"type":"integer","format":"int64"},"netMemoryConsumption":{"type":"number"},"netReadBytes":{"type":"integer","format":"int64"},"netWriteBytes":{"type":"integer","format":"int64"},"netVolCtxSwitch":{"type":"integer","format":"int64"},"netInvCtxSwitch":{"type":"integer","format":"int64"},"netCost":{"type":"number"}},"title":"WorkflowLoad"},"processesProgress":{"type":"array","items":{"required":["aborted","cached","cpuLoad","cpuTime","cpus","failed","ignored","invCtxSwitch","loadCpus","loadMemory","loadTasks","memoryReq","memoryRss","peakCpus","peakMemory","peakTasks","pending","process","readBytes","retries","running","submitted","succeeded","volCtxSwitch","writeBytes"],"type":"object","properties":{"pending":{"type":"integer","format":"int64"},"submitted":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"},"succeeded":{"type":"integer","format":"int64"},"failed":{"type":"integer","format":"int64"},"cached":{"type":"integer","format":"int64"},"aborted":{"type":"integer","format":"int64"},"retries":{"type":"integer","format":"int64"},"ignored":{"type":"integer","format":"int64"},"memoryEfficiency":{"type":"number","format":"float"},"cpuEfficiency":{"type":"number","format":"float"},"dateCreated":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"version":{"type":"integer","format":"int64"},"process":{"type":"string"},"cpus":{"type":"integer","format":"int64","deprecated":true},"cpuTime":{"type":"integer","format":"int64","deprecated":true},"cpuLoad":{"type":"integer","format":"int64","deprecated":true},"memoryRss":{"type":"integer","format":"int64","deprecated":true},"memoryReq":{"type":"integer","format":"int64","deprecated":true},"readBytes":{"type":"integer","format":"int64","deprecated":true},"writeBytes":{"type":"integer","format":"int64","deprecated":true},"volCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"invCtxSwitch":{"type":"integer","format":"int64","deprecated":true},"loadTasks":{"type":"integer","format":"int64","deprecated":true},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakCpus":{"type":"integer","format":"int64"},"peakTasks":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"ProcessLoad"}},"totalProcesses":{"type":"integer","format":"int32"}},"title":"ProgressData"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"starred":{"type":"boolean"},"optimized":{"type":"boolean"}},"title":"ListWorkflowsResponse.ListWorkflowsElement"}},"totalSize":{"type":"integer","format":"int64"}},"title":"ListWorkflowsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workflows.api.mdx b/platform-api-docs/docs/list-workflows.api.mdx index 39dc07bd9..fb96c86aa 100644 --- a/platform-api-docs/docs/list-workflows.api.mdx +++ b/platform-api-docs/docs/list-workflows.api.mdx @@ -5,9 +5,9 @@ description: "Lists all workflow records, enriched with `attributes`. Append `?w sidebar_label: "List workflows" hide_title: true hide_table_of_contents: true -api: eJztGttu4zb2VwQ9tYDHSaczBZqX3cRxCqOJJxsnnYfBAKEl2uZEIjUklcQb+N/3HJKSqViyqSmwu2jnJZGlc79TOi+xJksVn3yKn4R8WGTiScWfB3FKVSJZoZng8Ul8yZRWEcmyqAKKJE2ETNUgolyyZEXT6InpVXRPtJZsXmqq7ofRaVFQnkb3/0A0VZCETtL7SIsoA4I7tCLGIxLVoFEiuKbPehgPYlFQSVCYSerE+VhLO4gLIklONZWox0vM4QdAbSUBEIZqfC2pXMevlTtNU4aXJItqlOiRZCVVKCrjSVamFIXTKwqyqkJwRaMf7jMyp5m6H0T3Amjl7N8UlFOa6FL9OIxuqC4lB6vxiOaFXluSNdpJxMssu/8xYotI5ExrmqKi9LnIRAriL0im6CBWYNqcxCcvsV4XRispCerANM2Vd1+B5HyJFHiZoztrmeCeZQkXOVWKLI1FcsZZTjI0Hytoxjj9AwyIJgH3P79BMm8eiURjqj9NTzOdoZSV1/6FnjitrB1vNptB7TcvVvY77mMdKSArhSiMWEq5ZgtGZdxiOgbhtDSPFkLmRNtbv7yLfe45ed7P9ZosGTexGAEsxkOZaRXO7+e3DX5isVBUB7Oswb+Nm6JEJqv93C5YBqkUWdCozq02ni7oNhtwcZUYJijfHh/jvybhD78DDZPUXONTUhQZS4xeR18UgrzsshDzLzRBhQuJRUAzy2BbrA6nxgEShyHrKA9OQ7B5zNKW+1DKnjiVkzQoLsHk5RyKQ1ue17Ap0fQN5CY18JrIHuCJyIsMvBuOgT9GksLfFvW6kDKi9F2R9kOSJZ+aqG0xIoSZct2g5Sl4b8Gydkz0+jmTrc/AGmDsDqKlorJbHhPmHZiSPjJTCLt4Ep5eQr3s0gVj8gDnzscZKXmy6hDM9qp9TWR2d3Y1ub0dn8O9m7vpdDL9Da5md6PReHxu7l6cTi7Nxeh0Ohpf2uu76e/TDx+nbZV/Znkas3wtGVQNaANYtRv2mQuRUcKtgfiCLaEo9c0/U7la6wCpO/61l+dalrTmdwuDR6vNwFlsQZU+XDU4kECNqzaIhYQ8X1K+1Kv45O3xYJd4ShcEusmZJOC0EITHcNorkVNoJHQHtg14yXQu0tLZ3AP/6X273F6db8Ifv33XgsBdvB6knBPGZ4b2DuE2cFLqlZBBlFmya7f373cAN14IL64q56MKzr2HA6GHk+Yly9IdTVsAsUhC+uZFaD1t6DGtZHdFIKBbYqeAUe0WiF3kr53RauCE4LFgJEruJ0v3mAJ3CGR5Lwy25EL2Q1FlktB+KJ4mTvfdUupR7YLx1OsC8fXpgrHSXCf+UyjX86bw4F6it1yDwZ0iwfBO4mB4K/15aY9zgVOQ1aEnktOkF1YjS2YmM+AWlVLIKzsEtrrEANzQQrTNXqY+4pDlN2GvwbkO3zWUYN3uHli4hgJJ259KEEgxLWDG34s85suu6cOW9YuuYcpOF13Spf38RZ+Znr2eSPalJR69GmOPZ1TjfKXaHm52h5Lz+bkWzhdL2cQ7cHq49jDcRJPi5ETmEAzmsGwjHi+K8lIQd4WF1F7h2dEGeFynkzmhPY708+yJaXNgg/xJRxYYL69oLszZDX/cEvVgT+N484Z+3V4r836EkgeHi5c1Lv6ocPFFje0eMNynZ2v72kRS8Ka9Kjm3z+2RxOrmcsxcP4rMF/hJwmxm6XweHDBmxbzPmaiZT/vgK9F7lY1g6s51YcAuFsKAqxAK1NK5Kgy6irMwaBtM48WCJYzyZB1Y6ouyL8p/73TpDWVBtYkmJVTSnkcQk92BkeFKQjC0KSV93HejQmXZ1pHQ0KsqRhi8VxrCEBqlJTDA/fIZhrItpeHwo3APe2U7DKEu2+HgfcT3WkFg0InGsdelsTkK6R5yWugewW4ResQ7IFz1DPktSnDU1ygjwWEQKV6NOg3z3PTMEED52DdJAOeP/nkCWJP+qYIuaY+GlunKeM4OVziTUXW9O2XtFNO/xizlVP4+VX2fqr5PVbsdyGVH6+k0sKHg4bqQNLFyVu9ww/tLF35ou2nF7zVw7aMQ1oxaKfQaylop9BvTWkn0HdxaifQd5VqJ9BruOin8fcY9r49f2zS1bRzvC22+nNhmHvSypknNNP9zoon5HiqXwV9DAbbzS5e/NhB4DKkw9nw9M3sOh898HR2YBU+sXRKYpZGOt3tKlDLpeP/F1Ln9ltT5eA08WdL1eALCykJkpPO15Tc0FS8KLtGy7rWb/QghZRen7ebJ/rd5jbWgG7eOMGzcHWc0x+2DOoxnQLdvPrTywR0WgHnXtvhwRtII51n8ctRjA8Ifgd0KwuGhL+98Te1pMLbvq19J/vOu5B+qvauIC40LYOKJ2iKgaFJCf1ibjaszSiSVpyV+C/r0GbdBcqpXAne1lmZbpSD4KD6qdy6QgHysNrZKmcHTldaFOjk6IgUbJpko06GiX4H/kIn49ZLKzDyJriFA0VPRCOGj0+tJjNwr4WZoS2sXX8TaNMgxdnstJqoMENyxFxdVDHx5siHD+EIYdGdHJwWyPSQgqsugYjpg8/LdfjNpKu+rDHHAMhOCC/HP7QN/zop/Gv76fnhsCjwcyHJiYsht+1z6W3bqtYgv20j83y/4OYfgz6MiI8wkvrHMiwue7YIiJsHKnD4/xS8vc6Loncw2G7xtN5owpFKmyNwcIdwmXafu/1f7f612eKDr+NU+o+sLcYzLXeG6HliZ28O9uZX3jew7d+f2MLYLeX+eYb05t4dXDfON7LpX5/YwrXfytkw/4w/JkKspqBDvMM3jZz6IbIt1Cufpwhd1p5c0yvBv49vYrkf4TbRZ7gz1atDha482ZJmBuBUPlEOmVaJr/A2MoIH8B3eeH+0= +api: eJztGl1v2zjyrwh8ugXUJM2295CXu8RJFsEmaTYf24ciQGhpbLOhSJUcJfYa+u+HISVZjiWb6gK3i7s+mRbnk5wvkrNkyKeWHX1hr9o8T6R+tewxZinYxIgchVbsiF0KizbiUkY1UGQg0Sa1cQTKiGQGafQqcBY9cUQjxgWCfdqLjvMcVBo9/YvQbM4TuEifItSRFBY3aEVCRTxqQKNEK4Q57rGY6RwMJ2Eu0kqcz420Mcu54RkgGNJjyRTPgB2xlSQsZoLU+FaAWbC3yh2nqaAhl1GDEr1wWYAlUYVKZJECCYcziAzYXCsL0T+eJB+DtE9x9KRzFJn4A9KnyCLHwv60F90CFkbZiKsIshwXnmSDdhSpQsqnnyIxiXQmECElRWGeS50CO5pwaSFmNplBxtnRkuEid1oZw0kHgZDZ1neLRqgpUVBFRtvZyMRi5lmymGVgLZ+6FcmEEhmXtHwiBykU/A7G0pI8xmz+jsi8e+GGFtP+aXooUJKU9a79RjtxXK82K8sybvatZSvbN+5zYymqyMCIJBIpKBQTAYZ1LJ1QCFM3NdEm4+g//fMDa3PP+Hw71xs+FcrZYpTxOdlDIdGG8/v5cI2fnkwsYDDLBvz7uFngJplt53YuJIKJPGjU+FYXz8royvIxZrVjOKM8PDign3XCn35lMXNOrZBmeZ5LkTi99r9aAllustDjr5CQwrmhIIDCM1gFq92usYPEbsjGyoPdsCxjJtKO7zHTrwrMRRpklzGzxTgT2OXnDWzKEd6hyMDBIzcDwBOd5RIQwjHoz8gAR+hQrw9JcosPeToMyRTq2lltxyJasLbKBh2zudETIbsxaddPhemcS3SWCewhWlgw/fI4M+/BNPAiXCDs48lVeilUN+XcaLLJHZx7pyUvVDLrEcznqm1J5O7h5Ori/v7slMXs9uH6+uL6Fxazu4fR6Ozs1H09P764dIPR8fXo7NKPH65/vf70+bor8t95nm5ZvhXCgD1GCgjr6zPWWgJXfoHUREzPhRzqfy5ydcYB3mT8m5afoymg4XcP8w43KmOWcSUmYHF31FAwR9K4ToMUSPj8EtQUZ+zo8CDeJJ7ChBcSTwxXySwE4SWc9kxncMOnsAHbBTwVmOm0qNa8Bf7+Y7fcrTi/Dn9w+KEDQVX2upNyxoW6c7Q3CHeB8wJn2gRRFsnmun38uAFYtkx4clVvPqlQbe9uQxiwSeNCyHRD0w5ACpIWeZaHxtM1Pa5r2asgEJAtKVMUCPcig/Ps7WZ0LnDC6Vgw0oVqO0t/mRKzCRdyGIaYKm2GodgiSWAYSkuTSvfNUNqi2gfTUq8PpK1PH4yX5iZpz6oiG68LP5Ga44prMHilSDB8JXEwvJf+tPDHucAqyOswEKnSZBDWmpfcOc8oYwbGaHPli8DOLXEAt5DrrtrLxUcqstpJuJXgqgzfV5RQ3O4vWBRyoaB71kCurUBtFtuRz9S0r/rwYf28r5jy1UWfdOmw/YK5wLu3Fck2t6Sj11rZ01pUt/nWdk2Wm0XJ6fgUdbUXU7OOt+P0cNPCqCqalConPtYG3WHZWzwN8uJS82pEgdSP6OzoDZw17uROaC8jnN+9CnQHNql5OvLANLyCTLuzG/255/bZn8bp4y18W42tux8B/lzh0rDBpT81Ll3U+OxhgKcnC39tYgCN8KNCKT/vjyRet8rH3PhFy7bAr0YgeDqP8Y7FrJkPOROt+9M2+Fr0QWEjmHq1dWHAlS2EAdcmFKhltVVh0LWdhUF7YzqbTEQiQCWLwFCfF0NR/nuny1ZRFhSbIClQm4FHEOfdgZZRhYRgaBdKhmzfrQ2VZRVHQk2vjhhh8K3QEIawFloCDbwdPsNQVqE0HH4UvsOtsB2G0ITtcPAh4rdSQaDRadtR5LmjEA6Q00MPMHaPMMDeFeDVQJNfoQRbfYMy0soWWf6m1FlbntuBHqIAPw91EgX4+3A/UYAXw12FtqTbGjqqK7dzvriimgzszWaVtRFM/zdqqUrlH1XVj6rqR1W1mYEq7+g8nQYmFDpc5wYSL2d9hxueX/rwQ9NNJ/6ggmsbhbBk1ElhUFHWSWFYmdZJYmjh1klkaCnXSWRQcddL4f+n3Gvl8Rvvpj6N03eN7uXEJ/Ogy5p1ai75n3Lk7j3UTINfQ7WZ9r50tdsGAo8hNcaW1zPX57D7zNeTgUVwxdongWsa6bnds7owSc/9l7Cn/i2pd3qheCaSvukLhWByLXnvteV3JJWWFVzSylbXbtWztenjtOo82X6bt9YWdFu1I+ytfT2TkFH3QWPGd+KPsGPILj7Uw1LG7ENX48MJTyOqZ+nlaEAHRLsErloQdhd9We81dUuDM39f/Ubynzcl/1T3XUVKIzWA6VfwQcBCUhiBC9dxdQLcgDku6C3oyyN1g2SAM029WlPXrZJzmmL7Tc8FETAvdcdWYSQ7YjPE3B7t7/Nc7CVSF+mehW9g+J7QG00qd24mupEcaaeiEcFHxzcXjLjXwt3RWvp1aYvYLA1xrPtanFU5IBZXg/PaBr6+epMRaqIderWOlRTEdpeApK5IwFbA7vLdv5msK99WGTIupDPBif73aqJdZ7H3e+8PDvcOXITXFjPujKhq97lst9nZtzIuV6b413f4VTtCf/dzyYXzfLc0y8p6Vh2K5AUzd/z8wpbLMbfwYGRZ0mff0kQ2lQrLx+4MUbXS9er+t2oA7FyHZ1i8bWisEgNj1N0VruuOnrkt3Nfb8r6TfW/z3BbGviPvzzNsWue28GpgvpNdf+/cFqZNU96K6SP9MYK4uogasxnwlN75viwrrOMkgbwt6kYyWYvDv5zdM98f0c6i6/HOUa8rHbVo0V4uPcS9fgZVlqwWHek/Kx/LsvwPrAUgEg== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all workflow records, enriched with `attributes`. Append `?workspaceId` to id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workspace-dataset-versions.ParamsDetails.json b/platform-api-docs/docs/list-workspace-dataset-versions.ParamsDetails.json new file mode 100644 index 000000000..088b7fca6 --- /dev/null +++ b/platform-api-docs/docs/list-workspace-dataset-versions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"mimeType","in":"query","schema":{"type":"string","nullable":true}}]} diff --git a/platform-api-docs/docs/list-workspace-dataset-versions.RequestSchema.json b/platform-api-docs/docs/list-workspace-dataset-versions.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workspace-dataset-versions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workspace-dataset-versions.StatusCodes.json b/platform-api-docs/docs/list-workspace-dataset-versions.StatusCodes.json new file mode 100644 index 000000000..34521a21b --- /dev/null +++ b/platform-api-docs/docs/list-workspace-dataset-versions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetName":{"type":"string"},"datasetDescription":{"type":"string"},"hasHeader":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"createdBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"lastUpdated":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"url":{"type":"string"}},"title":"DatasetVersionDto"}}},"title":"ListDatasetVersionsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx b/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx index 3a6fe6e9d..19eee7a3d 100644 --- a/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx +++ b/platform-api-docs/docs/list-workspace-dataset-versions.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [List latest dataset versions]( sidebar_label: "(Deprecated) List latest dataset versions" hide_title: true hide_table_of_contents: true -api: eJzlVttu2zgQ/RWCT0lgW9leFlg/Ndn0ErRogybZPrgGykhji4lEKiTl1DD07ztDURfbymWf98kyZzg8c2Z4hhvuxNLy6YwnwgkLzvL5iCdgYyMLJ7XiU350dJVKy0AlhZbKMfxOoDAQCwfJhF0CsNkXaR3LcAF/QiS2AmMxgp0fpM4VdhpFiY7txMI9GDGROipww0KbfCwKGWUYYVxHGIcI4ybCeDV+dcjQlbkUWFwaA4ijATQ5OvqpfiqCYL1DwBF2M71gIOK0xSWs1bEk8OxButRvWcoVKPbrQZs7W4gYzpNfEz7iukCoRMN5gkTQCT8aj7M62j8BIjoXwogcHC4gnxuu8A9u6oVEH0mEFsKlfJflNjBTZQ5GxkwmmKVcSDDobOC+lAYQhjMljLiNU8gFn264Wxd0DhIBS+9KlApXL/35hlfVqAWTyxyuyD8guS/BrPlANOuMVEu0qDLLxE0G9blVNScotsCMwZL/q+Nj+tnO5dtn3BlrRKQcWUVRZDL2REa3llw2+0fqm1uIHfFoiHYn6wOaHuh5CmMEoZYOcvt8hFB3KuFuftWosX71BD1uP+snOOCWCvsJRIIF6Kw3WmcgFJlDFi+qF1JngNrzdE3+XeVnXKwQDe1B6mRGFFBTlRaMx4/FeZoKmbwQQRtyKNf68CFLwLdvQpuTjtqIX2Poc7XQ5J8J666LhJIdar4WF3mMHTYvbVrIDB7FlkMihW/xIWv/Mr6QCDOUaS+dbR04c5hX30yasSMV38P9IUf0fDN0g05FwqjwqGP/5Sr1eyUHa8XyBU3ROD6Z5ntjtNlD/nrg7jeSyZRGrc0y/YB4yL0bGq2IAWq5dGuvl6cgDJiTErVxOpuT0KCYppqEdwkeNcnmlEdtEW206RW0ipoRFq06UcZmWzWK7GvJm2GEQ2cSZ7pMuom0J8qX3sIuwqBif5M/O7k454SvgX9J/Ndc9pNo6aQTG5H1uuCdcKX++NA03e2D80RJuh20PXAfUNCxzwGkdCUyE5ypcUTsG2c7+X7K4Tr7Y991hr5q8T8mf72dHNNaoa3Lhe+7MFQOztrCHrKnHgK76DddY/+fHxmhSxz8doRWqp7u1D0/64SLSJxuvynal9uoG5bYnSkWirZuNjdovjZZVdFyPfLpOiTS0mTHC7YQmcXreAfr7TfCSmQlQfPdvhJG1i+Bob2PFvbge9CkQ/bME2eQh2bkq3UfT4O1T0Q1pzEcZjBCrD1O4hgK19u7J6BbSvPx/RX6iu37u3NfffRBXEi197jSd6CQ7gamo/8EsKr+BRCO/FU= +api: eJzlVlFT40YM/is7ejoYJ+HoTR/8VCjXlmmnvTmgfchl5oStxAv2rtmVw2U8/u8d2WvHAXPQ5z4RLK320yfp09bAuPEQLyFFRk/sYRVBSj5xumRtDcRwfHydaa/IpKXVhpX2KqXSUYJM6VxdEanlH9qzypHJswqR1Jac19b41buMufTxYpHaxM89PZDDubaLMkdeW1fMsNSLXHuedRFmIcKsjzDbzk6P1No6xRmppHKODA+A5sfHX8wXIxB86xBwhNPKrhVhkg240HubaAGvHjVn7ZGN3pJRXx+tu/clJnSZfp1DBLYkh0LDZQoxyA3/9B4XXbS/A0SIoESHBTE54bMGgwVBDKOQEIEWQkvkDJ6yPARWpirI6UTplAzrtSYHETh6qLSjFGJ2FUXgk4wKhLgG3pVyjzZMm9ZVKEXuPv34AZomGsAUuqBr8Q9IHipyO5iI5tlps4EITJXneJtTd2/TrASKL63x5MX/9ORE/hzm8tfvEEFiDZNhsWJZ5jppiVzceXGpn19pb+8oYeHRCe2suwv6Hhh5onMoqDVT4V+PEOouJXyaXxP11j9bgl62X4wTnHDL0P9GmJIbWW+tzQmNmEMWb6pXBIkjac/znfjvK78E3CKjnKECdS4USFNVnlyLfxW9QoVO34hgCDmVa3f5lCXge25qImDN0kZw48ldmrUV/xw935SpJDvVfAMu8ZixLkgOrXVOL2IrKNXYtviUdTyMbyTCTWU6SudQBy7YQjM2i2Y8kYrPYX7EsYngw9QEnWOqpPDk+b+M0rhXCvIeN29oit7xu2l+dM66Z8h/mJj9XjKVsawwz+0jpW2o/dIYRIySymnetXp5TujInVWcQbxcidAUxJkV4d1Qi1pkM4bFUES/qEcFbRb9Clts96LsyW17RW5rCf0ywlLPk9xW6X4jPRPlq9aiPoVFpX4Wf3X26RIEXw//SvjvuBwnMdApN/Yi2+pC6wRR+PFL33R3j9wSpWU65HjgPqCQa18DKOnqhHxwlsbBpG2cw+THKYdxbq/9aW8Yqxa8n78/OZ2fyMfSei6wbbywVd5dDJU9Ut97CTyFX+87+//8yghtwvSNBa02I+Hpmn65Vy4hMT58VAxPt2i/LVcRZNazHK3rW/R04/Kmkc/dzpd5SLWX1Z5CvMbcUwT3tDt8JGwxrwRa2+5bdLp7CkydfbGw7z4HUTpSr7xxJnnod77ZjfH0WMdENCvZw2EJL+vgcZYkVPLo7DMFPZCaXz9eQwR4OMBPBraNPomrrjuPa3tPpmkGmCz/C8Cm+Rdhw/x6 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Lists the latest version of each dataset associated with the given `workspaceId` id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workspace-participants.ParamsDetails.json b/platform-api-docs/docs/list-workspace-participants.ParamsDetails.json new file mode 100644 index 000000000..108804458 --- /dev/null +++ b/platform-api-docs/docs/list-workspace-participants.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Free-text search filter to match against participant names and email addresses.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-workspace-participants.RequestSchema.json b/platform-api-docs/docs/list-workspace-participants.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workspace-participants.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workspace-participants.StatusCodes.json b/platform-api-docs/docs/list-workspace-participants.StatusCodes.json new file mode 100644 index 000000000..2c3befc81 --- /dev/null +++ b/platform-api-docs/docs/list-workspace-participants.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"participants":{"type":"array","items":{"type":"object","description":"Workspace participant details.","properties":{"participantId":{"type":"integer","format":"int64","description":"Participant numeric identifier."},"memberId":{"type":"integer","format":"int64","description":"Organization member numeric identifier."},"userName":{"type":"string","description":"Participant username."},"firstName":{"type":"string","description":"Participant first name."},"lastName":{"type":"string","description":"Participant last name."},"email":{"type":"string","description":"Participant email address."},"orgRole":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole","description":"Participant role within the organization."},"teamId":{"type":"integer","format":"int64","description":"Team numeric identifier, if the participant is a team."},"teamName":{"type":"string","description":"Team name, if the participant is a team."},"wspRole":{"type":"string","description":"Participant role within the workspace."},"type":{"description":"Participant type.","type":"string","enum":["MEMBER","TEAM","COLLABORATOR"],"title":"ParticipantType"},"teamAvatarUrl":{"type":"string","description":"Team avatar URL, if the participant is a team."},"userAvatarUrl":{"type":"string","description":"User avatar URL, if the participant is a member."}},"title":"ParticipantResponseDto"},"description":"Array of workspace participants matching the query criteria."},"totalSize":{"type":"integer","format":"int32","description":"Total number of participants in the workspace."}},"title":"ListParticipantsResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workspace-participants.api.mdx b/platform-api-docs/docs/list-workspace-participants.api.mdx index fa2fc9ec4..98089fa66 100644 --- a/platform-api-docs/docs/list-workspace-participants.api.mdx +++ b/platform-api-docs/docs/list-workspace-participants.api.mdx @@ -5,9 +5,9 @@ description: "Lists all participants of the workspace identified by the given `w sidebar_label: "List workspace participants" hide_title: true hide_table_of_contents: true -api: eJzNV1tv6kYQ/isrP7USgfRcKpWnknNyqqjJSUSI+hAhZbAHs4nxOrtrCAfx3zuzxrCAIYa2Up/A9uzMNzPfXHYeWIhN0H4Mpkq/mAxCNEG/EURoQi0zK1UatINraawRkCQiA21lKDNI6YUaCjtCsTopZISplUOJkRjM3LdYTjAVTyuRq+ipKe58JaBR5AY1qdPCIoyNmI6UGMEExQDpcKxJjjRCSNiMsErA2mQzaAQqQw2M9CpaYv2r/OxbIklCD2O0ZIw8ngcpPdAJpWM62Qgku5qBHQXb/t/qGFL5wxkRaT5GLcO1s5pBaHzNpUZCYHWOjcCEIxxD0J4HdpaxFUlOxKhJdKj0GGzx6tdPwWLRWEHx4nQQ0MrB/xTNGN5KFK856tkOjBt4k+N8zCAGqJkPGk2eWJcljTbXaVN8xSHQu7Z4+nz+xOBqgvn4YQOMGg4N2sN4vlfhMC8yE6SYuBvL1OXQB/VPMBkEHY4OY/qmEc8svllRSIuhTIiBjIzU0jPEIFNj/dISrJ9KI40EoZKJgCgijwyaSqzGapnGhKzPmTeZSkmSv384P+efLTL/STpCRf6llr9CliUydHFpPRsWme+aUINnDDn6meZys7Iw4LcDTxq0Bo6EtDg2VVr2sdmPQYSWXHce7zXKFf8+p7ft3fmRrqifRSMYIzPpNPUb3aJQtM8MN77vjkvbyTyEmU8xQ5yKodTGHq/DHRMrLQmcooRPrXU4qh6nYIPdTgk1465KKnEgBZEnlZqmLg1FaB2ZkwQGioaA0jy83s5Y9GwCLkqm1hkrLVvl5Dn7h1BrEhBTaUcydUNOeQl3TvAYO407PTpZQZaGkMWs9QtEUodwE3Nls14GCxskWkPr1GT70lE/Pt60ZqBOz3ZX8s+zBJf9PgLcXN5cXHbpRe+yc0M/X26vrzsXt91O77br59LT2WNVyyh1JmBBP+gaXHWhAicvHrrXNQLGtXmEgQcSr2WgIG6Tx0+Vf91l2/9qFaPYNNLhdsxTcVrVaE0xhwids+ymmKDTNKQkFBlTFpJ7+QPrzMedEPJhb0PYsFxBEM8/XuX8Da50koRY7FPVdLuASPD2g8YeM+bWC9Mj9QhjIEbHpIPTrxSsmMRrJy61VnoH+ceKuVyusSJVlpdtNSU8LG4wzCkfM7e0XtAWQRTLaStsP/Z55NNGO1K8+sZuP3ILYztoUVcyrblbbhet9XbfmntL5qKVbW7IRMdJuR7nTOBgZG1m2q0WZLIZJiqPmgZfCWlTqp1c37sv4i4By6wQX1hedO6uAsZZunHPUS8i6DuzCiJbLNccfh44IXpT/PlW8u15al14ZDpU7vgy4ksUbPY9gOyupKAshZkuEDq6bDrvu7wcc87s7+sPBIQjV9j5pfnb5+Y5v8uUsWNwbFsujczqPZW4jXe+JvD//A62TB3vua0soYXW9cKiAxaEfOTRzh62y/uWd+Okt5tXn42oEHdGFEbWMZ8PwCC11sWCXxcrN5M1kgYGCRfwEBKDBwJ52qWl0sEXnK2uSRNIcpYI+H5QH83pV5YDiFZ3pRNB/ft3lgNgV5eoNdg+P9D0GXA9H5Xcn7rLRv6zqHFpr0RV3mHSmY9pFVpH3uPC6YF67+J+AiK/cBZ9Eh8hRNQvOXCFRIeqNvPpsDMLN8bIH5c9koXNprzVhJ32SlxUoU6ip14wpSotYVp+ZoCLxd8b22uP +api: eJzNV0tv40YM/iuDObWA1s4+2oNPdXazRdCkCbwJeggChJZoeTbSjJZDxcka+u8FR36MHcXruC3QU2INh/xIfsPHXDPkXg9u9MzRva8gRa9vE52hT8lUbJzVA31mPHsFRaEqIDapqcCyV26ieIpqdVOZDC2bicFMjZ/CWW4e0Kq7lchpdtdTl7ESIFS1R/LKkWKE0qvZ1KkpPKAaI1qVE1jGTEGaoveKnYK1yZ5OtKuQQJCeZgusfy2PY0s60RUQlMhI4vFcWyhRD7Sj/DTTiTbiagU81dv+X1AO1nwPRpStSySTrp0lAUH4rTaEmR4w1Zhon06xBD2Ya36qxIqxjDmSTvTEUQncfvr1g26aZAUlitNOQCsH/1M0JTwuUXyrkZ6ewTiHR1PWpYAYIwkfCH1dcMgSIddke+oTTqAueKDufjm6E3B7gnn/bgOMm0w88m48f3bh8PemUhNHqoLc2JDDGNQ/weQRKJ3uxvSZEN8wPrJqpdXEFIwkyErgdKogB2M9x09LiX6vwGYKSzCFgiwj9B59J1bPZGyum+ZWMu8rZz16OX93dCR/tsj8h0506iyjZTmFqipMGuLS/+pFZP7chBt/xVSiX5E8NzatgbgcRNJABBIJw1j6Li0vsTmOQYYMpggev2hUXvyPOb1t7zKOdMf7aRJdojDpMPUb1aJV9JIZKXx/Bi5tJ3MXZrklDAkqJoY8v15HuKZWWgo4RIncWusIVH2dgg12ByWO8pErOnGgrUvpVG5mQxra0AYyFwWMHQE7kub1+EZE3zxAiJLf6w4bFquSvGB/F2pyBaqZ4amxocm5KOHBCWljh3HnCqHsIEuiTNtr4wdivILQMVc298tgawNK3EPrzFcvpWP/+ETdWoAGPdtVKb4vEvLsXyLA+cn58clIJ/rqZHiuE/3x4uxseHwxGl5djOJcRjqvRNUiSsMHYKBr2oOrIVQQ5NX16GyPgMnbfIWBa4+0l4GWuD1pP13+jRZl/xM7QbFpZCjlWLrirKvQ+rYPGZsHy6GLqZQMIxloM+YYii/mO+7TH5+FUC5HE8KG5Q6CRP7JKBdPcEsnddOI2Ieu7nYMmZLpBz2/ps2tB6YbXaL3kGNg0s7utxTs6MRrJ06IHD1D/r6jLy/HWGUdy7DtZpgFVR7Tmgw/haH1GIGQhjVP9eDmVlp+iTx1MvrmYT4KA+NA9x3lvj8Pw23TX0/3/Xk0ZDb9anNC9kgPy/G4FgLrKXPlB/0+VKaXFq7Oeh6/IUHPuGe5/hJO1GUBLKxQH0VeDS9PteBcuvFFot5GMHZmFUSxuBxz5Pc4COlk8c/nJd++zjiEx9iJC9cXEV+gELM/AijumhT9QljoAmmgy6bzscuLNhfM/rY+aBItkWvtvO29PXrXO5KPlfNcQqDbYmoUWr/wFLcBz9cM/p8vYYvcyaDbrwowNhTDtgS2jLyR3i4eDpYLV7RyJnqwuftsROU20VPnWXTM52PweE1F08jnduYWtmbGw7iQFzyBwuOOQB62tXQ6eI9Pqz3pAYpaJLQsCPujOXxn2YFotSwdCOrfX1p2gF1tUWuwt/KDjKB9ZXJ/Gi0q+c9qj629E9VyibFPMaZVaAN5XxfOCNSPNvcDEMUPp7ltEj1FyJBC4FqJYZpiFdPhWTPc6CO/n1zpRMNmVd6qwkF7J675vJW4cvdom2YFk+W3AGyavwGAHGu0 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all participants of the workspace identified by the given `workspaceId`. P id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workspaces-by-team.ParamsDetails.json b/platform-api-docs/docs/list-workspaces-by-team.ParamsDetails.json new file mode 100644 index 000000000..00a8ad42e --- /dev/null +++ b/platform-api-docs/docs/list-workspaces-by-team.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"max","in":"query","description":"Maximum number of results to return. Default: `50`.","schema":{"type":"integer","format":"int32"}},{"name":"offset","in":"query","description":"Number of results to skip for pagination. Default: `0`.","schema":{"type":"integer","format":"int32"}},{"name":"search","in":"query","description":"Search criteria","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/list-workspaces-by-team.RequestSchema.json b/platform-api-docs/docs/list-workspaces-by-team.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workspaces-by-team.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workspaces-by-team.StatusCodes.json b/platform-api-docs/docs/list-workspaces-by-team.StatusCodes.json new file mode 100644 index 000000000..660f9d10e --- /dev/null +++ b/platform-api-docs/docs/list-workspaces-by-team.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Response object for listing workspaces associated with a team.","properties":{"workspaces":{"type":"array","items":{"type":"object","description":"Workspace participation details for a team or member.","properties":{"orgId":{"type":"integer","format":"int64","description":"Organization numeric identifier."},"orgName":{"type":"string","description":"Organization name."},"workspaceId":{"type":"integer","format":"int64","description":"Workspace numeric identifier."},"workspaceName":{"type":"string","description":"Workspace name."},"workspaceFullName":{"type":"string","description":"Workspace full name including organization prefix."},"participantId":{"type":"integer","format":"int64","description":"Participant numeric identifier."},"participantRole":{"type":"string","description":"Participant role within the workspace."}},"title":"WorkspaceParticipantResponseDto"},"description":"Array of workspace participation details for the team."},"totalSize":{"type":"integer","format":"int64","description":"Total number of workspaces associated with the team."}},"title":"ListWorkspacesByTeamResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/list-workspaces-by-team.api.mdx b/platform-api-docs/docs/list-workspaces-by-team.api.mdx index ceb533497..10369fb4a 100644 --- a/platform-api-docs/docs/list-workspaces-by-team.api.mdx +++ b/platform-api-docs/docs/list-workspaces-by-team.api.mdx @@ -5,9 +5,9 @@ description: "Lists all workspaces where the team identified by the given `teamI sidebar_label: "List workspaces by team" hide_title: true hide_table_of_contents: true -api: eJzNV9tu4zYQ/RWCTy1g2OlutkD91KS7KYK2aZCk6ENgILQ0sphIpEJScbyC/n1nKEuiY63XdrFAH4JY4lzODOdyVHEnFpZP77kDkVs+G/EYbGRk4aRWfMr/lNZZJrKMLbV5soWIwLJlCgaYS/EPtZiMQTmZSIjZfOVfL+QLKPZAp5fxA5NogRXCOBnJQig35iOuCzCCnFzGazf/dg7OV3eoiUKoI3JwYAhixRU+oLA2C1QacUkAC+FS/hb132YhlPzs7TNV5mBk1MM05N/AcykNoHNnShhxG6WQCz6tuFsV5EUqBwswKJpokwvXvPr5lNf1qIPSRLgTC4XyXTHk4rUF8FyCWW0h+Eu8yrz0IOZgmE6YAVtmeK9O409XGjVmHyER+G7KHj6cPBC4PcG8f7cBRieJBbcbz9UQDvskC4aGsU4WUvmbC0H9F0wWhInS3ZhuvQzDN1htUgz5ss5ItUDLM7o5W2hlwdL5u5MT+vemBP9AG5FGfMrRqSiKTEY+rsmjJZFq24WeP0LktsDdrL2x5tynKcOOQThhWwprdSSFwz5cSpdiz1F5Ut4KQ+3mZIO3VwlcC2MEpQXjz+23IXXN2ve1b7YYnJCZ9RAb/wx/5UA3vo2k6eQ96v3gBq9HZPzKF8DbG9xtDFW8epel4xD2CfoKvM7+fiADe1sIL8osO9RKgjreFJMqysqYakmHiSgMJPLVOwpG93HJuO4NfC0dgY8bne0RSmjToIavean8/ukyM6ZBwJ10ZLGPPtBte+uj0wRj08cZNQUNquUe5d7uQx+O005kt/IzHJOuO1IOxvWOHg+cBoEOrdM2UBQk0dOhoXUuYnaDSwmsO2R69XvsnudgrVgAMYm3E2Sz91vBgQHbB/LJGG22kL8fGLctnWBKO+Ireol4vPTptvQVylzoUsX/1yjx0EJU4jZaeeZzjusJzFmJ/GJ6P6MNhLQo1USdFn7deuox5RNsYTup/FytJ57TTaqGpNSTYO6TefPS8qrSZKibOlfY6WQiCjmOMl3GYwvPmNWx1APrkk7YdSYc1TL7jeTZ2fUlJ2wt9FvKXZOHMIAuFeSx3bT0PPdC+Kb5cdF2yePS+XxJlWivvs7bGgW5/RZACldSAzXCdOki8pe+GXwYMt67zHyTJvrX/gCBUOYaPz+Nf/kwPvEDTFuXC18za95BXRj2LpHjhtduYK36Evx+dHudcQevblJkApkQQvahV+vauaeFSZUxbfl180mALzqWG1QQXnOKEZNeVc2FhX9MVtf0uiFYVFextGKeUcckIrOwI+7jKOpgUE+w6kjxi8hKkuDEBvdHczxB3YGoY8ZHgtpmqDucdZS3dzajB1ScU+scdDk/3Kwn349sjw+rQVQtyVSrEFOXGl9wh6UjALXjC+sIMOtir2comYKIcSBRuprDsyiCIrzErZWxMZt//3SHsmJz6r2Zct76ICTsKy9xp59AYW91COmZANb1F+lRdqw= +api: eJzNl99v4zYMx/8VQU8bYCS5XrcHP63dXYdiW1e0HfZQBChj04laWXIlumnO8P8+UI5/pMnl0gwH7KlNJJEfUiT1TSUJ5l7G95IQci+nkUzRJ04VpKyRsfxDefICtBZL6558AQl6sVygQ0ELFHxKqBQNqUxhKmar8PVcvaARD7x6mT4I5QWIAhypRBVgaCQjaQt0wE4u07WbfzoH56s7hFxGsgAHORI6RqykgRxlLK2bX6YykooBC6CFfEv9l5uDUV+CfWHKHJ1KekzH/h0+l8phKmNyJUbSJwvMQcaVpFXBXpQhnKOTkcysy4Gar34+lXUddShNhHtZOJTvypDDawvwXKJbbRH8Ca8qLwPEDJ2wmXDoS01ekBUOqXRmJD5hBqWmWDz8NHlguANhPp5swNgs80j7ea52cfgnVYjMOlHAXJlwc0Oo/8LkEVyy2M90G/aIxClCp2CXL09Ombms6ynfnC+s8eh5/WQy4T9vSvB3GcnEGkJDvApFoVUS4ho/et5Sbbuws0dMaAvuZu1NNOshTVp5UmY+bEvw3iYKCFOxVLQQENqT81Y4bjdSDW9/ZOAanANOiyLM/beRumbt+zo0W4oESvuA2PgX1okc+ca3SZpOPqDe393gdcTGr0IBvL3B/cYgx3C8y9JxhH2CvoLX2T8McmBvi/Ci1Pq9VrJS62BKKJPoMuVassNEFA4z9RocDUb3ccm47g18LR0DHzdWHxDK0KazGkPNKxPeny4zIx4EkhSxxT76wdm2tz6RZYxNH2fcFDyolgeUe/sehnDIEuhb9QWPSdcdHx6M6z09PnA6CHTXc9oGKuuat57uGlrnkIobfC7R03umV/+O3cscvYc5spJ4O0E2e7/duGPA9oF8ds66LfKPO8ZtKyeEscR6xS4xlWH36fbuK0viwpYm/b9GWUfSY1I6RaugfM4RHLqzkhYyvp/yC5QjLSxLp3l4boP0iOXYurkfV2Gu1uOg6cZVI1Lq8WDus3n30uqq0mkZywVR4ePxGAo1SrQt05HHZ3QwUnbHc8kr4loDcS2LX3m/OLu+lMzWot9y7po8DAPoUsEe25eWP8/CJhmt/7lou+RxSSFfymQ2HF/nbU3Bbr8FyOEqbqBmM186JOHSN4Mfhow5KB2aNLO/9At1JDlzjZ8Pow+Tk9EkTDDrKYdQNGvhwW04bF5Wx42w3YCt+hr8fnp7nXLCVxoXGpRh5BB7tS6ee34xuTTiVmA3vwkiGXcyd1BC00gurCc+V1Uz8Pi303XNXzcKiwsrVR5mmlsmA+1xT9zHadSdQT3hqlPFL6BL3iFZDh5Oc7xC3UPUSeMjobYl6h5nnebtnU35g1Ps7Z2X88PNevT9KA74ZbWTqlWZZjVk6lITCu596RhA7fmJdQTMutjraR3JBUKKLqSrWTxLEiyGl7j1ZmwM598+38lIwubYezPmgvWdSFXV7LizT2jquifkzwxY1/8CfoF20Q== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all workspaces where the team identified by the given `teamId` is a partic id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workspaces-user.ParamsDetails.json b/platform-api-docs/docs/list-workspaces-user.ParamsDetails.json new file mode 100644 index 000000000..af52a255a --- /dev/null +++ b/platform-api-docs/docs/list-workspaces-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userId","in":"path","description":"User numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-workspaces-user.RequestSchema.json b/platform-api-docs/docs/list-workspaces-user.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workspaces-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workspaces-user.StatusCodes.json b/platform-api-docs/docs/list-workspaces-user.StatusCodes.json new file mode 100644 index 000000000..f860ecf6b --- /dev/null +++ b/platform-api-docs/docs/list-workspaces-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orgsAndWorkspaces":{"type":"array","items":{"type":"object","properties":{"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"orgLogoUrl":{"type":"string"},"orgType":{"type":"string","enum":["academic","evaluating","pro","basic","internal"],"x-enum-varnames":["academic","evaluating","pro","basic","internal"],"title":"OrgType"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"workspaceFullName":{"type":"string"},"visibility":{"type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"},"roles":{"type":"array","items":{"type":"string"}}},"title":"OrgAndWorkspaceDto"},"description":"Array of organizations and their associated workspaces to which the user belongs."}},"title":"ListWorkspacesAndOrgResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workspaces-user.api.mdx b/platform-api-docs/docs/list-workspaces-user.api.mdx index b4813cf9a..424699550 100644 --- a/platform-api-docs/docs/list-workspaces-user.api.mdx +++ b/platform-api-docs/docs/list-workspaces-user.api.mdx @@ -5,9 +5,9 @@ description: "Lists all workspaces and organizations to which the user identifie sidebar_label: "List user workspaces" hide_title: true hide_table_of_contents: true -api: eJzdVlFv2zYQ/isEn1bAtbOtGzA/zV3TLVixBonbPQQBSklniQlNquTJrmvov++OkiwpdtJsj3tJJPJ4993n+z5qL1HlQc5v5Nb5+1CqFIK8ncgMQup1idpZOZfvdMAglDGijxLKZsL5XFn9VXFcEOjEttBpIbAAUQXwQmdgUa80ZCLZxeVcb8CKT7x7kX0SCRhn8zAVy0IHoW1qKiotEofFsNa2AA+DtFRdlMqjTnWpLJ7AcurEGtYJ+KmcSFeCj4EXWdve34diHyieQii9WgOCZ3b20tILhTa4aVszL6XCQj4ki88LW63B67QnIJb18LnSHqgm+gomMqQFrJWc7yXuSk6vLUIey6+cXytsln5+Jev6lo+HknqjX4hO/HB2xv/Gtd//SUdTR1ks8q4qS6PT2OnsLnDI/rioS+4gRW7ZMy+omwLEZ1jYrCdmcER5r3bMAsI6PCsVE/2MNicc+1fk+hAd0Gubt3vvXO4+ePPY9jKuPdybSKAfhKdcpSqDtU55aaNMRdTEfcJLfxMV4hbj81YZVsKXl3z25UZ5HoHw35KgRsN43rcICexhup/NzOHEo/wcIt5WxjwatdFBJ9po3D3F1OXVxcfF8pxWrv9YXJ2/Gbbxsc9A+bwzzxqODkFdjwgZztgbdJxxPNQLzifc6oHCWfOkb+2FCsGlWiG5zMAzjt2oMxs5RDAWP4EhSFet0Bgrhb46JbXXKhOsZwj4bzTXW8CNpHEKKofI7JP66QJPcNk3cu6980fIfzxhEp35CeuQXd1tCQ+HB0grH+eCHO81KA9+UZHFzW9u2X/IDgvHhplDxMjuN5cz5na2b5yxng3uEU7oN52DVqxaWSCWYT6bqVJPU+OqbBrgM+GZanfkpNdxR1wahawG8RvHi8XlhWQ0Hdhr5rbhaQj5QBVXlK3X8nsSg1io8eFtp7O7LUYStF25eLzltUXBZb8FkNvVPHtNMA+FSuNQjJsftkxzoU2U+cr92m+wTom5ps73019+mp7xWukCrlWcqfZG4vltxnvE/Ajovp/P/99d3v7MCF9wVhpFFzPxVDVXRDOiN/HaptD54foef+0UxCqH7fdk3kDXS13zMonbsxbokexfq4TngSY504GfSQkrZQI8QfZ3V63cX4gnPgtOdtCZqWUr5VuG3+jxHnb9d0h9S5EF0HXkI7Jmc5GmUOLg2JEljdT8+/mSYtVYNQ9UErOfhEScxYiluwdLvHUIkd8ZYF3/A67tnOI= +api: eJzdVktv20YQ/iuLObUAIzlp0INOVRqnNRrUhh/pQRCQETki1yZ36dmhHIfgfy9mqQdlya7bY08id17ffJpvli0I5gEmM3jwfBdqTCnAPIGMQsq2FusdTOCzDRIMlqXZeRl0mfGco7PfUf2CEW8eCpsWRgoyTSA2NiMndmkpM4vHeJzbFTnzVa1n2VezoNK7PIzMdWGDsS4tm4yCWXgphrUeCmIapA0GTY0sNrU1OjmC5VhERdWCeAQJ+Jo4Op5l6/b+2ha7CcSQQI2MFQmxstOCw4pgAj1uSMAqLzVKAU/J0njjmorYpjsCYlmm+8YyZTARbiiBkBZUIUxakMda01snlMfyS88VSn/083vourmGh9q7QEEj3p2c6M9+7fM/IIHUOyEnasW6Lm0aOx3fBnVpD4v6xS2loi2z8iK2L+A5D1OX7YgZhCAzPioLQlV4VSol+hVtJur7Z+R66x2ErcvXts8+9zdcPme+jmdPbQmQayqdckwxo8qmerTCskHp7TV7SGCBIZoUHzssVQnf3mjsmxWyjkD4b0nESql4ztcIu2Snt1czs414lp+tx6emLJ/1WtlgF7a08vgSUxeXZ1+m16eQwNXv08vTj8M2vuwydAmwL181HBsEXbdHyHDGPorXjPtDPdV8xi+fKFw1LwVZNhiCTy0KZcOdcbiNNssGhgj2xT912Tnnl2uhKdYugffHpPYBM6N6piD/RnO7FTCDikLAnCKzL+pn43iEy10jp8yeD5D/dGRJbJafcV50q/sHymKqQGnDcS5mLXwgZOJpIwVMZnPdPxVJ4XVh5hQx6vabwFi5Hbf9ZuzGg3tEE/Jqs0EbVS0UInWYjMdY21Fa+iYbBbonxpH1B5v0KlrMRYmiajC/qr+ZXpyBotmAvVJue56GkLdUaUVY71p9X0QnFWp8+LTR2e2DRBKsW/oYvuZ1jULL/hNAbdfq7PXOOhSYxqHYb37YMlVoyyjzpf9lZ1CdEoe+ztvR25N3oxM9rH2QCuNQra8kHeB+vveo30Pa7gb0/3eZr/9noW8yrku0Tnlq+juin9FZvLchgcn2/t7/3Cl8EHVr2wUGuuGy6/T4viFWMcwTWCFbXOhAzFrIbNDnDCZLLAO9QPYPl2u9/2he+C442sFmmzrdpXrN6BskcEePuw+Rbt4lUBBmxBFZb5ymKdUyCDvYSXty/u30GhLAfdk8kUnMfhRS2/Ye1/6OXNdtEYq+K8Cu+xu96J0H sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all workspaces and organizations to which the user identified by the given id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/list-workspaces.ParamsDetails.json b/platform-api-docs/docs/list-workspaces.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/list-workspaces.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/list-workspaces.RequestSchema.json b/platform-api-docs/docs/list-workspaces.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/list-workspaces.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/list-workspaces.StatusCodes.json b/platform-api-docs/docs/list-workspaces.StatusCodes.json new file mode 100644 index 000000000..c5c9b1e20 --- /dev/null +++ b/platform-api-docs/docs/list-workspaces.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workspaces":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Workspace numeric identifier."},"name":{"type":"string","description":"Unique workspace name within the organization."},"fullName":{"type":"string","description":"Full display name for the workspace."},"description":{"type":"string","description":"Workspace description."},"visibility":{"description":"Workspace visibility setting. Accepts `PRIVATE` or `SHARED`.","type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"}},"title":"WorkspaceDbDto"},"description":"Array of workspaces in the organization to which the requesting user belongs."}},"title":"ListWorkspacesResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/list-workspaces.api.mdx b/platform-api-docs/docs/list-workspaces.api.mdx index 67f26591c..f8e869a94 100644 --- a/platform-api-docs/docs/list-workspaces.api.mdx +++ b/platform-api-docs/docs/list-workspaces.api.mdx @@ -5,9 +5,9 @@ description: "Lists all workspaces in the organization identified by the given ` sidebar_label: "List workspaces" hide_title: true hide_table_of_contents: true -api: eJzdVsFu4zYQ/RWCpxYI7LTdFqhP9TbZNmjRBkl2ewgCmJbG1iQ0qSVHdl1D/94ZSrIs29ik154skY8zb55mHr3TZJZRTx71xoeXWJoMon660DnELGBJ6J2e6N8xUlTGWtWjFDpFBSgflsbhP0agCnNwhAuEXM23aXuJa3BqxqibfKbIq02BWZG2AnyuIBK6paoiBDUH690yjtRffRITQGH01hCHBLfG4N2Kc0S1QSqYgnFDBpsC+IjEiyrjzVA5VWIJFp2Ec7laGWeWkj36KnCOkb7QvoSQzt/kbbk9B94uTTArII7JSu204xeGpZp4F0Wi0lChj3X785CZq1YQMOs1CpJZRMAAnJZCBRc6ZgWsjJ7sNG1LyYKOYAmBoQsfVoaapR/e6bp+kuOx9C4ySz7x7eWl/Bxx+I2PZp6jOJJdU5YWs0Rp/BwFsjtN6ufPkJFUHkQawibBQY/0WBOC2YoMBKv4egzM31LcsZL7z3FWxvqi/Sb7wJEC99VJmI8Ouef6LlZyrGul425OcReVtX+8KfYHRqocY2nNtonLNaWg+3Qp4uDUa0H7ug/WU5g1RpyjRdqefvP+VI9SEUhmbaSmWQYlT9Ds9u7m0/ThesZVq9n9r9O766uZ9OQxJWDNxSJaPK80YDEKQrIC/tTTqet+ec/kan5F/qR8PZXmUX7xmrG8yTgGmYdDfNfOCUME9O7cpLw3eRf6v4xMP8GPegUxsrkkYb44BR3wpAEOS7gOwYcT5t+dmfHOvpTzJD7tN8xH4BGyKqQeYd96D2ynYVqxU00en8Q+2NQKL5a3hMRRTGyixyx9HO+Sv9XjzaETstzrzgarYBlcEJVxMh6bEkeZ9VU+ivCZ6YzQn3TzfdpRt2znMu/qZ8Gr6e2NFjId13uRtpHpkPFeKcmoW6eU93kC8Urz8KFzkucNJQ3QLXw63sraspC0rxGUclF6sgFLT5gs9cSw+MOSuS3QJiNb+J/6DRlZVq7J883ox+9Hl7JW+kh8I0nI9lqRxlUD0Y8cY9+Z//97uf3iBH/TmH2Vb1qWLEm/a5v1Ua5hEWnSXcfDPzIF6yuo3W5uInwMtq5lmSsMMhT8uDYBzVw6g3ua/VueeSQWxkb4gvZf3bVz/7V6wzV/tpDuAnVyfa6NreSNH19gu/97UT8xsACTc4cLwWavsfCDUycWNZjuX64fGGuGY3Q0Nin6WUYsXUI8+BdwLF9HkORdCNb1vzgkmqg= +api: eJzdVk1v4zYQ/SvEnLqAYGe3ix50qrfJtkGLNkiy24NhwLQ0liahSGVI2XUF/fdiaNnyFzbZa0+2yOHMm6c3j2oh6MJDOoW142df6ww9zBLI0WdMdSBnIYU/yAevtDFqiFJkVShROS60pX+1hCrK0QZaEuZqsYnbBa3Qqrnj4jafq+DUuqSsjFuMLw36QLZQjUdWCzTOFn6k/h6KaEZF3hkdMFdoV8TOVmiDV2sKJVml7TGCdYmMMZ9XmbaKG6tqqtGQlXQ2V5W2upDq3jWcoR9BAq5Gjudv877dAQMkUGvWFQZkYaoFqyuEFGJPkAAJRbUOJZzy9tchMttUyJQNHLFUFhKIMYc0cIMJ+KzESkPaQtjUUoVswAIZElg6rnTYLv30EbpuJsd97axHLyc+XF3JzwmG3yGBzNmANsiurmtDWYQ0fvIS0p4XdYsnzIJ0zkJNoG2BA40MsZpZb4SGgJV/PQflb2nulMn967hIY5f072Sf2AcmW5yl+WLppcFBxUqO7aR0quaYd9kY8+ebcn9ujFE5+drozTbv0nFMui8XMx6dei3p0PfBekyzIk8LMhQ25+98ODVEKY9BZm2kJlmGdfBqfnd/+3XyeDNXjtX84bfJ/c31XDR5CgltU4lF9PGQwDZYjCJQMBL8dYDTdcPyHsn14jq4s/ZhIuJRbvmasbzJOI4qHw/xfT8n0HUS9PHSpHzS+S7194zMMMFTqNB7XWAk5ptTsAs8E8BhCzfMjs+Q/3hhxnf2pawL4tNujXlM5TFrOGpk2sIn1Iw8aUIJ6XQm9lFhKJ1YXoERo5hYCmPHhR+30d+68frQCT3yameDDRtIoQyh9ul4rGsaZcY1+cjjC7IekTtT80PcUXdGB5l39YvEq8ndLQiYHdYHoXZL0yHiPVNSEXqnlOdFDIKk//N55yRP6xA5ILt08XhPa49Cyr4GUNol0eQ2WDShs6iJ4+YPW8ZKk4lGtnQ/Dxsyssh+W+f96P3Vh9GVLNbOh0pHTfX3iihXHbF+Yhl7af7/L+b+lQf8J4xro8kKZZH7tlfrVO5hISnd3cfHXzKl80Gi2nahPX5h03Wy/NIgy1TMElhpJr0QaUxbyMnL/xzSpTYev8H9D/f94L9Tb7jnLzayu0Gt3J8rbRp5ggSecbP/vuhmXQIl6hw5AtzubT384NSZRx2N9683j5CAPp6jk7mJ2S8iatttxKN7Rtt1e4BBngVg1/0HP7GazQ== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Lists all workspaces in the organization identified by the given `orgId` to whic id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/pause-action.ParamsDetails.json b/platform-api-docs/docs/pause-action.ParamsDetails.json new file mode 100644 index 000000000..68b0c8809 --- /dev/null +++ b/platform-api-docs/docs/pause-action.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"actionId","in":"path","description":"Action string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/pause-action.RequestSchema.json b/platform-api-docs/docs/pause-action.RequestSchema.json new file mode 100644 index 000000000..6672aa144 --- /dev/null +++ b/platform-api-docs/docs/pause-action.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","title":"EmptyBodyRequest"}}}}} diff --git a/platform-api-docs/docs/pause-action.StatusCodes.json b/platform-api-docs/docs/pause-action.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/pause-action.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/pause-action.api.mdx b/platform-api-docs/docs/pause-action.api.mdx index dc8bdcee7..2f71a2285 100644 --- a/platform-api-docs/docs/pause-action.api.mdx +++ b/platform-api-docs/docs/pause-action.api.mdx @@ -5,9 +5,9 @@ description: "Pauses or resumes the pipeline action identified by the given `act sidebar_label: "Pause or resume action" hide_title: true hide_table_of_contents: true -api: eJytVe9r2zAQ/VeEPm2QJtmWDZZPS0sHZbCGtGMfSqCKfUnUypYqyUmN8f++O8mu84t2g31pLel09+7p3UvFvVg5Pr7jIvFS547PezwFl1hpaM3HfCoKB45pyyy4IsNPvwZmpAElc2DxHpMp5F4uJaRsUYaIldxAzu7j+VV63+c9rg1YEddt5kk4xzMjrMjAgyU4Fc9xgTHtdQyQhMYIv+aHEGMO5ryV+aqDYjHQwlMhLWA5bwvocZesIRN8XHFfGioQL/G67r3U3Gr76IxIoCv7VIAtj+r+bgNZjsRYmezXPqolcw+rcLTUNhM+bn0ZYfV5hArOn+u0pDuJxujc06cwRskkEDd4cFS6Ok6uFw+QeMztpVe0cZkZX1K2WUyMVbBLLOMMPjQ4uvtxOKJ/+21d/2Bn7KdmLQK8NBoOj+PORcoa0Fj2r/F2T3LHUU5OrIBUd9iGsaQWLyPQNvDUw3UdW6vtrOmvaXc0/HSiw1aHLNeeCaX0FvFQuIOksNKXQYPnICzYSYGSG9/N6Y1QoGtN2jU6NB3kOOaDZnoGVavXemBI3aQCsJtW1IVVGL323rjxYCCM7CdKF2nfwRMC6kt9JLGbcMKmSnjSDLugeDaZXnGC06K9IXIjUbuYX7iiiq0gab0IQbgTP763anzY+sACPdqsk+Pls8gMMVzVNA9LHVI3pDcICdJb4IkKmaCDxGBSDPJFyfaJ2aUDRSNVGJSl/tYdIBBiNdb50P/6uT+kPXqWTATBNcMcTKZzr8avDqHujNt/NbyGfw/PfmCUQC9BkKHZqtFO57w9Pt5xuygffOM1KQ3DqmohHPyyqq5pOzoSiSqVTiwUzdNSKAevdPaGX50E+wjlkSVuhCooMmhwI6yk+v+I5d2ssYH37BX7Pgmp2RR5uYulhfrCYT3H2DWIFDMRtnh8ERGc3VKS7vqRZdHvQbwxSRIw/tXYXWeYXt/c0mQ1Np7plO5YsaVfI/wboGoT35zskPYqrkS+KoLD8ZiT5lDsj/HB2IauTpKBWgkRt/oRctRLy42nNRFT138AzQHBFw== +api: eJytVd9P2zAQ/lese9qk0BZW7SFPK4hJaNJAwLSHqhLX5NoaktjYTksV+X+fzk6aQivYpD21tu/Hd3fffWnA4dJCOgXMnFSVhVkCOdnMSM1nSOEGa0tWKCMM2bokK9yKhJaaClmRiH5C5lQ5uZCUi/k2WCzlmirxEN+v8ocBJKA0GYznLvIkvEMCGg2W5MgwnAYqLAlS6NwhAcloNLoVvIUYYwjrjKyWPRQDCRh6rqWhHFJnakrAZisqEdIG3FZzgugE3ie7nBtlnqzGjPq0zzWZ7UHe352hqOqSjMxe5z7IJStHy/C0UKZEF6++jsH7WYRK1p2rfMs+maocVY7/otaFzELjho+WUzeHwdX8kTIHCTjpCr64LLXbcrTbGBi8957TWK0qS5Z9z0Zj/nld1vUPcSJ+KtEh8AmMR6NDu3PMRQsakr/H249kCiVZi0ti1r0tQxtmi5MRaGd4bHB9xcYoc9vW15Y7Hn05UmHHQ1EpJ7Ao1IbyEMpSVhvptoGD54SGzKR2K0inM55RSW6lmLtahaIDHVMYttszbDq++qFmdjMLyKw7UtemgBRWzmmbDoeo5SArVJ0PLD2TwYFUBxS7Cy/ipkDHnBEXbC8mN1fAcDq0d9zc2Kh9zLteccaOkHyeByNI2j/fOzY+blzoAg/ttqfj5QuWmjvceN6HhQqh26a3CBnSR+C5FTIj2xozYzALjHndmP12UImyCIuyUN/6B58AdzXmOR2cjs4GI77kuZQYGNduc1CZXr5awXqLdW/f/qvitQNw9OKGukBZMchQbdOSp5feBNI9uYv8mSWwYqqlU2iaOVr6ZQrv+TpKErMqlxbnBS/UAgtL71T2gWAdBftE2wNNXGNRs2Ug4RqN5Pz/iOXTbasDn8U7+n0UUnuJ1XYfSwd110M/8wmsCHMyAVt8vogITu45SO9+oFn8QYgekywj7d613ZeGm+u7e16tVsdLlbOPwQ1/jnAToSodZ856yHcNFFgt6yBxEGPyIuLrPX6zt6Gqo81ommhxr56o8n7XG8dnboz3fwDszME8 sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Pauses or resumes the pipeline action identified by the given `actionId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/refresh-data-link-cache.ParamsDetails.json b/platform-api-docs/docs/refresh-data-link-cache.ParamsDetails.json new file mode 100644 index 000000000..af582ada8 --- /dev/null +++ b/platform-api-docs/docs/refresh-data-link-cache.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, refreshes cache in a user context.","schema":{"type":"integer","format":"int64"}},{"name":"credentialsId","in":"query","description":"Credentials string identifier. Filters cache refresh to data-links accessible with the specified credentials.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/refresh-data-link-cache.RequestSchema.json b/platform-api-docs/docs/refresh-data-link-cache.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/refresh-data-link-cache.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/refresh-data-link-cache.StatusCodes.json b/platform-api-docs/docs/refresh-data-link-cache.StatusCodes.json new file mode 100644 index 000000000..4795624ef --- /dev/null +++ b/platform-api-docs/docs/refresh-data-link-cache.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/refresh-data-link-cache.api.mdx b/platform-api-docs/docs/refresh-data-link-cache.api.mdx index 505c66efd..7a21a60d9 100644 --- a/platform-api-docs/docs/refresh-data-link-cache.api.mdx +++ b/platform-api-docs/docs/refresh-data-link-cache.api.mdx @@ -5,9 +5,9 @@ description: "Refreshes the data-link cache for the given `workspaceId` or `cred sidebar_label: "Refresh data-link cache" hide_title: true hide_table_of_contents: true -api: eJzNlFFv0zAQx7+K5ecuLTCQ6BNjMFSBxMSGeECVdksujaljZ7bTUkX57tw5ydJ20+ABIZ5a+y727/+/8zUywMrL+XeZQYATrczay+VEZuhTp6qgrJFz+QVzh75AL0KB4j5TpJDSOrcu7q/UBo242Vq39hWkuMhuBIVuUocZmqBAe9pKxIV1KR2lyhIzBQGFw5NM+dRu0O2EzQVsQGm41ShSbetM+GAdrDjP25q/TeRE2godMN8iGwnfEdonIjtnMEqqwEGJAR1LbKShBSXvEVKOYoV3Nd0tj3V/GxKFqUt0KhUqKskVukQscmFLFQJmE0IbHOo8UUaAqD06kVoT8GdgZE+REuS8kWFXMYii0AodhcjDEkK39epUtu3knvbAvqd5z8dUMs0pszoAvlCaregRe2QR7FhRLyAlf71i87cqFLGwvsKUj8jEHsujgrpLCZ9aiA6vrPHoOf58NuOfQ9zPH2U7kaezF4+EhuoKY4MAre0WM7ZFekxrp8IuFvQtgkN3VoeClku+lapdWO6IFYbYAByS01HhNKqf9upZBLrN0CC105RdhFD5+XQKlUpiByYe74gnUfaB5VcxIi41BK6hOI8de3a5kEwzwF6xUZ0T+8j3vvGNg5+8vo1JtNP9uRi648c2RBOUyW38XAWNIwVf+ztAlqv4/XXJ3J6QBj7sUPy+ZCqy0rE5c/tmDBAIO9fd8yx5/TKZ8V5lfSjB8JF9C/ev83hyHLM2kYb66z8dOX2x+DlPKw30EEltdK3pG+1gjJK5vcqh2agjCjKH85rmFjx+dbptebt7z9yChMUc1MI50eMTFv3l6fSoujXuHgzMDeiaMyUPqT/H/dfD6Qk9xyN1VLTkhVMsKU6UvYHy4f01pcLhwz16qLGCfQjMbu9oqnfMuLZrNFTzASXwmu5t2/YXJ5eixA== +api: eJzNVE1v00AQ/SurObtOWioOPgGFoggkKlrEoYqUqT2Ol9i77u44IbL839Gs7Xy1KhwQ4pTsznjnvTdvpgXGpYfkHjJkPCu1WXmYR5CRT52uWVsDCXyl3JEvyCsuSO0yVYppQSq3Ltwv9ZqMWmysW/kaU5plC2WdWqSOMjKssfSzbBGra+tS8kpXFWUamZSjs0z71K7JbZXNFa5Rl/hQkkpL22TKs3W4lDxvG/k2hghsTQ4F3yzbI3yPjJ+1WV0JMIigRocVMTmh2ILBiiCBA4QQgRaGjw25LZzy/j4mKtNU5HSqdGCSa3KxmuXKVpqZski5nUK9JtooVI0np1JrmH6yQPZpQRVC0gJvawGiDdOSHESQW1ch91evL6Hroh3aI/lexnu1T1WenTbLI8DXuhQpBogDZMV231GvME3Jey3ibzQXobG+plSeyNQBlmcJ9UWh6+YROPK1NZ68xC+mU/k5hvvlE3QRXE5fPRMau6uMZYVlaTeUiSzgKW2c5m1o6DtCR+5twwUk93OpWhEXVhyxJA4GkBBM9gwngf1kYC8kyK1HgzSuhAQK5tonkwnWOg4OjD09ksNY2yeS34aIuimRpYfqKjj27c0MBM0I9laE6pU4hLzTTSqOesr5ISRBNPy5Ht3xY8NBBG1yGz7XXNIehZT9HUChq2X++mSxJ6Ysjx2TP6RMFeoymDO3b/aBLgJRrq9zHp9PL+KpXNbWc4VG3hw8PIzn6eo4BdsGOGT4P905Q7dknid1idoI2yBbOzjtaI9GMLIc3TaPoLCeJa9tH9DTN1d2nVz3Ay0ezLQXHBkkOZaeXpDoL6+nZ9mtaPtkY66xbCQTZEv9Odx/vZ1e4HO6U/eM5nJwWiiFlXKwUT5+uIMI8HhyTyY1dHAIodkePN22fcadXZHpOhihsJyhm3dd9wsfuKLp sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Refreshes the data-link cache for the given `workspaceId` or `credentialsId`. Fo id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/remove-labels-from-actions.ParamsDetails.json b/platform-api-docs/docs/remove-labels-from-actions.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-actions.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/remove-labels-from-actions.RequestSchema.json b/platform-api-docs/docs/remove-labels-from-actions.RequestSchema.json new file mode 100644 index 000000000..341cf9506 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-actions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels remove request","content":{"application/json":{"schema":{"type":"object","properties":{"actionIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateActionLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/remove-labels-from-actions.StatusCodes.json b/platform-api-docs/docs/remove-labels-from-actions.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-actions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/remove-labels-from-actions.api.mdx b/platform-api-docs/docs/remove-labels-from-actions.api.mdx index cd090f4e7..f432c4a91 100644 --- a/platform-api-docs/docs/remove-labels-from-actions.api.mdx +++ b/platform-api-docs/docs/remove-labels-from-actions.api.mdx @@ -5,9 +5,9 @@ description: "Removes the given list of labels from the given pipeline actions." sidebar_label: "Remove labels from actions" hide_title: true hide_table_of_contents: true -api: eJytVcFOGzEQ/RXL55BNW1qpOTWgIqFWBQFVD1EOk91JYvCuje1NiFb5987Yu2RDEPTQC2LtNzNv3jxPGhlg6eV4KjXMUXs5G8gCfe6UDcpUcixvsDRr9CKsUCzVGiuhlQ/CLESKEAtnyt6tVRa1qlBAzhn8UA6kseiAvy6L54w/Y/QFBU8SkHAWHJQY0DGjRlb0QfiNcQ/eQo4UPZCKST3W6LbyJdU/HVBUdYlO5UIVWAW1UOgI7PMVliDHjQxby4lVFXAZrxbGlRDS0ZdTuduRDA6pig9npthyzGGpxF642IpooZQoN5SzChwA1mqVx7aze89RzTEFM7/HnAOtY5GCQh9j86SW70HBOeCeVcCyf+6DU9WSOA/SDP8t6o3eKVFQQTNq4r3JFQRMM0pd37TdRiS3rhzSXIOrMR54S9NMfXwcnR5rd/VDnIhfRnRaUdDp6NMruM41ojJBgNZmQ3W4qMe8dipso0vOEBy6SR1W9DnjyZGFVoadZk0cigW+k1nryCwZN0vDY2OgW3eeq50m6CoE68dZBlYNc23qYujxkdgMlTly3W28EdcaAkspzhkvJteXkrl0VG958kmUPuHneXDFzqP8PY8gOkn/XHRDut+EKAE76mbv0O9PUFoe2YF3pp05Zn1vTEezHb+jhYn121G3bTDv9zpkvVROOyGBeY5UlJMdqtfXjGyvdDTZwnzbXxARlj7V+TD8+nk44jMeXAnxybRLIC2Ng50Dz3vjgG6zf4T/ZXm1Awr4FDKrgfYPEYyNNq2zpnJPpV2j/A6iu0j5FbuQQE0zB4+/nd7t+DjtMPZcoTzMNb+hBWiPb/TzzoZ7leoDbo+W6Bp0zcho0TU4xfXj8yG6CAVlY2Ip9DyVP7nj7PvYo/128PSur27v2L3t9ixNwTEONiwN/aXa/LuQZCNAPGtIvmpZw5KxKSd7HQ6fyounEZl2267a9hiS4BFxZx6wItE7LQJ/E11K/heMh2sc +api: eJytVcFOGzEQ/RVrzksSKOphT6WoSKhVQUDVQ5TDZHeSGLy2sb0J0cr/Xo29S5IGQQ+9Ze0Zz5v33kw6CLj0UE5B4ZyUh1kBNfnKSRuk0VDCHTVmTV6EFYmlXJMWSvogzELkDLFwptm7tdKSkpoEVvyCH0EBxpJD/rquX1/8kbKvnGkuciAUYNFhQ4EcI+pAY0NQwsa4J2+xousaCpAM6rklt4W/of4eAoVuG3KyErImHeRCkoMCfLWiBqHsIGwtPyx1oGW6WhjXYMhHn88hxlkBjp5b8uGrqbecc1gqoxcutSL6UCigMjqQDpyA1ipZpbbHj56zumMIZv5IFSdaxyQFST7lVpktvxeKziH3LAM1++c+OKmXEGORNfy3rHd6jwUEGRRHXXhvKomBska567u+2xTJrUtHNZTBtZQOvDXa5z7OJufH3N18FyfipxEDV7GA88mnN+IG1whtgkClzIbq1KenqnUybJNLvhI6chdtWEE5nbFyDYWVYadZk0SxyHcw7h05zsYdZ/HYGOTWg+dap6CEVQjWl+MxWjmqlGnrkadncjiS5sh19+lG3CoMTKW45HhxcXsNjGWAes/KZ1L2Ab/qwRUHj/L3PAVB0f+4GkR63IREATvqbufQby/YWJbswDvTwRyzfW9MJ7PIc7QwqX4vdd8G4/6oQ+ZLVuT7YNYRq+T5Q/b2OaMGpUomW5gvu4tYAFOf65yOTidnowkfsnINppnpt0DeGgdLB18XxwHebjeF/2V79QoFegljq1BqBpg67XprTWEHpd+jPAjJXrMCVmzDcgpdN0dPv5yKkY/zEmPT1dLjXPEQLVB5eqefD1bcm1CfaHu0RdeoWo5MHl2jk1w/zU8BK8KaXAKWUy9z+ZMHfn2Xe7TgDmbv9ub+ge3br8/G1JzjcMPU4IZr8x9Dpq3s8lkHCvWyxSXH5jfZ7Hg4K3/NRkI6rDu93UPYdTniwTyRjhEGLgJ/Q5zFGP8AfFJrQQ== sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the given list of labels from the given pipeline actions. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/remove-labels-from-pipelines.ParamsDetails.json b/platform-api-docs/docs/remove-labels-from-pipelines.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-pipelines.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/remove-labels-from-pipelines.RequestSchema.json b/platform-api-docs/docs/remove-labels-from-pipelines.RequestSchema.json new file mode 100644 index 000000000..f68cd3840 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-pipelines.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels remove request","content":{"application/json":{"schema":{"type":"object","properties":{"pipelineIds":{"type":"array","items":{"type":"integer","format":"int64"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociatePipelineLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/remove-labels-from-pipelines.StatusCodes.json b/platform-api-docs/docs/remove-labels-from-pipelines.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-pipelines.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx b/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx index f125733ee..5d3a92e11 100644 --- a/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx +++ b/platform-api-docs/docs/remove-labels-from-pipelines.api.mdx @@ -5,9 +5,9 @@ description: "Removes the given list of labels from the given pipelines." sidebar_label: "Remove labels from pipelines" hide_title: true hide_table_of_contents: true -api: eJylVd9P2zAQ/lcsP5em29ik9WmAhoQ2jQqY9oB4uCaX1uDExnZaqqj/++7shKYUjUm8VLV9P7777rtLKwMsvJzeSg1z1F7ejWSBPnfKBmVqOZVXWJkVehGWKBZqhbXQygdhSpE8ROlMNXi1yqJWNfqxHElj0QEHuiieQ/2MbufkNetNydKCgwoDOgbTypoO5LE27sFbyJH8R1IxnscG3Ua+RPmnNxR1U6FTuVAF1kGVCh0Z+3yJFchpK8PGcmBVB1zEp9K4CkK6+nIst1tiwCFl8eHUFBv22U+V8AsXixGdKQXKDcWsAzuAtVrlsfDs3rNXewjBzO8xZ0frmKagiAd67fm7KPzAGJwDrloFrPz/1TFKLX13HAoUVNBsdeK9yRUE7DuXuLjqOIi2TIhySP0OrsF44a2pfaru4+T4kNHLH+JI/DKiZ5CcjiefXrHr1SRqEwRobdaUh5N6zBunwiZq5xTBoTtpwpKOd9xPEtbSsAKtia2ywG8ye9ZqlrScpaayYNCtei02TpPxMgTrp1kGVo1zbZpi7PGR8IyVOVDjdXwRMw2B6RRnbC9OZheS0fRgr1kRiZYh5OeecMZeu3yeRyO6SX/O+0bdr0MkgZV2tVPu9yeoLLfthaZuJ3dDadBxy6NVmpi663RXAUN+qzimSuW0IZIxNxHyOAb7xA3poklQOmqsNN92DwSEWU95Poy/fh5P+I67VkGcom4vpE2yt4HsYJnsAW53k/m+Zda1JeBTyKwG2kaELdbYdoq6lUMU3UblCYiqItqXrD8ya9s5ePzt9HbL12mnsdYK5WGueXpK0B7/UcobG+9VsA+4OViqK9ANW0ZprsApzh8Hh+AiFBSNgSXXs5T+6Iaj73wP9t3e0M0ur29Ytd02rUzBPg7WTA39Um7+UrB3HIZ41xJ99aKBBdummKxx2B+RFyMRkfabrt4MEBLh0eLGPGBNpPdcBD4TXAr+F3uQbqA= +api: eJylVcFu2zAM/RWBZzdJu2IHn9YWKxBsWIu2ww5BDozNJGplSZXkpIHhfx8o2Y3TFOuA3mLpUXx8fGQaCLjykM9A4YKUh3kGJfnCSRuk0ZDDHVVmQ16ENYmV3JAWSvogzFKkCLF0phrcWmlJSU1+BBkYSw75oWn5+tTPGHbtTHXbQyEDiw4rCuSYTAMaK4IctsY9eYsFTUvIQDKf55rcDt6y/NMDha4rcrIQsiQd5FKSgwx8saYKIW8g7Cw/LHWgVbxaGldhSEdfz6Ft5xk4eq7Jh0tT7jjmMFXiL1wsRnRQyKAwOpAOHIDWKlnEwsePnqOaYwpm8UgFB1rHMgVJnm97/aalH4DROeSqZaDK/18dWWrpp99pMwgyKEZdeG8KiYH6ziUt7joNIpYFkY5KyIOrKR54a7RP1Z1Nzo8VvfkhTsQvI3oF2wzOJ1/ewfVuEtoEgUqZLZWxUk9F7WTYRe9cEjpyF3VYQz6bcz8rCmvDDrQmtsoi38H41avj5OVxaiobhtym92LtFOSwDsH6fDxGK0eFMnU58vRMDkfSHLnxPt6IW4WB5RRXjBcXt1NgNj3Ze3ZEkmVI+bUnnLH3Ln8vIgiy7sd136jHbYgisNPu9s79/oKV5ba98dRsMh9aYzaZtzxaSxNTd53uKmDKHxXHUsmCfAfmJmIRx+BQuKFcVKFU0WNL821/0WbAqqc8p6PTydlowofctgrjGHWLIa2SgxVkB9vkgHGzH83PbbOuL4FewtgqlJq5xSKbzlIzGLLoViqPQLTVPIM1GzCfQdMs0NNvp9qWj9NSY7OV0uNC8fgsUXn6RykfrLx3yT7R7mirblDVjIze3KCTnD9OTgZrwpJcJJZCr1L6kwd+fR97tPAOpu725v6Bbdut08qUHONwy9LglnPzXwVHx2mIZw0o1KsaV4xNb7LJ8XBG3sxEZNqvOr0bMGyahHgwT6TbFnotAn9DO2/b9i9vXm7F sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the given list of labels from the given pipelines. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/remove-labels-from-workflows.ParamsDetails.json b/platform-api-docs/docs/remove-labels-from-workflows.ParamsDetails.json new file mode 100644 index 000000000..4a4e17ba9 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-workflows.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/remove-labels-from-workflows.RequestSchema.json b/platform-api-docs/docs/remove-labels-from-workflows.RequestSchema.json new file mode 100644 index 000000000..b0fd9a688 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-workflows.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Labels remove request","content":{"application/json":{"schema":{"type":"object","properties":{"workflowIds":{"type":"array","items":{"type":"string"}},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"AssociateWorkflowLabelsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/remove-labels-from-workflows.StatusCodes.json b/platform-api-docs/docs/remove-labels-from-workflows.StatusCodes.json new file mode 100644 index 000000000..d9634b926 --- /dev/null +++ b/platform-api-docs/docs/remove-labels-from-workflows.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/remove-labels-from-workflows.api.mdx b/platform-api-docs/docs/remove-labels-from-workflows.api.mdx index f53727417..f062ac99e 100644 --- a/platform-api-docs/docs/remove-labels-from-workflows.api.mdx +++ b/platform-api-docs/docs/remove-labels-from-workflows.api.mdx @@ -5,9 +5,9 @@ description: "Removes the given list of labels from the given workflows." sidebar_label: "Remove labels from workflows" hide_title: true hide_table_of_contents: true -api: eJylVU1PGzEQ/SuWzyFJW1qpOfGhIqFWBQEVhyiHye5sYvCuF9ubEK3y3ztjr8mGIKjUC2LtN+M3b95MWulh4eRkKjXMUTs5G8gcXWZV7ZWp5ETeYGlW6IRfolioFVZCK+eFKUSMEIU1Ze92bexjoc3aDeVAmhotcKLL/CXVrxB2QVH3CUrIGiyU6NEymVZW9EERnMzVkCHFD6RiPk8N2o18zfI+AUXVlGhVJlSOlVeFQktgly2xBDlppd/UnFhVHhfhqjC2BB+Pvh3L7ZYUsEivOH9m8g3H7D8V+QsbihEdlBJlhnJWngOgrrXKQuGjB8dR7SEFM3/AjANryzJ5hY5vk36XueuBwVrgqpXHsn/uvFXVglgPYgP/Leqd6imRV14z6tQ5kynwmPoUK7/pKg5YLl9ZpO5622A4cLWpXKzl8/j4UL+rn+JI/DYi6UVBx+Mvb+CSd0RlvABNBOgdftRh1ljlN8EpZwgW7Wnjl/Q54+6RjZaG/Vab0Jga+E6OkrKjaNxR7CC7A+0qGa+xmrBL72s3GY2gVsNMmyYfOnwiOkNlDqx3G27EtQbPaopzxovT60vJZBLXW25/VKXP+KUl/GIyKn/PA4hO4j8XqU8Pax80YFvd7Gz64xnKmrv2ykDT5JBZ3yDT8WzL41SYwKDrd1cIM/+oRlZMZbQVIphbCVmw/r5+fdXI/UoHpxXmZHdBRFj8+M6n4fevwzGfce9KCJPT7YK4Pfa2zrq3QPYIt7tp/L8F1nXH47Mf1RpoAxG3UGPb+Wr6IrgcpCXKYxC8Raov2YSEats5OPxj9XbLx3GNseNy5WCueYQK0A7fqeSDJfcm10fcHOzRFeiGkcGgK7CK3w/TQ3QRcsrGxGLoeXz+6I6z72IPVtze5F1f3d6xd7sFWpqcYyywRvyX3uYfB44OIxHOWpKvWjSwYGzMyU6H/UF5NRiBaVp31abHkAQPiDvziBWJnrTw/E10Kflf9sdsLw== +api: eJylVcFu2zAM/RWBZzdJu2IHn9YWKxBsWIu2ww6BD4xNJ2ply5XkpIGhfx8o2Y3TFO2AXYKEIqXH9x6ZDhyuLKQLULgkZSFLoCCbG9k4qWtI4Y4qvSEr3JrESm6oFkpaJ3QpYoUoja5Gp1ttnkqlt3YCCeiGDPJF8+L1qp+h7Nro6s+QCgk0aLAiR4bBdFBjRZACX2YbzGleQAKS8Ty3ZHbwFuWfIVHUbUVG5kIWVDtZSjKQgM3XVCGkHbhdwxfL2tEqHJXaVOhi6Os5eJ8lYOi5JesudbHjmsOnIn5hQjOiT4UEcl07qh0XYNMomYfGp4+Wq7pjCHr5SDkXNoZpcpIsnw78zQs7SkZjkLuWjqpx3Doj6xV4n0QB/63qg+59Ak46xVkX1upcoqNBp9j5Xd9xyOX2paECUmdaCgHb6NrGXs5m58f83fwQJ+KXFgNfPoHz2Zd38gbviFo7gUrpLRWhU0t5a6TbBadcEhoyF61bQ7rIWL2K3Fqz3xodhGmQz2A6MDuNxp1GBdkdZDaD8VqjIIW1c41Np1Ns5CRXui0mlp7J4ETqI+vdhxNxq9Axm+KK88XF7RwYzID1nuWPrIwRv0rCLw5G5d/LkARJ/+V60Olx6wIHbKu7vU2/v2DVsGpvDLQYHJKNDbKYZZ7HqdQBQa933wgj/6xHZkzmZPtklhLzYP1D/sasUYVSBaeV+tv+wCfA5Md3Tiens7PJjIMsXoVhdPplENfHwdrZjjbIAeJuP47/t8F6eRy9uGmjUNaMLTTZ9cZavDIOybBFeQ6CubIE1uzCdAFdt0RLv43ynsNxj7HlCmlxqXiGSlSWPujkky33LtYn2h0t0g2qljODQzdoJL8fxieBNWFBJgCLpVfx+ZMHvn1fe7TjDkbv9ub+gc3bb9BKF1xjkDnizxTCvwNXh5kIsQ4U1qsWV5wb72Sr4+GkvJmMgHTYd/VuhLDrYsaDfqLaexi4cPwbfOa9/wvoA2xU sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Removes the given list of labels from the given workflows. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/seqera-api.info.mdx b/platform-api-docs/docs/seqera-api.info.mdx index 7cc1765df..6966c6501 100644 --- a/platform-api-docs/docs/seqera-api.info.mdx +++ b/platform-api-docs/docs/seqera-api.info.mdx @@ -16,7 +16,7 @@ import Export from "@theme/ApiExplorer/Export"; @@ -47,10 +47,10 @@ Seqera Platform services API label={"HTTP: Bearer Auth"} value={"BearerAuth"} > - - - - + + + +
@@ -91,4 +91,3 @@ Seqera Platform services API URL: [https://seqera.io](https://seqera.io) - \ No newline at end of file diff --git a/platform-api-docs/docs/sidebar.ts b/platform-api-docs/docs/sidebar.ts index a6e13a5a2..5950949ef 100644 --- a/platform-api-docs/docs/sidebar.ts +++ b/platform-api-docs/docs/sidebar.ts @@ -4,7 +4,7 @@ const sidebar: SidebarsConfig = { apisidebar: [ { type: "doc", - id: "docs/seqera-api", + id: "seqera-api", }, { type: "category", @@ -12,55 +12,55 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-actions", + id: "list-actions", label: "List actions", className: "api-method get", }, { type: "doc", - id: "docs/create-action", + id: "create-action", label: "Create action", className: "api-method post", }, { type: "doc", - id: "docs/list-action-types", + id: "list-action-types", label: "List action event types", className: "api-method get", }, { type: "doc", - id: "docs/validate-action-name", + id: "validate-action-name", label: "Validate action name", className: "api-method get", }, { type: "doc", - id: "docs/describe-action", + id: "describe-action", label: "Describe action", className: "api-method get", }, { type: "doc", - id: "docs/update-action", + id: "update-action", label: "Update action", className: "api-method put", }, { type: "doc", - id: "docs/delete-action", + id: "delete-action", label: "Delete action", className: "api-method delete", }, { type: "doc", - id: "docs/launch-action", + id: "launch-action", label: "Trigger Tower Launch action", className: "api-method post", }, { type: "doc", - id: "docs/pause-action", + id: "pause-action", label: "Pause or resume action", className: "api-method post", }, @@ -72,13 +72,13 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/create-avatar", + id: "create-avatar", label: "Create the avatar image", className: "api-method post", }, { type: "doc", - id: "docs/download-avatar", + id: "download-avatar", label: "Download the avatar image", className: "api-method get", }, @@ -90,43 +90,43 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-compute-envs", + id: "list-compute-envs", label: "List compute environments", className: "api-method get", }, { type: "doc", - id: "docs/create-compute-env", + id: "create-compute-env", label: "Create compute environment", className: "api-method post", }, { type: "doc", - id: "docs/validate-compute-env-name", + id: "validate-compute-env-name", label: "Validate compute environment name", className: "api-method get", }, { type: "doc", - id: "docs/describe-compute-env", + id: "describe-compute-env", label: "Describe compute environment", className: "api-method get", }, { type: "doc", - id: "docs/update-compute-env", + id: "update-compute-env", label: "Update compute environment", className: "api-method put", }, { type: "doc", - id: "docs/delete-compute-env", + id: "delete-compute-env", label: "Delete compute environment", className: "api-method delete", }, { type: "doc", - id: "docs/update-compute-env-primary", + id: "update-compute-env-primary", label: "Define primary compute environment", className: "api-method post", }, @@ -138,37 +138,37 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-credentials", + id: "list-credentials", label: "List credentials", className: "api-method get", }, { type: "doc", - id: "docs/create-credentials", + id: "create-credentials", label: "Create credentials", className: "api-method post", }, { type: "doc", - id: "docs/validate-credentials-name", + id: "validate-credentials-name", label: "Validate credential name", className: "api-method get", }, { type: "doc", - id: "docs/describe-credentials", + id: "describe-credentials", label: "Describe credentials", className: "api-method get", }, { type: "doc", - id: "docs/update-credentials", + id: "update-credentials", label: "Update credentials", className: "api-method put", }, { type: "doc", - id: "docs/delete-credentials", + id: "delete-credentials", label: "Delete credentials", className: "api-method delete", }, @@ -180,106 +180,106 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-data-links", + id: "list-data-links", label: "List data-links", className: "api-method get", }, { type: "doc", - id: "docs/create-custom-data-link", + id: "create-custom-data-link", label: "Create data-link", className: "api-method post", }, { type: "doc", - id: "docs/refresh-data-link-cache", + id: "refresh-data-link-cache", label: "Refresh data-link cache", className: "api-method get", }, { type: "doc", - id: "docs/describe-data-link", + id: "describe-data-link", label: "Describe data-link", className: "api-method get", }, { type: "doc", - id: "docs/update-custom-data-link", + id: "update-custom-data-link", label: "Update data-link", className: "api-method put", }, { type: "doc", - id: "docs/delete-custom-data-link", + id: "delete-custom-data-link", label: "Delete data-link", className: "api-method delete", }, { type: "doc", - id: "docs/explore-data-link", - label: "Explore data-link path", + id: "explore-data-link", + label: "Explore data-link", className: "api-method get", }, { type: "doc", - id: "docs/explore-data-link-tree", + id: "explore-data-link-tree", label: "Explore data-link tree", className: "api-method get", }, { type: "doc", - id: "docs/explore-data-link-1", + id: "explore-data-link-with-path", label: "Explore data-link path", className: "api-method get", }, { type: "doc", - id: "docs/delete-data-link-item", + id: "delete-data-link-item", label: "Delete data-link content", className: "api-method delete", }, { type: "doc", - id: "docs/download-data-link", - label: "Download data-link file at path", - className: "api-method get", - }, - { - type: "doc", - id: "docs/generate-download-url-data-link", + id: "generate-download-url-data-link", label: "Generate download URL", className: "api-method get", }, { type: "doc", - id: "docs/generate-download-script", + id: "generate-download-script", label: "Generate download script", className: "api-method get", }, { type: "doc", - id: "docs/generate-data-link-upload-url", - label: "Generate data-link file upload URL (to given path)", + id: "generate-data-link-upload-url", + label: "Generate data-link file upload URL", className: "api-method post", }, { type: "doc", - id: "docs/finish-data-link-upload", - label: "Finish data-link file upload to given path", + id: "finish-data-link-upload", + label: "Finish data-link file upload", className: "api-method post", }, { type: "doc", - id: "docs/finish-data-link-upload-1", + id: "finish-data-link-upload-with-path", label: "Finish data-link file upload to given path", className: "api-method post", }, { type: "doc", - id: "docs/generate-data-link-upload-url-1", + id: "generate-data-link-upload-url-with-path", label: "Generate data-link file upload URL (to given path)", className: "api-method post", }, + { + type: "doc", + id: "download-data-link", + label: "Download data-link file at path", + className: "api-method get", + }, ], }, { @@ -288,115 +288,115 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-datasets-v-2", + id: "list-datasets-v-2", label: "List datasets", className: "api-method get", }, { type: "doc", - id: "docs/create-dataset-v-2", + id: "create-dataset-v-2", label: "Create dataset", className: "api-method post", }, { type: "doc", - id: "docs/list-latest-dataset-versions-v-2", + id: "list-latest-dataset-versions-v-2", label: "List latest dataset versions", className: "api-method get", }, { type: "doc", - id: "docs/update-dataset-v-2", + id: "update-dataset-v-2", label: "Update dataset", className: "api-method put", }, { type: "doc", - id: "docs/delete-dataset-v-2", + id: "delete-dataset-v-2", label: "Delete dataset", className: "api-method delete", }, { type: "doc", - id: "docs/describe-dataset-v-2", + id: "describe-dataset-v-2", label: "Describe dataset", className: "api-method get", }, { type: "doc", - id: "docs/upload-dataset-v-2", + id: "upload-dataset-v-2", label: "Upload new dataset version", className: "api-method post", }, { type: "doc", - id: "docs/download-dataset-v-2", + id: "download-dataset-v-2", label: "Download dataset content", className: "api-method get", }, { type: "doc", - id: "docs/list-dataset-versions-v-2", + id: "list-dataset-versions-v-2", label: "List all dataset versions", className: "api-method get", }, { type: "doc", - id: "docs/list-launch-dataset-versions", + id: "list-launch-dataset-versions", label: "Describe launch datasets", className: "api-method get", }, { type: "doc", - id: "docs/list-datasets", + id: "list-datasets", label: "(Deprecated) List available datasets", className: "menu__list-item--deprecated api-method get", }, { type: "doc", - id: "docs/create-dataset", + id: "create-dataset", label: "(Deprecated) Create dataset", className: "menu__list-item--deprecated api-method post", }, { type: "doc", - id: "docs/list-workspace-dataset-versions", + id: "list-workspace-dataset-versions", label: "(Deprecated) List latest dataset versions", className: "menu__list-item--deprecated api-method get", }, { type: "doc", - id: "docs/update-dataset", + id: "update-dataset", label: "(Deprecated) Update dataset", className: "menu__list-item--deprecated api-method put", }, { type: "doc", - id: "docs/delete-dataset", + id: "delete-dataset", label: "(Deprecated) Delete dataset", className: "menu__list-item--deprecated api-method delete", }, { type: "doc", - id: "docs/describe-dataset", + id: "describe-dataset", label: "(Deprecated) Describe dataset", className: "menu__list-item--deprecated api-method get", }, { type: "doc", - id: "docs/upload-dataset", + id: "upload-dataset", label: "(Deprecated) Upload new dataset version", className: "menu__list-item--deprecated api-method post", }, { type: "doc", - id: "docs/download-dataset", + id: "download-dataset", label: "Download dataset content", className: "api-method get", }, { type: "doc", - id: "docs/list-dataset-versions", + id: "list-dataset-versions", label: "(Deprecated) List all dataset versions", className: "menu__list-item--deprecated api-method get", }, @@ -408,127 +408,187 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/ga-4-gh-run-list", + id: "ga-4-gh-run-list", label: "GA4GH: List runs", className: "api-method get", }, { type: "doc", - id: "docs/ga-4-gh-run-create", + id: "ga-4-gh-run-create", label: "GA4GH: Launch run", className: "api-method post", }, { type: "doc", - id: "docs/ga-4-gh-run-describe", + id: "ga-4-gh-run-describe", label: "GA4GH: Describe run", className: "api-method get", }, { type: "doc", - id: "docs/ga-4-gh-run-cancel", + id: "ga-4-gh-run-cancel", label: "GA4GH: Cancel run", className: "api-method post", }, { type: "doc", - id: "docs/ga-4-gh-run-status", + id: "ga-4-gh-run-status", label: "GA4GH: Retrieve run status", className: "api-method get", }, { type: "doc", - id: "docs/ga-4-gh-service-info", + id: "ga-4-gh-service-info", label: "GA4GH workflow execution service API info", className: "api-method get", }, ], }, + { + type: "category", + label: "identities", + items: [ + { + type: "doc", + id: "list-managed-identities", + label: "List managed identities", + className: "api-method get", + }, + { + type: "doc", + id: "create-managed-identity", + label: "Create managed identity", + className: "api-method post", + }, + { + type: "doc", + id: "describe-managed-identity", + label: "Describe managed identity", + className: "api-method get", + }, + { + type: "doc", + id: "update-managed-identity", + label: "Update managed identity", + className: "api-method put", + }, + { + type: "doc", + id: "delete-managed-identity", + label: "Delete managed identity", + className: "api-method delete", + }, + { + type: "doc", + id: "list-managed-credentials", + label: "List managed credentials", + className: "api-method get", + }, + { + type: "doc", + id: "create-managed-credentials", + label: "Create managed credentials", + className: "api-method post", + }, + { + type: "doc", + id: "update-managed-credentials", + label: "Update managed credentials", + className: "api-method put", + }, + { + type: "doc", + id: "delete-managed-credentials", + label: "Delete managed credentials", + className: "api-method delete", + }, + ], + }, { type: "category", label: "labels", items: [ { type: "doc", - id: "docs/add-labels-to-actions", + id: "add-labels-to-actions", label: "Add labels to actions", className: "api-method post", }, { type: "doc", - id: "docs/apply-labels-to-actions", + id: "apply-labels-to-actions", label: "Replace action labels", className: "api-method post", }, { type: "doc", - id: "docs/remove-labels-from-actions", + id: "remove-labels-from-actions", label: "Remove labels from actions", className: "api-method post", }, { type: "doc", - id: "docs/list-labels", + id: "list-labels", label: "List labels", className: "api-method get", }, { type: "doc", - id: "docs/create-label", + id: "create-label", label: "Create label", className: "api-method post", }, { type: "doc", - id: "docs/get-allowed-dynamic-labels", + id: "get-allowed-dynamic-labels", label: "GetAllowedDynamicLabels", className: "api-method get", }, { type: "doc", - id: "docs/update-label", + id: "update-label", label: "Update label", className: "api-method put", }, { type: "doc", - id: "docs/delete-label", + id: "delete-label", label: "Delete label", className: "api-method delete", }, { type: "doc", - id: "docs/add-labels-to-pipelines", + id: "add-labels-to-pipelines", label: "Add labels to pipelines", className: "api-method post", }, { type: "doc", - id: "docs/apply-labels-to-pipelines", + id: "apply-labels-to-pipelines", label: "Replace pipeline labels", className: "api-method post", }, { type: "doc", - id: "docs/remove-labels-from-pipelines", + id: "remove-labels-from-pipelines", label: "Remove labels from pipelines", className: "api-method post", }, { type: "doc", - id: "docs/add-labels-to-workflows", + id: "add-labels-to-workflows", label: "Add labels to workflows", className: "api-method post", }, { type: "doc", - id: "docs/apply-labels-to-workflows", + id: "apply-labels-to-workflows", label: "Replace workflow labels", className: "api-method post", }, { type: "doc", - id: "docs/remove-labels-from-workflows", + id: "remove-labels-from-workflows", label: "Remove labels from workflows", className: "api-method post", }, @@ -540,7 +600,7 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/describe-launch", + id: "describe-launch", label: "Describe Launch record", className: "api-method get", }, @@ -552,79 +612,79 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-organizations", + id: "list-organizations", label: "List organizations", className: "api-method get", }, { type: "doc", - id: "docs/create-organization", + id: "create-organization", label: "Create organization", className: "api-method post", }, { type: "doc", - id: "docs/validate-organization-name", + id: "validate-organization-name", label: "Validate organization name", className: "api-method get", }, { type: "doc", - id: "docs/describe-organization", + id: "describe-organization", label: "Describe organization", className: "api-method get", }, { type: "doc", - id: "docs/update-organization", + id: "update-organization", label: "Update organization", className: "api-method put", }, { type: "doc", - id: "docs/delete-organization", + id: "delete-organization", label: "Delete organization", className: "api-method delete", }, { type: "doc", - id: "docs/list-organization-collaborators", + id: "list-organization-collaborators", label: "List organization collaborators", className: "api-method get", }, { type: "doc", - id: "docs/list-organization-members", + id: "list-organization-members", label: "List organization members", className: "api-method get", }, { type: "doc", - id: "docs/create-organization-member", + id: "create-organization-member", label: "Create organization member", className: "api-method put", }, { type: "doc", - id: "docs/leave-organization", + id: "leave-organization", label: "Leave organization", className: "api-method delete", }, { type: "doc", - id: "docs/delete-organization-member", + id: "delete-organization-member", label: "Delete organization member", className: "api-method delete", }, { type: "doc", - id: "docs/update-organization-member-role", + id: "update-organization-member-role", label: "Update organization member role", className: "api-method put", }, { type: "doc", - id: "docs/describe-organization-quotas", + id: "describe-organization-quotas", label: "Describe organization quotas", className: "api-method get", }, @@ -636,61 +696,61 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-pipelines", + id: "list-pipelines", label: "List pipelines", className: "api-method get", }, { type: "doc", - id: "docs/create-pipeline", + id: "create-pipeline", label: "Create pipeline", className: "api-method post", }, { type: "doc", - id: "docs/describe-pipeline-repository", + id: "describe-pipeline-repository", label: "Describe remote pipeline repository", className: "api-method get", }, { type: "doc", - id: "docs/list-pipeline-repositories", + id: "list-pipeline-repositories", label: "List user pipeline repositories", className: "api-method get", }, { type: "doc", - id: "docs/validate-pipeline-name", + id: "validate-pipeline-name", label: "Validate pipeline name", className: "api-method get", }, { type: "doc", - id: "docs/describe-pipeline", + id: "describe-pipeline", label: "Describe pipeline", className: "api-method get", }, { type: "doc", - id: "docs/update-pipeline", + id: "update-pipeline", label: "Update pipeline", className: "api-method put", }, { type: "doc", - id: "docs/delete-pipeline", + id: "delete-pipeline", label: "Delete pipeline", className: "api-method delete", }, { type: "doc", - id: "docs/describe-pipeline-launch", + id: "describe-pipeline-launch", label: "Describe pipeline launch", className: "api-method get", }, { type: "doc", - id: "docs/describe-pipeline-schema", + id: "describe-pipeline-schema", label: "Describe pipeline schema", className: "api-method get", }, @@ -702,37 +762,37 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-pipeline-secrets", + id: "list-pipeline-secrets", label: "List pipeline secrets", className: "api-method get", }, { type: "doc", - id: "docs/create-pipeline-secret", + id: "create-pipeline-secret", label: "Create pipeline secret", className: "api-method post", }, { type: "doc", - id: "docs/validate-pipeline-secret-name", + id: "validate-pipeline-secret-name", label: "Validate secret name", className: "api-method get", }, { type: "doc", - id: "docs/describe-pipeline-secret", + id: "describe-pipeline-secret", label: "Describe pipeline secret", className: "api-method get", }, { type: "doc", - id: "docs/update-pipeline-secret", + id: "update-pipeline-secret", label: "Update secret", className: "api-method put", }, { type: "doc", - id: "docs/delete-pipeline-secret", + id: "delete-pipeline-secret", label: "Delete secret", className: "api-method delete", }, @@ -744,19 +804,19 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-platforms", + id: "list-platforms", label: "List platforms", className: "api-method get", }, { type: "doc", - id: "docs/describe-platform", + id: "describe-platform", label: "Describe platform", className: "api-method get", }, { type: "doc", - id: "docs/list-platform-regions", + id: "list-platform-regions", label: "List platform regions", className: "api-method get", }, @@ -768,7 +828,7 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/info", + id: "info", label: "Get API version and features", className: "api-method get", }, @@ -780,79 +840,79 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-data-studios", + id: "list-data-studios", label: "List Studios", className: "api-method get", }, { type: "doc", - id: "docs/create-data-studio", + id: "create-data-studio", label: "Create Studio", className: "api-method post", }, { type: "doc", - id: "docs/list-mounted-data-link-ids", + id: "list-mounted-data-link-ids", label: "List mounted data-links", className: "api-method get", }, { type: "doc", - id: "docs/list-data-studio-templates", + id: "list-data-studio-templates", label: "List Studio container templates", className: "api-method get", }, { type: "doc", - id: "docs/validate-data-studio-name", + id: "validate-data-studio-name", label: "Validate Studio name", className: "api-method get", }, { type: "doc", - id: "docs/describe-data-studio", + id: "describe-data-studio", label: "Describe Studio", className: "api-method get", }, { type: "doc", - id: "docs/delete-data-studio", + id: "delete-data-studio", label: "Delete Studio", className: "api-method delete", }, { type: "doc", - id: "docs/list-data-studio-checkpoints", + id: "list-data-studio-checkpoints", label: "List Studio checkpoints", className: "api-method get", }, { type: "doc", - id: "docs/get-data-studio-checkpoint", + id: "get-data-studio-checkpoint", label: "Get Studio checkpoint", className: "api-method get", }, { type: "doc", - id: "docs/update-data-studio-checkpoint", + id: "update-data-studio-checkpoint", label: "Update Studio checkpoint name", className: "api-method put", }, { type: "doc", - id: "docs/extend-data-studio-lifespan", + id: "extend-data-studio-lifespan", label: "ExtendDataStudioLifespan", className: "api-method post", }, { type: "doc", - id: "docs/start-data-studio", + id: "start-data-studio", label: "Start Studio", className: "api-method put", }, { type: "doc", - id: "docs/stop-data-studio", + id: "stop-data-studio", label: "Stop Studio", className: "api-method put", }, @@ -864,61 +924,61 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-organization-teams", + id: "list-organization-teams", label: "List organization teams", className: "api-method get", }, { type: "doc", - id: "docs/create-organization-team", + id: "create-organization-team", label: "Create organization team", className: "api-method post", }, { type: "doc", - id: "docs/validate-team-name", + id: "validate-team-name", label: "Validate organization team name", className: "api-method get", }, { type: "doc", - id: "docs/describe-organization-team", + id: "describe-organization-team", label: "Describe organization team", className: "api-method get", }, { type: "doc", - id: "docs/update-organization-team", + id: "update-organization-team", label: "Update organization team", className: "api-method put", }, { type: "doc", - id: "docs/delete-organization-team", + id: "delete-organization-team", label: "Delete organization team", className: "api-method delete", }, { type: "doc", - id: "docs/list-organization-team-members", + id: "list-organization-team-members", label: "List organization team members", className: "api-method get", }, { type: "doc", - id: "docs/create-organization-team-member", + id: "create-organization-team-member", label: "Create team member", className: "api-method post", }, { type: "doc", - id: "docs/delete-organization-team-member", + id: "delete-organization-team-member", label: "Delete organization team member", className: "api-method delete", }, { type: "doc", - id: "docs/list-workspaces-by-team", + id: "list-workspaces-by-team", label: "List workspaces by team", className: "api-method get", }, @@ -930,25 +990,25 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/token-list", + id: "token-list", label: "List tokens", className: "api-method get", }, { type: "doc", - id: "docs/create-token", + id: "create-token", label: "Create token", className: "api-method post", }, { type: "doc", - id: "docs/delete-all-tokens", + id: "delete-all-tokens", label: "Delete all user tokens", className: "api-method delete", }, { type: "doc", - id: "docs/delete-token", + id: "delete-token", label: "Delete token", className: "api-method delete", }, @@ -960,31 +1020,31 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/create-trace", + id: "create-trace", label: "Create workflow execution trace", className: "api-method post", }, { type: "doc", - id: "docs/update-trace-begin", + id: "update-trace-begin", label: "Signal workflow execution start", className: "api-method put", }, { type: "doc", - id: "docs/update-trace-complete", + id: "update-trace-complete", label: "Signal workflow execution completion", className: "api-method put", }, { type: "doc", - id: "docs/update-trace-heartbeat", + id: "update-trace-heartbeat", label: "Signal workflow execution heartbeat", className: "api-method put", }, { type: "doc", - id: "docs/update-trace-progress", + id: "update-trace-progress", label: "Store workflow task execution metadata", className: "api-method put", }, @@ -996,31 +1056,31 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/user-info", + id: "user-info", label: "Describe current user", className: "api-method get", }, { type: "doc", - id: "docs/validate-user-name", + id: "validate-user-name", label: "Check that the user name is valid", className: "api-method get", }, { type: "doc", - id: "docs/describe-user", + id: "describe-user", label: "Describe a user entity", className: "menu__list-item--deprecated api-method get", }, { type: "doc", - id: "docs/update-user", + id: "update-user", label: "Update an user entity", className: "api-method post", }, { type: "doc", - id: "docs/delete-user", + id: "delete-user", label: "Delete a user entity", className: "api-method delete", }, @@ -1032,121 +1092,121 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-workflows", + id: "list-workflows", label: "List workflows", className: "api-method get", }, { type: "doc", - id: "docs/delete-workflow-many", + id: "delete-workflow-many", label: "Delete workflows", className: "api-method post", }, { type: "doc", - id: "docs/create-workflow-launch", + id: "create-workflow-launch", label: "Launch workflow", className: "api-method post", }, { type: "doc", - id: "docs/generate-random-workflow-name", + id: "generate-random-workflow-name", label: "Generates a random name", className: "api-method get", }, { type: "doc", - id: "docs/validate-workflow-constraints", + id: "validate-workflow-constraints", label: "Validate run name", className: "api-method get", }, { type: "doc", - id: "docs/describe-workflow", + id: "describe-workflow", label: "Describe workflow", className: "api-method get", }, { type: "doc", - id: "docs/delete-workflow", + id: "delete-workflow", label: "Delete the Workflow entity with the given ID", className: "api-method delete", }, { type: "doc", - id: "docs/cancel-workflow", + id: "cancel-workflow", label: "Cancel workflow", className: "api-method post", }, { type: "doc", - id: "docs/download-workflow-log", + id: "download-workflow-log", label: "Download workflow files", className: "api-method get", }, { type: "doc", - id: "docs/download-workflow-task-log", + id: "download-workflow-task-log", label: "Download workflow task files", className: "api-method get", }, { type: "doc", - id: "docs/describe-workflow-launch", + id: "describe-workflow-launch", label: "Describe workflow launch", className: "api-method get", }, { type: "doc", - id: "docs/get-workflow-log", + id: "get-workflow-log", label: "Get workflow log", className: "api-method get", }, { type: "doc", - id: "docs/get-workflow-task-log", + id: "get-workflow-task-log", label: "Get workflow task logs", className: "api-method get", }, { type: "doc", - id: "docs/describe-workflow-metrics", + id: "describe-workflow-metrics", label: "Get the execution metrics for the given Workflow ID", className: "api-method get", }, { type: "doc", - id: "docs/describe-workflow-progress", + id: "describe-workflow-progress", label: "Retrieve the execution progress for the given Workflow ID", className: "api-method get", }, { type: "doc", - id: "docs/describe-workflow-star", + id: "describe-workflow-star", label: "Check workflow star status", className: "api-method get", }, { type: "doc", - id: "docs/create-workflow-star", + id: "create-workflow-star", label: "Star workflow", className: "api-method post", }, { type: "doc", - id: "docs/delete-workflow-star", + id: "delete-workflow-star", label: "Unstar workflow", className: "api-method delete", }, { type: "doc", - id: "docs/describe-workflow-task", + id: "describe-workflow-task", label: "Describe a task entity with the given ID", className: "api-method get", }, { type: "doc", - id: "docs/list-workflow-tasks", + id: "list-workflow-tasks", label: "List the tasks for the given Workflow ID and filter parameters", className: "api-method get", }, @@ -1158,150 +1218,90 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "docs/list-workspaces", + id: "list-workspaces", label: "List workspaces", className: "api-method get", }, { type: "doc", - id: "docs/create-workspace", + id: "create-workspace", label: "Create workspace", className: "api-method post", }, { type: "doc", - id: "docs/validate-workspace-name", + id: "validate-workspace-name", label: "Validate workspace name", className: "api-method get", }, { type: "doc", - id: "docs/describe-workspace", + id: "describe-workspace", label: "Describe workspace", className: "api-method get", }, { type: "doc", - id: "docs/update-workspace", + id: "update-workspace", label: "Update workspace", className: "api-method put", }, { type: "doc", - id: "docs/delete-workspace", + id: "delete-workspace", label: "Delete workspace", className: "api-method delete", }, { type: "doc", - id: "docs/list-workspace-participants", + id: "list-workspace-participants", label: "List workspace participants", className: "api-method get", }, { type: "doc", - id: "docs/leave-workspace-participant", + id: "leave-workspace-participant", label: "Leave workspace", className: "api-method delete", }, { type: "doc", - id: "docs/create-workspace-participant", + id: "create-workspace-participant", label: "Create workspace participant", className: "api-method put", }, { type: "doc", - id: "docs/delete-workspace-participant", + id: "delete-workspace-participant", label: "Delete workspace participant", className: "api-method delete", }, { type: "doc", - id: "docs/update-workspace-participant-role", + id: "update-workspace-participant-role", label: "Update workspace participant role", className: "api-method put", }, { type: "doc", - id: "docs/find-data-studios-workspace-settings", + id: "find-data-studios-workspace-settings", label: "Describe workspace Studios settings", className: "api-method get", }, { type: "doc", - id: "docs/update-data-studios-workspace-settings", + id: "update-data-studios-workspace-settings", label: "Update workspace Studios settings", className: "api-method put", }, { type: "doc", - id: "docs/list-workspaces-user", + id: "list-workspaces-user", label: "List user workspaces", className: "api-method get", }, ], }, - { - type: "category", - label: "identities", - items: [ - { - type: "doc", - id: "docs/list-managed-identities", - label: "List managed identities", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-managed-identity", - label: "Create managed identity", - className: "api-method post", - }, - { - type: "doc", - id: "docs/describe-managed-identity", - label: "Describe managed identity", - className: "api-method get", - }, - { - type: "doc", - id: "docs/update-managed-identity", - label: "Update managed identity", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-managed-identity", - label: "Delete managed identity", - className: "api-method delete", - }, - { - type: "doc", - id: "docs/list-managed-credentials", - label: "List managed credentials", - className: "api-method get", - }, - { - type: "doc", - id: "docs/create-managed-credentials", - label: "Create managed credentials", - className: "api-method post", - }, - { - type: "doc", - id: "docs/update-managed-credentials", - label: "Update managed credentials", - className: "api-method put", - }, - { - type: "doc", - id: "docs/delete-managed-credentials", - label: "Delete managed credentials", - className: "api-method delete", - }, - ], - }, ], }; diff --git a/platform-api-docs/docs/sidebar/sidebar.js b/platform-api-docs/docs/sidebar/sidebar.js index b2dfbda10..9ac1d0b97 100644 --- a/platform-api-docs/docs/sidebar/sidebar.js +++ b/platform-api-docs/docs/sidebar/sidebar.js @@ -12,7 +12,7 @@ module.exports = { { type: "category", label: "Credentials", - link: {type: 'doc', id: 'info/credentials-info'}, + link: {type: 'doc', id: 'info/credentials-info'}, items: [ { type: "doc", id: "list-credentials", label: "List credentials", className: "api-method get" }, { type: "doc", id: "create-credentials", label: "Create credentials", className: "api-method post" }, @@ -22,8 +22,8 @@ module.exports = { { type: "doc", id: "delete-credentials", label: "Delete credentials", className: "api-method delete" }, { type: "category", - label: "Managed identities", - link: {type: 'doc', id: 'info/identities-info'}, + label: "Managed identities", + link: {type: 'doc', id: 'info/identities-info'}, items: [ { type: "doc", id: "list-managed-identities", label: "List managed identities", className: "api-method get" }, { type: "doc", id: "list-managed-credentials", label: "List managed credentials", className: "api-method get" }, @@ -35,11 +35,11 @@ module.exports = { ], }, ], - }, + }, { type: "category", label: "Compute", - link: {type: 'doc', id: 'info/compute-envs-info'}, + link: {type: 'doc', id: 'info/compute-envs-info'}, items: [ { type: "doc", id: "list-compute-envs", label: "List compute environments", className: "api-method get" }, { type: "doc", id: "create-compute-env", label: "Create compute environment", className: "api-method post" }, @@ -59,11 +59,11 @@ module.exports = { ], }, ], - }, + }, { type: "category", label: "Data Explorer", - link: {type: 'doc', id: 'info/data-links-info'}, + link: {type: 'doc', id: 'info/data-links-info'}, items: [ { type: "doc", id: "list-data-links", label: "List data links in a user or workspace context", className: "api-method get" }, { type: "doc", id: "create-custom-data-link", label: "Create data link in a user or workspace context", className: "api-method post" }, @@ -72,22 +72,22 @@ module.exports = { { type: "doc", id: "update-custom-data-link", label: "Update data link in a user or workspace context", className: "api-method put" }, { type: "doc", id: "delete-custom-data-link", label: "Delete data link in a user or workspace context", className: "api-method delete" }, { type: "doc", id: "explore-data-link", label: "Explore data-link content", className: "api-method get" }, - { type: "doc", id: "explore-data-link-1", label: "Explore data-link content at path", className: "api-method get" }, + { type: "doc", id: "explore-data-link-with-path", label: "Explore data-link content at path", className: "api-method get" }, { type: "doc", id: "explore-data-link-tree", label: "Explore data-link tree", className: "api-method get" }, { type: "doc", id: "delete-data-link-item", label: "Delete data-link content", className: "api-method delete" }, { type: "doc", id: "download-data-link", label: "Download data-link file at path", className: "api-method get" }, { type: "doc", id: "generate-data-link-upload-url", label: "Generate file upload URL", className: "api-method get" }, - { type: "doc", id: "generate-data-link-upload-url-1", label: "Generate file upload URL to given path", className: "api-method get" }, + { type: "doc", id: "generate-data-link-upload-url-with-path", label: "Generate file upload URL to given path", className: "api-method get" }, { type: "doc", id: "generate-download-url-data-link", label: "Generate data-link file download URL", className: "api-method get" }, { type: "doc", id: "generate-download-script", label: "Generate download script", className: "api-method get" }, { type: "doc", id: "finish-data-link-upload", label: "Finish data-link file upload", className: "api-method post" }, - { type: "doc", id: "finish-data-link-upload-1", label: "Finish data-link file upload to given path", className: "api-method post" }, + { type: "doc", id: "finish-data-link-upload-with-path", label: "Finish data-link file upload to given path", className: "api-method post" }, ], }, { type: "category", label: "Datasets", - link: {type: 'doc', id: 'info/datasets-info'}, + link: {type: 'doc', id: 'info/datasets-info'}, items: [ { type: "doc", id: "list-datasets-v-2", label: "List available datasets", className: "api-method get" }, { type: "doc", id: "create-dataset-v-2", label: "Create dataset", className: "api-method post" }, @@ -109,7 +109,7 @@ module.exports = { { type: "doc", id: "download-dataset", label: "Download dataset content", className: "api-method get" }, { type: "doc", id: "list-dataset-versions", label: "(Deprecated) List all dataset versions", className: "menu__list-item--deprecated api-method get" }, ], - }, + }, { type: "category", label: "Pipelines", @@ -126,7 +126,7 @@ module.exports = { { type: "doc", id: "describe-pipeline-launch", label: "Describe pipeline launch", className: "api-method get" }, { type: "doc", id: "describe-pipeline-schema", label: "Describe pipeline schema", className: "api-method get" }, ], - }, + }, { type: "category", label: "Actions", @@ -146,7 +146,7 @@ module.exports = { { type: "category", label: "Labels", - link: {type: 'doc', id: 'info/labels-info'}, + link: {type: 'doc', id: 'info/labels-info'}, items: [ { type: "doc", id: "add-labels-to-actions", label: "Add labels to actions", className: "api-method post" }, { type: "doc", id: "apply-labels-to-actions", label: "Replace action labels", className: "api-method post" }, @@ -162,7 +162,7 @@ module.exports = { { type: "doc", id: "apply-labels-to-workflows", label: "Replace workflow labels", className: "api-method post" }, { type: "doc", id: "remove-labels-from-workflows", label: "Remove labels from workflows", className: "api-method post" }, ], - }, + }, { type: "category", label: "Secrets", @@ -175,7 +175,7 @@ module.exports = { { type: "doc", id: "update-pipeline-secret", label: "Update secret", className: "api-method put" }, { type: "doc", id: "delete-pipeline-secret", label: "Delete secret", className: "api-method delete" }, ], - }, + }, { type: "category", label: "Pipeline runs (workflows)", @@ -202,11 +202,11 @@ module.exports = { { type: "doc", id: "describe-workflow-task", label: "Describe a task entity with the given ID", className: "api-method get" }, { type: "doc", id: "list-workflow-tasks", label: "List the tasks for the given Workflow ID and filter parameters", className: "api-method get" }, ], - }, + }, { type: "category", label: "GA4GH-WES", - link: {type: 'doc', id: 'info/ga4gh-info'}, + link: {type: 'doc', id: 'info/ga4gh-info'}, items: [ { type: "doc", id: "ga-4-gh-run-list", label: "GA4GH: List runs", className: "api-method get" }, { type: "doc", id: "ga-4-gh-run-create", label: "GA4GH: Launch run", className: "api-method post" }, @@ -215,7 +215,7 @@ module.exports = { { type: "doc", id: "ga-4-gh-run-status", label: "GA4GH: Retrieve run status", className: "api-method get" }, { type: "doc", id: "ga-4-gh-service-info", label: "GA4GH workflow execution service API info", className: "api-method get" }, ], - }, + }, { type: "category", label: "Workflow trace", @@ -227,7 +227,7 @@ module.exports = { { type: "doc", id: "update-trace-heartbeat", label: "Signal workflow execution heartbeat", className: "api-method put" }, { type: "doc", id: "update-trace-progress", label: "Store workflow task execution metadata", className: "api-method put" }, ], - }, + }, { type: "doc", id: "describe-launch", label: "Launch records", className: "api-method get" }, { type: "category", @@ -338,6 +338,6 @@ module.exports = { { type: "doc", id: "create-avatar", label: "Create the avatar image", className: "api-method post" }, { type: "doc", id: "download-avatar", label: "Download the avatar image", className: "api-method get" }, ], - }, + }, ], -}; \ No newline at end of file +}; diff --git a/platform-api-docs/docs/start-data-studio.ParamsDetails.json b/platform-api-docs/docs/start-data-studio.ParamsDetails.json new file mode 100644 index 000000000..c1842f428 --- /dev/null +++ b/platform-api-docs/docs/start-data-studio.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the Studio is started in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/start-data-studio.RequestSchema.json b/platform-api-docs/docs/start-data-studio.RequestSchema.json new file mode 100644 index 000000000..54686e924 --- /dev/null +++ b/platform-api-docs/docs/start-data-studio.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Studio start request containing optional configuration overrides for resource allocations and labels when starting the session.","content":{"application/json":{"schema":{"type":"object","properties":{"configuration":{"nullable":true,"allOf":[{"type":"object","properties":{"gpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of GPUs allocated to the Studio session."},"cpu":{"minimum":0,"type":"integer","format":"int32","description":"Number of CPUs allocated to the Studio session."},"memory":{"minimum":0,"type":"integer","format":"int32","description":"Amount of memory in MiB allocated to the Studio session."},"mountData":{"type":"array","items":{"type":"string"},"description":"Array of data-link IDs mounted in the Studio session."},"environment":{"type":"object","additionalProperties":{"type":"string"},"nullable":true,"description":"Array of environment variable key-value pairs set in the Studio session."},"condaEnvironment":{"maxLength":2048,"type":"string","description":"Conda package specification for custom packages installed in the Studio environment."},"lifespanHours":{"minimum":0,"type":"integer","format":"int32","description":"Number of hours the Studio session will run before automatically stopping. A value of `0` indicates unlimited lifespan."}},"title":"DataStudioConfiguration"}]},"description":{"type":"string","nullable":true},"labelIds":{"type":"array","nullable":true,"items":{"type":"integer","format":"int64"}},"spot":{"type":"boolean","nullable":true}},"title":"DataStudioStartRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/start-data-studio.StatusCodes.json b/platform-api-docs/docs/start-data-studio.StatusCodes.json new file mode 100644 index 000000000..2f98d9939 --- /dev/null +++ b/platform-api-docs/docs/start-data-studio.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["jobSubmitted","sessionId","statusInfo"],"type":"object","properties":{"jobSubmitted":{"type":"boolean"},"sessionId":{"type":"string","description":"Studio session string identifier."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"}},"title":"DataStudioStartResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the Studio is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/start-data-studio.api.mdx b/platform-api-docs/docs/start-data-studio.api.mdx index 8ceced817..795eaec1c 100644 --- a/platform-api-docs/docs/start-data-studio.api.mdx +++ b/platform-api-docs/docs/start-data-studio.api.mdx @@ -5,9 +5,9 @@ description: "Starts the given Studio session ID. Append `?workspaceId=` to star sidebar_label: "Start Studio" hide_title: true hide_table_of_contents: true -api: eJy9WG1v2zYQ/iuEPm2A43htNmwGhs11nc1Ymxhxgg4IgoSWaJsJRap8SWIY/u+7I0VblhS3wbp9SWjyeO/33FHrxNKFSfrXibEu48okN50kYybVvLBcyaSfTC3V1hC7ZGTBH5kkU09JDDMGKMj4fZcMioLJjNz99qT0gyloysbZr3fEAhXeJjRe4hLWWyKSKmnZs+0mnUQVTFMUOc6i0PfU0nAPzguqac4s06jtOpHwA+hKJeBOJ+GobUHtMmmasKexsZrLBeEZk5bPOdMoX7PPjmsGwq12rJOYdMlymvTXiV0VXpS/lWw2na30irVR/mfH9KqhwKetxdLlTPO0Kpx8WoJXVc6tZVnHOzp6ywT/sQwdhwfOMF31WkNLDkcLpuFornRObdj66QT0vglGMmPfqWyFd9q95CNWUnpZlEv0l/KEVODenC9cCBdRj0xrMMcQkAj3jHIaDKVCqNRTGEIhNwSdMWHIE9rqRSBLNKmMClrjDZMWVaNFIXi4f3xvUL9101g1u2epxeTQmD6WM4One/rhhnQCxAsWYwu6nc99Gh1mtCgc/svB/tzlSb/XOezmt28akT9z+QxCpubkj8mViV6BgEJtVCK9dcIGvPAtpQ6/VmrOcqVX/1bwIFdOWhQc+GHefuTvvk4DvIo1X4kw1ZpiOXHLctNSjA35SI/iM+BzJLh8AHwyxLPeVVGLcCYfuVYyL9Ovnhc0y3jI/slehjTUqafaC+pVxJFHqjleIQ9sdfRIhWOkoFxD7TN7QGPI8oyO9tXO6fMHJhcAgf03vZOfOzX96uoMkQUISx/oAgqxYCkgUig6X8ypM1blkcCAMlC5QjQcWbHGqyb4nAHcyT8BCsy3y+UlsmtxB3niQhDtJJkxYAbY40BtMCMFZVeANqoowHxoUyS4F3jd9e7AiAytBcOcFBzwFwyLqncR6BPLLYYy2XWi4R62bG7qGVhPiXpGoHcQCceZaUnzevbU0/4AukMvKFQ1d2dKCUZlU4NWu3zDvQigD9w29YboN0CCNCHx3/R6zQ5y/tdrQHwn4Dq5V7Opm4UWiG2t0tYh5awzYzlXOJscBuw9Nk1XbKqcW0L12qlhs6fdF/tSoG26bei0RiBoCETyLpko+I344JPX9Mmdz2iW3XVwGVoprqECZLmMOY/rOeUiEM8cF1m569en4Qh7b90XTGK94lwYBOCIFPj7mAT2cemDBmOA0n4V5cRlEIPhez5CvoByGkco8+0FtGY2et23OGMAx1pxW1BjrwroGi3HlWpDgiPLYfrbBM0uGDXtdR8dOLwYvR9fTm8vrs5uz68u4eTD+HQ0nQzObkd/T8ZwClvTyfnl7cVo+GHwcXA5Pj97yZStwBerOGbjwTIPhYx1DlQnvbctpRzHcSKV9e37iWU+4096J03yM2VPocfC+OoHvP0ZFjnM8ZRAT9meDyZjPMy4QWzKfMPB/e1Q/aqJsAomMc5fhIuXE6LivBFm3Z7LPIykTnO78kPkO0Y10wOHbff6BudseKgsFb5jCuel4qOknxyXb6zj9RaFNsc+/T3k6cf4uHFaAPnS2sL0j49pwbupUC7rGvYZotL176EaVvkTMhHUYq6SIdKjixNUJ2o7RXcF06s6b61HifFR4XHTE2GR+cVprIL7J+tdhGG42D0pRs80LwRrHcH9KN0rh9vebtzs7c191zEAN/WJrHXg2RVbbeLoNQbDHeW2+173bmLTLDscjzBehr70KrrxSw7H8PEURolA7J9Nqc/b/WBWQwipy4Vv4XP1++4AFMFMCHJ+6P7yY7eHe4UyNqfhPROen76YyfaFXJtDtqXzf73gyyTCn8eFgEcjau2tX5cVsPvK0En6tR4PRQDhWIKRSLdez6hhV1psNrgdXtVYGhEukv6cClMfsKtW/2dv7lY7YXZvfBDw/Rp2fQ3GKf+VVnx3UQLb983xoOUrRqtucciUq6pSUeddHPw0u2Q0g5pHLcP5MOhydIlcdvcbcIzfRcKNQZqywh6krWLkxDfFWflNIlcZXtH0CQcC+OtVDd8ePHL5vTXUsVw4D95JYImARPfxrIZf1Rf/vjMg3TzFpXpgElIu+sbib/TLZvMPq6KyQA== +api: eJy9WG1v2zYQ/isEP22A4rhpMAwGis11nM1YmxhOgg4IguQsnW0mFKmSVBLD0H8fjpRsWVLSBuv2yTR55L0996YNd7C0fHDNrcsToS2/iXiCNjYic0IrPuAXDoyzzK2QLcUjKnbhKZlFa4VWbHLSY8MsQ5Wwu9+etHmwGcQ4ST7cMaeZpdsMqktCMWBbIhZr5fDZ9XjEdYYGiOUkqZiegINwj0c8AwMpOjQk7YYrSJEPeCnEJOERFyRtBm7F2yrsSWydEWrJRILKiYVAQ/wNfs2FwYQPnMkx4jZeYQp8sOFunXlW/hYvimjLvaZtxf9rjmbdEuDLVmOVp2hEXGfOvqxQMZ0K5zCJvKEra9lgP0zIcHSQWzR1q7WkFMrhEg2P+EKbFFzY+uWYF8VNUBKt+6iTNd3ptpL3WEnpeYFQZC/tCUHS3kIs8+Auph/RGJGgZQttmEGrcxMjAyl17CksA5UwCXOUlj2Rrp4FPUkqlV4hbbxiypFokGVShPuH95bk27SV1fN7jB2BwxB8nEBLp3vy0YbKpYS5xMq3IOX5wsPo9YeWWU4/qVAizVM+6Eevm/n9UcvzZ3k6R8P0gv0xvbKVVTCh2Kh5emuEIuLxj+Q6+l6uKabarP8t42Gqc+WIcXiPcPtZfPw+CegqxXzNw2AMUDgJh6ntCMYWf6In9gk4OJBCPbDJiWX+6V0UdTBH9SiMVmkJvyYuIElEQP90DyEtcZpQe0G8Gjv2CEbQFfaA64NHkDmyDISxzKJ7ReJYqwTG+2Kn8PwJ1dKt+OCof/xr1JCvKc6InmAZxA+wRGYzjMWiDDofzHFunU4rAsuEsg6kbBmypo0XTYoF2gzUnzo39sdheUXPdZiDPQkpmckVm+NCG2SQO52CEzFIuWbW6SwTatljQxbMqxfsrn/HhEpIW7QsV1KkghBSid6jRM+dcORKvqtEo73cUtw0EdiERBMRZB3KhJPEdsC8iZ4m7F/J7hG3ma5jd661RFBtCTr18gV3FpI+L4hmvyD6DZtpZQPwj/r9dgU5/+stSXzH4Jrf6/lFPg8lkMparaxbBy63E7XQ1Ju8nrD3nmmboqi/3OGqt3YNxZ5036xLgbZttlFuDCWCFkMi77GptlZQfvDgtQN25xGNyV1Ey1BKaW1ypcplhXlaL0DIQDzPhUzKXb8+DUdUe5u2QEXxSn1hYEAtUnjf+yQ8Xy2909AYbfyq4lMtAxty3/MBvXvwCIZaKPvjGXQim6zuS5y1sMTOvC3BuqssAddxXIs2IjhwIsXge53NEGx33FcGHM3GJ5PLi9vZ1dnt+dUlj/inyen4Yjo8ux3/PZ3Mxic84hfT88vb2Xj0afh5eDk5P3tJlS3DF6O4QuOrYR4CmeK8iPhx/31HKFftOFPa+fL9hIlH/HH/uE1+pt2pzlUShQZvv4elFxZ0yrTZnQ+nEzpMhKXclPiCQ/vbpvpNHWE9mVR+/ma6eBkQNeONCXV7JvNpJM6NcGvfRH5EMGiGOZXd6xvqs1N0K01zTJZ7rjSUDPhhOWMdbrZZqDj08PcpzzxWw01uJB/wlXOZHRweQiZ6sdR50rP4FQ30/DzUyFX+hE0lOMIqGxE9mZiTOJW0F2SuoHpd5q32xLEaKnze9EQUZH5xWkXB/ZPzJiI3zHYjxfgZ0kxiZwvuW+l+2dz2d+1mf6/vu64ccNPsyDobnl2wNTqOfqsx3FFuq+91/6YqmmWFE1UaL11fWpXM+C2Dk/tEjLYk9mNT7HG778y6CzEFIX0JX+jfdwdFxAkJgc+73rv+Ua9Pm5m2LoUw0IT500cz247IjUZkGzv/1whfooj+HmYShC+4Xv1NGQK7zwwRHzSKvHHk9ZW2jug2mzlYvDKyKGg7jNUUG1W+4IMFSNvssOta/2dDd6eeD7hufRHwBZsPuA/Cqs1/oxY/zcrM9nO7P+j4jNEpW9VlqnVdqErmnR98O7tCSNB4KcP5KMhycEmv7O638jF9GAk3hnGMmXuVtp4kp74qzsuPEqlO6IqBJ+oI4CmIGj4++NTl9zZcglrmPnvz8CRlJNhPaI0EVh/5942x2QSKS/2Aqii2tnH0n+xSFP8AqmKyZQ== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Starts the given Studio session ID. Append `?workspaceId=` to start a Studio in id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/stop-data-studio.ParamsDetails.json b/platform-api-docs/docs/stop-data-studio.ParamsDetails.json new file mode 100644 index 000000000..74a35c0a4 --- /dev/null +++ b/platform-api-docs/docs/stop-data-studio.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the Studio is stopped in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/stop-data-studio.RequestSchema.json b/platform-api-docs/docs/stop-data-studio.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/stop-data-studio.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/stop-data-studio.StatusCodes.json b/platform-api-docs/docs/stop-data-studio.StatusCodes.json new file mode 100644 index 000000000..4a08ec3f8 --- /dev/null +++ b/platform-api-docs/docs/stop-data-studio.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["jobSubmitted","sessionId","statusInfo"],"type":"object","properties":{"jobSubmitted":{"type":"boolean"},"sessionId":{"type":"string","description":"Studio session string identifier."},"statusInfo":{"type":"object","properties":{"status":{"description":"Current Studio session status. Possible values: `stopped`, `starting`, `running`, `stopping`, `failed`, `building`, `buildFailed`.","type":"string","enum":["starting","running","stopping","stopped","errored","building","buildFailed"],"x-enum-varnames":["starting","running","stopping","stopped","errored","building","buildFailed"],"title":"DataStudioStatus"},"message":{"type":"string"},"lastUpdate":{"type":"string","format":"date-time"},"stopReason":{"type":"string","enum":["CREDITS_RUN_OUT","LIFESPAN_EXPIRED","SPOT_RECLAMATION"],"title":"DataStudioStopReason"}},"title":"DataStudioStatusInfo"}},"title":"DataStudioStopResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the Studio is not found or when the API is disabled for the workspace.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/stop-data-studio.api.mdx b/platform-api-docs/docs/stop-data-studio.api.mdx index 7171890f9..453b28d57 100644 --- a/platform-api-docs/docs/stop-data-studio.api.mdx +++ b/platform-api-docs/docs/stop-data-studio.api.mdx @@ -5,9 +5,9 @@ description: "Stops the given Studio session ID. Append `?workspaceId=` to stop sidebar_label: "Stop Studio" hide_title: true hide_table_of_contents: true -api: eJy9Vm1vIjcQ/iuWP7USAdqmlQ6pamlCJNRrgoDoKkVRYnYHcLLYju1NDqH9752xd2E3Cz1d1fbTej2PPc+8e8e9WDk+uOPO56nUjt93eAousdJ4qRUf8JnXxjG/BraSr6DYLACZA+cQwMaXXTY0BlTKHn950/bZGZHAOP35kXlE4WEmqjNS4XqPYYlWHj77Lu9wbcAKUjhOS5WXwot4DMVGWLEBD5ao7rjCH4SVFPBIh0uiaoRf8zb/Bl/nrVQrJlNQXi4lWFJv4SWXFlC3tzl0uEvWsBF8sON+a4KqcIoXRWevvWZrpf8lB7ttEfi0N1jlG7AyqStnn9boU72R3kPaCW6unOWC9wyk5DcS5A5s3WktlhJFK7AoWmq7ET5u/XSOvO/JSGe0Qj/Qie/7ffo0md78jkeDAuVJKozJZBLi0ntyBNnVlB6cdsef9GKWL6IVxKwWGeeFz91YLTXlVslUL54g8RRZS6H3MrJqXHOwa6F1BkLxon5zKzhfH/iiwe5w4Ql2Edt220VuLV76vjIivMsmGv8XGbBXkeXgBuyxjOtjh5YC71crWttcqXIZEOV6KWQWwYtcZmm5G9ZXUUTJ8N4XgMkW6zoqoCyP94eYxOurZQgaWKttWFV6qmVUQ+H7fEb3nr0KS1Xg/n0FXvqM7DiU/yx6HWOFCp1YwZGy7PBMOH9rUuGPiGvlQIAzL7GAi8hsCqJM7FMOvJiOLsfz2cP09vrh5naOko/jq9FsMrx+GP05GaMUt2aTm/nDdHTxcfjHcD6+uT5lyl4hdpKTtoZsPAWgG2IdI4RA5/0fjlRy1U+Z0p6JLNNvkIaEP++ft+HX2l/pXGEDeqN21OxCdMOSpEzbg3w4GZMwlU5gbqeIsGF/3xa7/7SXVGH+Yrc4nQ81340o6RouC10kya302zBNfgNhwQ5znB2Du3vqlDhq1poGkcmDVhorA94rR2Rvt29CRY9yKDQ8+1pNp9xmiF57b9yg1xNGdpNM52nXwQsGpRsG2rtOFSRskglPmcouCE8e5sSmIjsjb0XL65T3xpPGaiqErhlAVGJhcVXVwNObDx6SVdMrPVWyILVfIkjmygRcCaYwiySEuWl83WSMtMzCRFrqXw8CJEKei3q+6374sdunPaOd34iQJeW8pdRn+xdBg9/ukGj/z3Ol9Dj99kwmZBhNwfRdmS2HB1WHD5rjEBMGo7pGAwm22y2Eg1ubFQVtxycEpVFVWXywFJmDvzH5P3tgHDXzGbat10+YbLgb8hWHgyTmX2nFN9OyB3zbHqRHnmxHuZWbQm3rpCrOhzAU9wheg0ixPohllA+TBIyvnWz1rEZzmIRhIJpF+K7owu1HWWHcA2Kun0Fh7CuSnv6JYFH8BeJ0CH4= +api: eJy9Vm1r40YQ/ivLfGpBsX3X0A+Co3UTB0yvibETrhBCspbG9ibS7mZ3lFwQ+u9lVpItxXaPK20/eb0zmueZ9y2B5NpDfAueilQZD3cRpOgTpywpoyGGBRnrBW1QrNULarEIisKj98poMT0fiLG1qFPx8MurcU/eygSn6acHQUZ4MlbI9hulhRRbHZEYTfiVBhCBsegkA07TBvJckqw/gwisdDJHQsdUS9AyR4ihoTBNIQLFVK2kDezz7/H15JReC5WiJrVS6Bje4XOhHKYQkyswAp9sMJcQl0BvNkCFr6Cqoi16x9cW/7lA97ZH4MvWYV3k6FTSBRdfNqiFyRURplEIcxssH6JnMeW4saDw6LpB22OpNOEaHUSwMi6XVF/9fApVdcdOemu0R89ffByN+KfP9Op3iCAAaGKptDZTScjL8NGzStkB3QXtFh7NclEsay+YWSczniQVfqpXhmurYWqWj5gQZ9Zx6knVrHpmdn4tjclQaqi6lveS8/2Jr3rsdgaPsKt198N2VjiHmt53Rq0+EDPjvVpmKF5kVqCPxUOT14eIj9KR0ms+u0Lr5hg0mvNKqqxWXhYqS5vbcL6oRVwM72OBusjrvq4BuMpr+yEntfn2GJKGzhkXTi1Oe6xhOH1fT9juyYt03AX+3wcgRRn7sWv/RR31KoIcvZdrPNCWEWTS041NJR0Qd9qBFU5I5Vjn3tg5yqawjwXwbD45n14v7uc3l/dXN9cQwefpxWQxG1/eT/6cTeeTc4hgMbu6vp9Pzj6P/xhfT68uj7myBayq476GajymwBbqPoaqYqXT0U8HOrmdp0IbEjLLzCumoeBPR6f76peGLkyh00i88jjqTyG2sGKpMG4nH8+mLEyVl8sMU7EyLtxvx+Lgn86SNs3fnBbH66ETuwkXXS9kYYokhVP0FrbJbygdunFBG4hv73hS5kgbw4vIFgGV10oMw2ZFDsvtEKqGXENh4LmXdjsVLoMYNkTWx8OhtGqQZKZIBx6f0clBWGjvJlWQiFkmiStVnLE+RxiYTUt2wdGqPe9S3jrPiO1WCFMzKHGLhcNF2wOPrxQipNqh10SqYcGw3yLI7qoEfaPMaZZJSHPf+a7LmEuVhY20Mr/uBFUEHLka58Pgw+jjYMSX1njKZSiTZuFy7Yvtk6BHsNxV2v/zXmlCzn+HNpMq7Kbge9mUy+5FFUHc34fGcm1vjCdWK8ul9Hjjsqri6/oNwXXUthbEK5l5/BuX/7MXxkE3n/Bt7/kTVhvEEAr2RTrFzL/Tix/mzRD4cX+THnizHeTWXEr91iXVct6lobqrItigTNEFlrV8nCRoqfPl3tDqTYdZ2Aay34Xvui5YP8iqLGuNa/OEuqq2JIn/M8Gq+gtPCwij sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Stops the given Studio session ID. Append `?workspaceId=` to stop a Studio in a id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/token-list.RequestSchema.json b/platform-api-docs/docs/token-list.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/token-list.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/token-list.StatusCodes.json b/platform-api-docs/docs/token-list.StatusCodes.json new file mode 100644 index 000000000..e6ee54008 --- /dev/null +++ b/platform-api-docs/docs/token-list.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"type":"array","items":{"required":["name"],"type":"object","properties":{"basicAuth":{"type":"string","deprecated":true},"id":{"type":"integer","format":"int64","nullable":true},"name":{"maxLength":50,"minLength":1,"type":"string"},"lastUsed":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time"}},"title":"AccessToken"}}},"title":"ListAccessTokensResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/token-list.api.mdx b/platform-api-docs/docs/token-list.api.mdx index 12401d44a..12b3f2297 100644 --- a/platform-api-docs/docs/token-list.api.mdx +++ b/platform-api-docs/docs/token-list.api.mdx @@ -5,9 +5,9 @@ description: "Retrieves the list of all available API access tokens." sidebar_label: "List tokens" hide_title: true hide_table_of_contents: true -api: eJydVE1PG0EM/SurOadJaKFSORUQrVCRivg4oRycXScZmJ1ZPN5AtMp/rz27CZuAWtRTNvaz/Ww/T2MY5tEc3xsOj+ijmQxMgTEnW7EN3hyba2SyuMSY8QIzZyNnYZaBcxkswTqYOsxOri4yyHOMAkpphmZgQoUEmuSikDS3ar+UaPEQxir4iFK3MZ/HY/3ZLfr7l8Dy4Bk9qxeqytk8ZRs9RIU0JuYLLEG/eFWhBIXpA+aavyKtzbYt0DX2igMiWAnMMpbJTvhUW8JCx+ChRB3C33NOIdr8pOZFL22UOfm50flVhEJWEzLVuJZSRQ9opa05kiBngUrg1vT1UAy+dmmi28BER0JLeLlEP9eCR+OBKa3f/D0Y7BGQKAeR7yIW77Hb1iyE4Se2kl8i9M8ZYUv6Y0ESxZaVqzlJu08rFnvPoQvvOeN1t3lFCezwvd2fQpHpRjBp5cMi6C+xlIIw/8AeN8A3LfebOCcK9Ib5l3dUu1F85gPriYRn4aPwiHlNlldCrjGnCITUqud+shaSJfIi6JXMMXEEdZlRp1wNpyVSTNE1OfEtmKt4PBpBZYe5C3UxjPgk1Yc2mP0Lvkme7MoB6x6zM8XrzRqtvaF2o5Nsp9InuB2MVlQqCSb/pwkklvbjx0YhD8+cWrZ+FlJ4N8WOhZb9F0Ft14poOrBKAPIkgd3m+y2LCqxLlzQL318dQkQn19Y5GH47Go7VVoXIJSQFtReWlJptB77Dr3kV4f+/ht0UGV94VDmwXmmkdppu3/0neCH81NI08tLgHbn1Ws1yFKQaks8lkG1fCpGQBCAUsg0VyCOuupOsVExLcHV69favZ0d4P89vBQu7K99bccq+eUP9qpdbaCZEOnKhOuhIcPsiTORk/gBErTIE +api: eJydVE1v2zAM/SsGz1qSdt0OPq0tuqFYgRX9OAU5MDaTqJUlV6LTBob++0DZSZ206Iqd4pAU+cj3yBYYlwHyKbB7JBtgpqCkUHhds3YWcrgh9prWFDJeUWZ04MwtMjQmwzVqg3ND2en1ZYZFQSFkXZoRKHA1eZQklyXkcCf2Kx0YFHgKtbOBAuQtHE8m8rNf9M9vUFA4y2RZvFjXRhcp2/ghSEgLoVhRhfLFm5ogBzd/oELy115qs+4K9I29xqH3uAEFmqlKdk9PjfZUyhgsViRD+DjnHIMuThteDdIG9touQeZXeyqQJSH7hqICXQ4CtWVakgcFC+cr5M70/QQU2Makie4eJjh5CxW+XJFdSsFvEwWVttu/R+oAQFRgMPB9oPI9dLuaJTJ9YV2RvJA/55460J97FBWwZsEKp4n7RDHEoUMIHzjDTc+8REUFJ+9xf4ZlJoxQ0sqnRTAksaIQcPkJHreBb1oeNnHhvfNvkH99R7VbxWfWsayIe6YypQpUNF7zBvJpC2eEnnynnukszhRUxCsnW7KkhBHFBeNeufLcr8mH9LrxBnJYMdchH4+x1qPCuKYcBXoijyPt4HCDb5MnuzbIwmN2LvGysyC1t9BuZZLdVIYAd4ORigIlhUEO8xQEqv/4uVXIwzOnlrVduPS8n2KPQsr+C6C0qwsKfbBIAIskgf3mhy1ThdqkTVq4H6+OqEAm19U5Gh1NjkcTMdYucIVJQt2KJalmu4nvAWxfVfj/57AfI9MLj2uD2gqM1E/bEz68wSsXWCxtO8dA997EKOanhryIaKZgjV53p2I6iwpWhCX5pJBH2vQ7WYua1miadPYO12dPeb8u7kAB7nN+wHHKvj2idjPI3bZdRNryGEH1ILg7CbMY418tbjIp sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ Retrieves the list of all available API access tokens. - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-action.ParamsDetails.json b/platform-api-docs/docs/update-action.ParamsDetails.json new file mode 100644 index 000000000..68b0c8809 --- /dev/null +++ b/platform-api-docs/docs/update-action.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"actionId","in":"path","description":"Action string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-action.RequestSchema.json b/platform-api-docs/docs/update-action.RequestSchema.json new file mode 100644 index 000000000..a603ccda4 --- /dev/null +++ b/platform-api-docs/docs/update-action.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Action update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"launch":{"type":"object","properties":{"id":{"type":"string","description":"Launch configuration identifier."},"computeEnvId":{"type":"string","description":"Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted."},"runName":{"type":"string","description":"Custom run name for the workflow execution."},"pipeline":{"type":"string","description":"Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)."},"workDir":{"type":"string","description":"Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted."},"revision":{"type":"string","description":"Git revision, branch, or tag to use."},"sessionId":{"type":"string","description":"Nextflow session identifier for resuming failed runs."},"configProfiles":{"type":"array","items":{"type":"string"},"description":"Array of Nextflow configuration profile names to apply."},"userSecrets":{"type":"array","items":{"type":"string"},"description":"Array of user secrets to make available to the pipeline."},"workspaceSecrets":{"type":"array","items":{"type":"string"},"description":"Array of workspace secrets to make available to the pipeline."},"configText":{"type":"string","description":"Nextflow configuration as text (overrides config files)."},"towerConfig":{"type":"string","description":"Platform-specific configuration options."},"paramsText":{"type":"string","description":"Pipeline parameters in JSON or YAML format."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"mainScript":{"type":"string","description":"Alternative main script filename. Default: `main.nf`."},"entryName":{"type":"string","description":"Workflow entry point name when using Nextflow DSL2."},"schemaName":{"type":"string","description":"Name of the pipeline schema to use."},"resume":{"type":"boolean","description":"Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)."},"pullLatest":{"type":"boolean","description":"Pull the latest version of the pipeline from the repository."},"stubRun":{"type":"boolean","description":"Execute a stub run for testing (processes return dummy results)."},"optimizationId":{"type":"string","description":"Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"optimizationTargets":{"type":"string","description":"Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to each pipeline run."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"launchContainer":{"type":"string","description":"Container image to use for the Nextflow launcher."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the launch configuration was created."}},"title":"WorkflowLaunchRequest"}},"title":"UpdateActionRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-action.StatusCodes.json b/platform-api-docs/docs/update-action.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-action.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-action.api.mdx b/platform-api-docs/docs/update-action.api.mdx index 09603f6a7..914f30cb2 100644 --- a/platform-api-docs/docs/update-action.api.mdx +++ b/platform-api-docs/docs/update-action.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the action identified by the given `actionI sidebar_label: "Update action" hide_title: true hide_table_of_contents: true -api: eJzFWOtv2zYQ/1cI7UsG2LKbtXvk09K0G7KlbZAHhi0IEFo62WwkUiUpu57h/313pB605cTuUGxf2pg83kt3v3usIsunJjq5i3hihZImuh9EKZhEi5J+RyfRbZlyC4bZGbAULBe5YSpzP/0bJlKQVmQCUjZZuoupmINkD/7+PH2I2Q2ePhhV6QQe6DmXDD4LY4WcNmwSLqWybAIsmXE5hTSOBpEqQXPPpdXl1NHjZck1L8CCJgtWkcQfSNRIRQJBBpTczqJtqzwPZqwmDVoLNBJq+FQJDSjP6goGkUlmUPDoZBXZZUkC/KNovR60MhdKP5qSJ9CJ/VSBXvbk/tEQMlkVoEWyKbsnS0gLU3eVKV1w64++f4nS772qYOxrlS7pzU4TK+czVpMio0QhT2npAS/LXCTOv6OPhl6t+iqoyUdI6GGp6WtYAYZuveU9pwyinFcyme1nINL+8213XTheDFXOxLTykRB4LCZ5iSrKysJbOT8/gOOZp2Yg50IrWSCrgCFbzECDi+FSlJALCWwh8pzpSsbsDWS8yi3mgmLtF2elFgXXS5bs4pwxVQhrKZhRVeTyfqfbelpWxqqCpDLyM8OP75QiqVmuFpg8kFRE7Pg2uu5nfNlYpaFURliFit9eXbAjiKfxgD3MrC3NyWg0FXZWTWK0aSThsyWZQ6FGM8hz9fCtE0q6vBF6v0yKeZZiSiVOHOVj7efWHApzXUAqKFQzkSPecLxHJ2Aibjp+l5sXmxK2vQ5zYYSP7uc1/VVY1lAP2ERzDL4BI9/zKcmuDDiOBoypMWkfy/e191j9Jgw2+qoaTFUQBmWIrIig+MlNHdYU85daOXcEgrjWnIBFWCjMzgzcwgGiJ8xtVdlMp9KLcIHmPEyosHQ6oL36GhIN9qsoQOzQD44fCSr4IxaRORrOJ6gAnoSJ1waZS7OvqEaXul+mi3fbDXrxCz77pq85ysIbdqTmoDWGgqkJfND7xLJqAfrMHR+Q0Dm3VBqGpoQEwyrZkqgcoQ8pVy/NYQa0QNEVWcxS9tv1h/eUEH+evrtgviR51hquKnntGOxnfpqmjDN/gn7mtsYzcDLI8TIb+jrSUCHKUh4qJJirR0qY1sUYwAkmF5iYXQOwu0tEDi5ThgBnhwShnoW5P2rQLVWJiQ18wt4iRlQrGx8muarSkRc84ukc8x/Sb9C2IfIbNvyGNT//tej065jOM/Qy41ht+qaxGZ+Dw74cCNf+D0sLLg43M0dbJIYgak3vGospzAloWkw/YQ90H8vswQlBcNTLw4rkH20xpDfoBKwivlxidcHGx2xEyZvri2MP3q7BOUwEUTXdbtsQeAZhPXAgHrKbKJUDlz1+b6VDF09PHPAvy7XdUdhZprEDIME5N5aZKqFIyKq8CYo6Bq48L96xwA/3hQGQcDRp6LX6xv835MOGIUVCHetVnl/QNGAPsPUSiWv96QVDxHMFcNudrZ1dS+K/k60mmFiHeNVnEOUVvnFdk2uYwM8XR10WIdpXWrK0Koql+wp5E9yEk4X4u5019kXGh4D+6f60TtOu6fIjEAulHfqtGocNw8cjKiRzAYu+FTdcTzcr5tMtccGHBgjpEVtYjnMZfaWQGXZAjtt/bhGWY8jP00MK/9Oz0pOtgOPOzt/4vgcbtKmkvwDzoQtQ6v2Jxwx4+puanJXVfqnfHfexpComiO8o9ezy1hDOq8T5u2nuW6giQeyjmoRS30GBifFu8m8k+7eNRIctT4mk+lvAlE+WmD1xN85hO4Kjv4QD2v2WlOFcNIUaJ/siPeN6iKMZ9UwD+WOXhNZAohtisEBP7A0eIpYWpUd/Dzw7pscF9mCJlxTTDB9ZYXMIyomfOa/qeTmkCNcP3f16e2XgC0KJXZfv24/HL/vT+Yff2ZC9p3HGT+P46OV43Kd7jd/lX8zunUZ3EfrF4Ieg1c7zE3lDuGvV0TrhrdZKX9X2kflO8+92WNisbhitdSj4FqjP2o1PSaWFXbqtzWvASU+fVnaGP+9pq4Hd5kzRugfnPLfloatoVG+oRqtmwbOmhQliRbP/qXSOdA308FLEDmY6/OnFzLW7YU0Pzc6Inp1enkekR6PmNXnVeyhUtnUSSWx2N65MOSI88X/80sTux4UPJ/paV93m5u1nTl1dt1Ppwr5bpdCypDvfXHl05+1+oTvqVgPdWTu5By/bGbk7C6bcUPTmWHrXXN1vjYvhRX+KC2/DuaoTtDEFBfYEM0xwujF+BOebzXl3Efay3WnQfAZuCPrF0GG+5fM7wrAxqreGTffif263Fx2jnSU7DIGm/t2N77dq0HhHdRjvQOwAqUOYRWA6fjkc/zA8/unmxauTVy9Ojn+Mxz+8+MtFqZCZckFe532dK5Qc+9KIklJgx1UTE2hhzhKzzRQNExNdLHJXwTL1c3eBitR9I969iH96FY+boavgMsgZj831Lnlbw1UHnP/zPruGDFoCUDckpFuzkFdWNdB1q/hBdNLusunTK4quu2i1mnADtzpfr+nY75kJ/1JhaLrAL5vx3MAzPtizhd6p5CMse4vuOc8ronRwOedakPwv1OXoqi5V37JnlvI7VWr6QbkMdWlUbX23vq/bKMoF1M1fn3kNhjfEpHveK6u05fcvTnECK+2ztGH1ury9oRpQ7+YLldITzRcEHviv07TezriKTWcrTF45rVwRjjxLykW+WXC2CowzaqcvMFQcxY16BLlet66x9Jv8sl7/Aw0mL8k= +api: eJzFWFlvIzcS/isF5sUBdNmZHKun9XgmC2c9M4YPBLuGAVPdJTXHbLKHh2RF0H8PiuyDOmxrgkHyZIss1tVVXx0r5vjMsvEd45kTWll232M52syIin6zMbutcu7QgisQcnRcSAt6Gn7GNyByVE5MBeYwWYaLmZijgod4f54/DOCmQHiw2psMH+g5V4BPwjqhZg2bjCulHUwQsoKrGeYD1mO6QsMjl1aX00DPeqzihpfo0JAFK6Z4iWzMGqmsxwQZUHFXsG2rIg+wzpAGrQWG9ZjBL14YzNnYGY89ZrMCS87GK+aWFQmIj9h63WtlLrR5tBXPsBP7xaNZ7sj9vSEE5Us0ItuUvSNLKIezcDXVpuQuHv30hq3X91FVtO6tzpf0Zq+JPvgMalLWY5lWDpWjB7yqpMiCf4efLb1a7aqgJ58xo4eVoa/hBFq6jZbvOKXHJPcqK15nIPLd59vuugi8INNqKmY+RkLisQHJy3RZeYfv1fz8AI5nkRpQzYXRqkTlEoawKNBgiOFKVCiFQlgIKcF4NYB3OOVeOgtOQ/vFoTKi5GYJ2T7OU9ClcI6Ced1jxquPe922o6W3TpckFcjPMNUmKEVSp1IvAJ8w80Qc+Da6vs74srHKYKWtcNos4fbqAo5wMBv04KFwrrLj4XAmXOEng0yXQ4VPjmT2hR4WKKV++D4IJV3eCfO6TIp5yIXBLIijfKz93JpDYW5KzAWF6lRItMANgnXaYL7p+H1uXmxK2PY6zoUVMbpf1vQ/wkFD3YOJ4SorekC+5zOS7S0GjhatrTHpNZYfa+9B/SYNNvqqBq0vCYOmXEjM6ZPbOqwp5i+NDu5IBHFjOAGLcFjavRm4hQNET5jbqrKZTlUUEQIteJhQYRl08BbNNWYG3TdRgNiBjfxIUMkfEficC8knEukkTbw2yEKafUM1utT9Ol2i227wyX3FZ9/0Nbfg8MnBkZ6jMSJHWxPEoI+J5fQCzVk4PiChJXdUGvq2wkxMRbYlUQfCGFKhXtrDDGiBoiuyIBT8dv3pIyXE/04/XEAsSZG1wSuvrgOD15mf5jlwiCfgCu5qPMMggxyvpv1YRxqqygjKQw1CzfUjJUzr4sroDK1FO4BrRLi7NAhc5VBp6/oEoZGFvT9q0C3XmR1Y/IKGD4QeVo0PM6l9PoyChzyfc5Vh/l1lsM9V3m/49Wt+8WvR6bcxnU8dGuBS7jENCj7HgH0SCdf+CUtLLg43Uzo0ijsxR6B3jcUU5gQ0LaaP4YHuB2r6EISgcmZ5WJH8vS2G9AYqLZSL5XJRoAJvN6Lk3fXFSQTv0OAcJoKomm63bQgig7QeBBBP2U20lsjVDr/3KqBLpCcOBq3jxu0p7DA1ugyCJbcOrM8oEqZeNkFRx8BV5MU7FsarrwyAjGcF9qNW38U/fd5vGFIk1LHupbygacAdYOull7LWn17AHE0ogNvubO3sWpL4nZyfXHl1iFdjBlFeOT8JXVNomDDOF0ddFhl03ijIfVkuw1eQTXATTpbij3bWeC0yPiX0z/endZp2TVccgSCVdui3ahzWTx8PqZDMBS52rbjhZrZZMZ9viUvet0hI7zAHKayjr5QyAxe5/e0WST5BeZ4fUvifn5WebQUCdzh/F/sea8VM0X/Is6ILUOr9iUeBPP9NT84q/7rUH052scSXEzQk9ezy1hLO6yz4u2nuW6giQfBZT1KpH7DUZvlh8lckx7eNxIAtz4mk+lvijE+WDu2gG+fOtHJcKDyg3W9JQZR8hjVO7oqMjOshjmbUM4Pkj30SWgOJru9EiTtib0RJWFpWEf0j8OyZHhfcQhYlDWiGZ044iUk5iTPnVT0vpxTp+qG7X2+vDGJBqLSysW8/Gb3Znc4//Rf68JHGmTiNr3vszWi0S/eW539ldu80umMlWstnSKudlyfyhnDfqqN1wntjtLmq7SPzg+Y/7LGwWd0ArXUo+BaYB1YWM2+EW4atzVvkBs2pdwUb393TVqNEV2ha91Q+6Ej7mzEb1huq4apZ8KxpYYJm3ux/vJFszBro4ZUYBJjp8GcnZq7DDTQ9NJwRPZxenjPSo1HzmrwaPZQq2zqJJDa7m1CmAhHr1f/82sTu50UMJ/paV93m5v0Tp66u26l0Yd+tUmhZ0p1vrjy683a/0B11q4HurJ3ck5ftjNydJVNuKnpzLL1rru63xsX0YneKS2/TuaoTtDEFJfYkM0xyujF+JOebzXl3kfay3WnSfCZuSPrF1GGx5Ys7wrQxqreGTfcSf263Fx2jvSU7DYGm/t2N7rdq0GhPdRjtQewEqVOYZSejkzf90c/9k3/dHP84/vF4fPLLYPTz8f9DlAo11SHI67yvc4WS47U0oqQUGdqamECLZwG0NlM0TUwsuZChgk31v7uLdY/VfSMbs+PB8ehkMGqmrpKrJGkiONfL5G0VVx1y/sML7RozaAtA7ZBQYc9CblnVSNft4nts3C6z6dtrCq87tlpNuMVbI9drOo6LZgLAXFgaL3I2nnJp8QUfvLKG3qvkIy53Nt1zLj1RBryccyNI/lfqcnRV16rv4YWt/F6VmoZQLVNdGlVb363v6z6KkuFuVV+fRQ36N8Ske75TV2nNH1+cZhlW7kXatHxd3t5QEaiX86XO6YnhC0IPvoia1uuZULLpbMUkVzMfqjCLLCkZ+WbF2aowwai9vlitIsWNfkS1XreucfSb/LJe/wmU1S/u sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the action identified by the given `actionId`. The `sourc id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-compute-env-primary.ParamsDetails.json b/platform-api-docs/docs/update-compute-env-primary.ParamsDetails.json new file mode 100644 index 000000000..73360e964 --- /dev/null +++ b/platform-api-docs/docs/update-compute-env-primary.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"computeEnvId","in":"path","description":"Compute environment alphanumeric identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-compute-env-primary.RequestSchema.json b/platform-api-docs/docs/update-compute-env-primary.RequestSchema.json new file mode 100644 index 000000000..6672aa144 --- /dev/null +++ b/platform-api-docs/docs/update-compute-env-primary.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","title":"EmptyBodyRequest"}}}}} diff --git a/platform-api-docs/docs/update-compute-env-primary.StatusCodes.json b/platform-api-docs/docs/update-compute-env-primary.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-compute-env-primary.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-compute-env-primary.api.mdx b/platform-api-docs/docs/update-compute-env-primary.api.mdx index fa667a1bb..86a010881 100644 --- a/platform-api-docs/docs/update-compute-env-primary.api.mdx +++ b/platform-api-docs/docs/update-compute-env-primary.api.mdx @@ -5,9 +5,9 @@ description: "Selects the compute environment identified by the given `computeEn sidebar_label: "Define primary compute environment" hide_title: true hide_table_of_contents: true -api: eJzNVd9v2jAQ/lciP20SBbaxSeNpLeukatKKaKs9VEg9kgPcJrZrOzAU5X/fnZNA+KF2fdtLIM7nu+8+f3cuhIeFE8N7EevM5B7PUK2cmHZEgi620niplRiKG0wx9i7yS4xqZERIabXKUPlIJvSUc4lJNNsE1EKuUEUPNfhSra6ShwiqCMbKDOzmdCTV2r7W9skZiDmp8vjHd0VHaIMWmNdVQszuTAIeR9s04yo24QxYyNCj5foKoeiF8G1CBJJcnQG/FIclj06Qg9QsQeUZWhnvarbMyuJzLi0SJW9z7AgXLzEDMSyE3xhO7LyVaiHKsrPlsi1vR+U5x0B+n8vvrQ6nkx8lk6TWAi19mmubga+Wvgwo/bTiis5f6GTDe4K2yvNfMCaVcVC39+g4d3EcXM8eyQwU20uf8sJlZvyGo02qwJSFyqQ0zmjl0PHej/0B/+zXdf0zOot+6ahhQJsG/f4x7gKSqCZNaf+Z7+5M7kWGzsEC2dqHZRjLlvKyItoAT53crmJrtZ3U9dXlDvqfTlTYmDVSmv2T6jXxYbjDOLfSb4I5LxAs2vOcfDi8n/IZkXOXmg1udCg6eHQoeu0+7RVtN5c9s/W+Q7tqjJ/blDYuvTdu2OuBkd041XnSdfhM3LpSH9ntJnyJxil4tk80Ynx0Pr4SzKwhfsM6V5q16W9l44yNN/l9FkC0Uv350Rjzce2DIHx+k50zL/9AZljsouTemOsQuta/ZsiUXiPPUsgYXQ1m80AczLMvTFsO8o9MQ8/M9bfdByLCqlZ5PnS/fu72eY1PKIPgvbqxv+Ncqhfn3CHtVhf+V8O2Pkt+7ZkUaEZRwUG4orbkwdXREcODEdu4kqyzZC/TjqKYgcM7m5YlL1dDj72aSAezlDt2DqnDF0R6bSSeJP6Em6Oxu4I0Z2Tw9gqsZAJvJPNuUk+a99Ebr42TNOtFUJs2v4b+nrzllPBLhIQ6izlXkFHF7OyWA+1CHE1LvouqHedxjMa/iG0PpfH1zS13cn2DZDrhPRbWfBPSM9DVQakwIMJaIVJQizwMV1HF5L6H/bFxMCZCVScFIRMFxK1+QkVGavTx/M7ClOVfawIbPw== +api: eJzNVU1v2zgQ/SvCnLaAYrvdYA86bZLNAsEC2yBJ0UNgoGNpbDGRSIYc2TUE/vfFUJItfyDd3nqSRA1n3nt8M2yBceUhe4bc1LZhuiC99jBPoSCfO2VZGQ0ZPFJFOfuES0r6yIT0Wjmja9KcqII0q6WiIllsY9RKrUkn3/rgW72+K74l2GWwTtXotucz6dH2jXGv3mIuRTXTd55ACsaSQ8F1V0AGX2yBTDe7MvddbkjBosOamJzwa0FjTZDBGBCkoISdRS7hmPLNGXBY2RJ1U5NT+Z6zE1SO3hrlqICMXUMp+LykGiFrgbdWCnt2Sq8ghHSHZUdvD+WtoQj+EMvXnQ7ni58UU5ppRQ5SWBpXI3dLf1xCCPMOK3m+NsVW9kRtNcsrWlupPKo7ffFSuz1NbhYvlDOkwIorWbitLW8l20OXGEIIQcp4a7QnL3s/zS7lccjr8z/JRfKvSQYEIYXL2ew07hqLpAcN6f/Huz+TZ6jJe1yRWPuYhnViKVYd0CHw3MntGTtn3EPPr6d7Ofv9DMPBrIk24p/KbKiIqTzljVO8jea8JnTkrhouIXueyxnVxKURg1sTSUePZjAd9+m0Hbs5TO3O+57cejB+4yrIoGS2PptO0apJXpmmmHh6I4cTZU7s9hj/JPcVstgnuZH45Or+DgTZAPxRdO40G8PfySYVB2/K9yIGQdq//D0Y82XDURA5v4e9M2+/Y21F7DZIbyxNTN3r3yMUSD8CL1KonHwfLObBPJrnUJixHFSjqmLPLM2f+x8hBVG1q/Nx8nH2aTKTRTmiGqP5+s7+i5ZKvzvojnGP2vCXmrb9Ycrn1FaotBCOyrW9J4/ujhSyoxk72HKeQilmzp6hbRfo6YurQpDlbuqJWQvlcVFJyy6x8vSOSD+aiWeBv9L2ZO6usWokMpp7jU4JgJ8E89tDP2o+JD95b5yF2S+i3o7xDfAP5A3zkEJJWJCLmLuQmw7ZxZMk2qc4GZdyGXU7rvKcLL8bO55K958fn6SV+yukNoXscbiRqxA3HVwTlYoTIq61UKFeNXG6QpdTGh8P58bRnIiszgrStl3Ek3klHcJOH5ZvESaE/wDI8xtk sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Selects the compute environment identified by the given `computeEnvId` as the pr id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-compute-env.ParamsDetails.json b/platform-api-docs/docs/update-compute-env.ParamsDetails.json new file mode 100644 index 000000000..73360e964 --- /dev/null +++ b/platform-api-docs/docs/update-compute-env.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"computeEnvId","in":"path","description":"Compute environment alphanumeric identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-compute-env.RequestSchema.json b/platform-api-docs/docs/update-compute-env.RequestSchema.json new file mode 100644 index 000000000..337e3ee15 --- /dev/null +++ b/platform-api-docs/docs/update-compute-env.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Compute environment update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New name for the compute environment. Must be unique within workspace."},"credentialsId":{"type":"string","description":"Updated credentials identifier. Changing credentials may affect running workflows."}},"title":"UpdateComputeEnvRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-compute-env.StatusCodes.json b/platform-api-docs/docs/update-compute-env.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/update-compute-env.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-compute-env.api.mdx b/platform-api-docs/docs/update-compute-env.api.mdx index 9744fd3fc..e24342760 100644 --- a/platform-api-docs/docs/update-compute-env.api.mdx +++ b/platform-api-docs/docs/update-compute-env.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the compute environment identified by the g sidebar_label: "Update compute environment" hide_title: true hide_table_of_contents: true -api: eJzNVt9v2zYQ/lcIPrWAI2dbVqB+WuJlQDCsC/IDewgClJZOFhOJZEjKriHof+8dJVmypSbogAJ9MSzyO/G77+4+quJerB1fPPBYF6b0cAJq4/jjjCfgYiuNl1rxBb83ifDgmM+AJeCFzB3TaXhsAxkGSqtVAcozmeCvTCUkbLULqLXcgGKfW/Cl2lwlnyM+49qAFXTIVbI/ZrkHIcAIKwrwYIllxRU+IHD4HgRJ4miEz/gx8eUEO5GbTKiyACvjnqolOhZeSmkBuXhbwoy7OINC8EXF/c7Qwc5bqda8rmd7Llttn50RMfRUXkqwuxGX/zogmz58dJhUHtZgcSvVthC+Wfpwhsc/NlzB+Qud7Cjm7bzLoC5r4/CtscYDlKdoYUwu41CJ+ZOjV1RjPnr1BDEFGkt18xIc7TY6HEt0nP0n2DJCMszlW40TsX9K59kKWKkksmRb6TOp2F7iiNdIGwtEuoncUde8dXDTVAkbhA2FZ0tshjUGHgAKsWMiTTFdZkulaJtIpLneuojKz730OUz07E0rb02gw34KC85o5Rrhfj09G1fu37/ZCfukWVccDDo7PR3jLkTyf0rZM3rgBTgn1kDj/nqFO+DUHOyFuLRW25s2P0o/MP9tIsNu5pnSNI2oKfIJ6I9j9J9lkw42Sg7UJD9rtrjpIC6t9LtgVRcgLNjzEl1p8fBIE4s+lmnyOWyVYG20xedD651XQ2uryRXAbjr3K22OAZn3xi3mc2FkFOe6TCIHLyhpJPWo+W/DDrvOhScPYUvCs/PrK06EOr63JFiT/JD1Pn86sTMoel4FEK40f/7q3Olp64NIVIib3p4uv4jC5NB7RT+qR7O8V5qMNNWBQit4mwlRfytJkkzGeF01YOoWEYduORRwKBs2jMyDwab6j34DiZD6zTm/RB9/j05pzWjnC6EGGTU2MGVqx3Srvn1/3L3aFs7DFz83ucBbCVmH7Ku2746u/BlfHFyq2B0ZJkm4qloJB/c2r2tabi43asdEOrHKabpSrB+8kudbV98k3WfYja7XjchLQob23QgricB3knl307rCe/adnweTNNtFoXZDfh39A1HrR8RnIBIcHuLcQJYNs5M7elH/ipGz0TdHE3Eex2D8q9ih3Vzf39Gsth8KhU4oxIotffDgb2Crg1DBAsJaxXO8Fsvgg7x5JU22ODSGIyMISU3qgT0UEHf6GVRd7+Xx9Ey61PVXEXCxyg== +api: eJzNVk1v4zYQ/SvEnFpAsb3boEB1auKmQFB0G2QT9BAY2LE0sphQJENS9hqC/vtiKMmWP5pgCxToTaIeOW/ezDyqgYArD+kTZKaydaAL0msPiwRy8pmTNkijIYVHm2MgL0JJIqeAUnlhivjabxSk19IZXZEOQuakgywk5WK5jaiVXJMWX3rwjV7f5l8mkICx5JCD3Oa7MPMdCBKw6LCiQI5ZNqCxIkhhfA4kIJmjxVDCMfH5GXaobIm6rsjJbE/VMR1Hr7V0lEMaXE0J+KykCiFtIGwtB/bBSb2Ctk12XDbGvXiLGe2pvNbktidc/h6A4nzwk2BSB1qRgwQK4yoM3dLPl9C2i44r+XBt8i3veT/vOqor+n2QQGZ0IB14N1qrZBYrMX32fERzyscsnynjjdZx3YIkz187HY4lOs7+E20EI0Vh3D81zkT8WfsgliRqLV9rEhsZSqnFTuIJtAlkjqJuqDx3zXuBu6bKxWjbWHgxL1GvpF4dACrcCiwKyoJwtdb8mUkUymz8hMsPQQZFZ3r2vpe3ZdBhP8UFb432nXAfZ5enlfvrD3EhPhkxFKdN4HI2O8VdY/5vSrln9AQVeY8r4nF/u8ID8Nwc7IS4cc64+z4/Tj8y/+lMhsPMC214GpXZUN7l+csp+re6S4cEKeIm+b9m2ybgKaudDNtoVdeEjtxVHUpInxY8sRWF0rDP2TpGZcNKYTq23mkztraWXYHcenC/2ilIoQzB+nQ6RSsnmTJ1PvH0Sg4n0pw0/+f4RdwpDOwhYs54cXV3C0xo4PuZBeuSH7Pe5c8RB4Pi92UEQdI//D640/MmRJG4EPd7e7r5ipVVtPeK/agezfJOaTbSwkQKveB9Jkz9vSRZMpmR78HcLZjFbjkUcCwbVShVNNjC/Lr/0CbA6ndxPkw+zD5OZrxojQ8V6lFKnQ+cc7Vjvs2+f/+7i7WvXKCvYWoVSs2sY/pN33hHd34C6cGtukigND4wrmmW6OnRqbbl5e52437Mpcel4vEqUHl6I8/37r6zdF9oe3K/rlHVjIz9u0YnmcB3kvnhvreFH8V3/h+cpdkvot6O+Q30D0RtF20CJWFOLnLuIPOO2cUDH7Q/4sTa+Kej23GVZWTDm9ix39w9PvCw9n8Klcl5i8MN//HgpmNrolDRA+JaAwr1qo5GCN2RPNp46AxHThCTOqtH03SIB/NCum138gR+Z13a9hsWW7Hv sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the compute environment identified by the given `computeE id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-credentials.ParamsDetails.json b/platform-api-docs/docs/update-credentials.ParamsDetails.json new file mode 100644 index 000000000..e6940e2f5 --- /dev/null +++ b/platform-api-docs/docs/update-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"credentialsId","in":"path","description":"Credentials string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-credentials.RequestSchema.json b/platform-api-docs/docs/update-credentials.RequestSchema.json new file mode 100644 index 000000000..73ab6970f --- /dev/null +++ b/platform-api-docs/docs/update-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Credentials update request","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"required":["name","provider"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"name":{"maxLength":100,"type":"string"},"description":{"type":"string"},"provider":{"maxLength":16,"type":"string","enum":["aws","azure","azure_entra","google","github","gitlab","bitbucket","ssh","k8s","container-reg","tw-agent","codecommit","gitea","azurerepos","seqeracompute","azure-cloud","s3"]},"baseUrl":{"maxLength":200,"pattern":"","type":"string"},"category":{"maxLength":20,"type":"string"},"deleted":{"type":"boolean","readOnly":true},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"keys":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"s3":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"},"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},"azurerepos":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},"azure_entra":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},"container-reg":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},"tw-agent":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},"k8s":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},"ssh":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},"google":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},"bitbucket":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},"gitea":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},"seqeracompute":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},"codecommit":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},"gitlab":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},"aws":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},"azure":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"}],"title":"SecurityKeys"}},"title":"Credentials"}},"title":"UpdateCredentialsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-credentials.StatusCodes.json b/platform-api-docs/docs/update-credentials.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-credentials.api.mdx b/platform-api-docs/docs/update-credentials.api.mdx index ca517c8af..50635b3c6 100644 --- a/platform-api-docs/docs/update-credentials.api.mdx +++ b/platform-api-docs/docs/update-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the credentials identified by the given `cr sidebar_label: "Update credentials" hide_title: true hide_table_of_contents: true -api: eJztWt1T2zgQ/1c8erqbCR8tXKeXp4Mc1zJ0CkPK3EOHuSq24ghsy5VkQprx/367kh1btkPgIDcE+gK2tFrtt1bOb040DRXpfyW+ZAFLNKeRIpc9EjDlS55qLhLSJxdpQDVTnp4wL2Ca8kh5Ymxea+s8bp7GnAXeaGZmQ37DEu9bjeg4+LZNekSkTFLkfhws+A9qIvRISiWNmWYSxZuTBF6A0uEEVBzFS6mekKbMNW6e0pInYSWfBGrJvmccaEhfy4z1iPInLKakPyd6luJWdhHJ895i96mQ1yqlPqv2/p4xOWtt/ndJ6CVZzCT33b1be/FEs9BMjYWMqbZD7/Zh90srKlP6UAQzXLNcz8zY0SvogZsvgHGicRVN04j7xuY7VwqXzttyiNEV83FhKtFDmjOFs/XggNfKdF+tZQz9DagoMXbu5sUD/BvT208sCcFv/bdve02T9wqDO3Rvdnc7CB1jtHxXE6zB7F2TV48w8BWqRKcYf/RHJln5/x/QXlJ4C4UIIxwOuZ5kI/sQUXwYcT3K/GuGKiuFAXn9XhU+oDxhcksy3EZPt2iITsGpgPkijrm2jBgtN5QsFbhYse+QKECTZnohzZYfiQwjUO2RS9BxRBW7kFHTrmgvSA1IIYwT0mE8CAcWCjlrrew0dATZGNSMPBIiYjQxuUSD0ySa2VwC4ogqfaEc6oWZFxGOsbqluYmfFoeiIFD9GCZGDJMTj2ByzWZqdYoEHOMw5gnVQnZt1uCLKjaXFBxnn221ced74KE0RV6YuHtPLxEEl+8zpU7YrDOTFIMyoDtne2QqIXodZliUh3oWsQPD9Siho6gzfNAUGpIIx4Z7Q+ZnwGt2glbPF3m2Bm0zBYlRlJl22aBKQbXvDJumrjX5P3D9MRs1dahl9IbocYASn6PEnboU5bBDGRpFp2NzYD+1miOq/cnnZXoqYANVdem8WX3v2C243ZO+abeGyeaPVh2OcJro4w4nYg2POFsxOTSZey9VsN1wlDlCT5fOd4+yNcXyUh8+JJaRd8hhuquW1Rw2KDU6L8hLVRen9Bq0BDMmwKnofjs0xT7zT97BDGNzQuXKOnoQWrc7qYvtyDq0wcVjbC2XuE3yG5i7d/Jpcc06erk78+7kfatQYQu2Bm0fqg0GbTqR0KE9UKXh8GPrLLTN5xq0ggao4+pz91FnhGmKWDXBa5Dy3pGxnkPxkOtDo1tHj8LucYt6Hkf7BxS2lSzONeN/PdeftOkEk8B9+xwK4oHsug/WS+S0WTIee1A7h+fQWHRgLdo0d+3etyFRMwCJB0bijuDH++/LS3dIlE+03ctP13KIPp8sKD58rEHHTe3gcVok7BXUv+faVmxGjey8/L+OsvjitFzW621MJLZ6vBd1FXott9ifh/CGZd7SD6cv+FvZS/lAthkRtvQm9vNj/Kv6GP/zG81av9E8cyM+ya+rjimcG2+t3NSgH/XxFmTnvACdmOuyC64xAyoVibK2e7u7b0zo4FhOT7wt77PwSsgKLNrf3W3THdLgvwBc6piVGCwGFWU1VqUkvDNIj6QUcCRa/VB9I/leh4Yl5slLhPYgW8UU5Mmt8431TfIeMji/5EGGSIyvl+ikmOmJQJwUxCmxvoeXnRoqZ2fuAKNygjzlTQmeyhAcQiZap6q/s0NTvm0QJNv2s+82F6QJYLKp4Z1FVCNKwhsgvXdwdmyippR3iOa1pqpLvbAW7kgKuJMJSkMEI/bhrxJ/cTXVxg7otvMK7HR0S+PU/uDRQCAhiKhKjwKdtXh3VVkMV1CgAuKzwM1UNBUiphorASC1BK4ma3lbDTZKXBU1OaLGxsKYyClCxrSrnIAu5SBDQWx+jfVN7LsOrrsVwp/jHG77RzUBgmB02H3ebP/+2/au6UmE0jE1qVMY1eZ5HebXFHNeJeEagIJFJGl2q3fSCNpPFDOzYCebCC52sUf6LkYQwnUCWiHdfF54PM9x2EL3MD+gmBf1cwyL2B0KrgD2dUp7bYLDxQ7e0ChDSpNON1Ry3P+BsvxyXtS0X71VYMdOuYpBmszqApXyulbMEWc2gSMN0wektDQDK8vWF+RU8WhVYjxO7Qo8rlJ9J2294J1dfME8LYCPMbS+MCjpFM9X+GvEFcY0FpiIY3MS0STMTN0mliXmHXVLU6MU1dsm1yAQNIbiC17o83xhH3vBB7vk+b9+fDty +api: eJztWt1v2zYQ/1cEPm2A8tGkKAY/LcmyNkjRFnaDPQTBepbOMhtJVMlTXM/Q/z4cJVmfttMlHuKkL4lNHo/3zSP9WwiCwIjBtfA0+hiThNCIG1f4aDwtE5IqFgNxlfhAaByaouMjgQyNoyb2a22dI+2niUTfGc/tbCDvMHa+1Igu/C/7whUqQQ3M/cJf8j+rieCKBDRESKhZvIWIIUIxEA1OwhWSxUuApqItc42bY0jLOKjk08IVGr+lUqMvBqRTdIXxphiBGCwEzRPeKl8kssxd7j5T+tYk4GG197cU9byz+V8loROnEWrpNffu7CVjwsBOTZSOgPKhN69Flt3koqKhU+XPec1qPVNrR6egF67wVEwYE6+CJAmlZ21+8NXw0kVXDjX+ih4vTDR7iCQanq0Hx2BRM911bhlLfyd91Bw763lJn/9G8P09xgFNxeDoyG2b3C0M3qB7dXjYQ9gwRsd3NcFazN60ebkC4zRilWDG8Qf/pBrL/39jTBqEKwKlgpCHA0nTdJx/CIE/jCWNU+8WWWVjOCBvfzOFD0DGqPc08jY024OAncJTPnoqiiTljBDKDTUmihcb/IYaPBUlKS2l2fNClXIEmmNxk7liDAavdNi2K9srASLUHCeix3geEAZKzzsrew0dIqFfM/JYqRAhtrkE/sc4nOe5lLkiBENXpkG9NPMywjlW90ja+OlwKAoC0EOYWDFsTjyAyS3OzeYU8SXHYSRjIKX7NmvxZRXbSwqO8w95tWnOuyKCJGFenLjHjy+RK8Dz0JhLnPdmkkFPI/XOumKmJWGDGRflEc1DPLFcz2MYh73hw6YgSSGPjY5H6KVa0vySrZ4t82wL2qYGdVlmumUDjJkp3Rs2bV1r8r+V9C4dt3WoZfSO6HHCEg9Z4l5dinLYowyE4ceJPbAfW80xkDf9sEpPQ0pDgCvn7ep7x27B7Z70bbu1TLZ4sOqEMcR00eNEruGhxA2TI5u591KF242GMufs6dL5zaNsS7G80oc/EsvMO5CGdF8tqznsrNRoWJCXqi5P6S1o6ak4Rq/sfns05T7zD9nDjGNzCnpjHT0Jcrc3UpfbkW1ow4sn3FqucJuWd0D3TSZXkLrFnl5ubd5d/tYpVNyCbUHbH9WGgzaZajA9xlmr0mj0rnMW5s3nFrTygXquPuuPOitMW8SqCd6ClPeOjO0ciqeSTq1uPT0K3uMW9TSO9rcsbCdZGteM//Vcf9SmE4xJIxyqEE90332wXiJn7ZLx0IO6cXiOrEXPcou2zV279+1I1JwpH8+sxD3Bz/ff55fubyW9h24vP9vKIfp0sqB4+NiCjrvawfO0ivEF1L+n2lbsRo3svfy/jLL47LRc1evtTCR2erxndRV6KbfYn4fwjmXeyofTZ/xW9lweyHYjwlbexH4+xr+ox/ifbzRbfaN54kZ8lF9XG6Zo3Hhr5aYG/aiPdyA7wwJ0Yq/LTXCNHTCJik1uu6PD16KDY/l46ew5H5RTQlYyV7w+POzSnYL/XwAudcxKhMZAgJuxKiXh2iA911rpYaEfq28lP+7RsMQ8ObEiB8JQzdC3rExhfZu8pwga9UnKSIzrG3ZShDRVjJNKUisjw50G4qCGyjlYNIBRmUWO6LsSPJUyOERMiRIzODiARO5bBMl+/uy7L1UHwJSnhvMpBGKUhHPG9M7JpwsbNaW8IzZvbqq61Etr8Y4l3MkGpSVirIz98GeJv/g6I2sHdtuwAjudf4coyX/waCGQGERUpUeBzlp+b6qyHK6gQAXEZ4mbqWgqREw1VgJAaglcTdbythpslbgqajJGjU2UNVGjCFnTbnICu1R6aApi+2usZ2O/6eC6WzECGVo42UT9Xk1kruDoyPd5tf/q8Gj/0DYlylAENncKq+aJXsf5teVcVFm4BaRgEUqE3+kgCUHGLGaao53yTGiCF10xaIIEb1wxVYaYbrEoXJ5lPJxj9zhBfGmKAjqB0OAaBTcg+3qlvbXR0QQP3kGYMqXNpzvQkvf/QVl+GRZF7VdnE9qxV65iEOJ5XaBS3qYVMwaaTRFs/lwvCpqzXJa9z8yp4tEpxXye5iv4vEpoLW294n26+syJWiAfI+XzEg0zPmBhlourrGlyZCKPLUQIcZDawi1ylpx40KxNrVpU75uaBlkscorPfKPPsqV98ht+dpNl2b8UYzuX sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the credentials identified by the given `credentialsId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-custom-data-link.ParamsDetails.json b/platform-api-docs/docs/update-custom-data-link.ParamsDetails.json new file mode 100644 index 000000000..7cd8d1cd1 --- /dev/null +++ b/platform-api-docs/docs/update-custom-data-link.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"dataLinkId","in":"path","description":"Data-link string identifier.","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. Optional.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-custom-data-link.RequestSchema.json b/platform-api-docs/docs/update-custom-data-link.RequestSchema.json new file mode 100644 index 000000000..9d3666203 --- /dev/null +++ b/platform-api-docs/docs/update-custom-data-link.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Data-link update request.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New name for the data-link. Must be unique within the workspace or user context."},"description":{"type":"string","description":"Updated description for the data-link. Maximum length: 1000 characters."},"credentialsId":{"type":"string","description":"Updated credentials ID for accessing the data-link."}},"title":"DataLinkUpdateRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-custom-data-link.StatusCodes.json b/platform-api-docs/docs/update-custom-data-link.StatusCodes.json new file mode 100644 index 000000000..0f1a120b1 --- /dev/null +++ b/platform-api-docs/docs/update-custom-data-link.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success — Data-link updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Data-link string identifier. Generated based on provider, type, region, and resource path."},"name":{"type":"string","description":"Name of the data-link (e.g., bucket name)."},"description":{"type":"string","description":"Description of the data-link. Null for data-links auto-discovered from workspace credentials."},"resourceRef":{"type":"string","description":"Resource path for the data-link, including the URI scheme (e.g., `s3://my-bucket`, `gs://my-bucket`, `az://account.container`)."},"type":{"description":"Data-link type. Currently supports `bucket`.","type":"string","enum":["bucket"],"x-enum-varnames":["bucket"],"title":"DataLinkType"},"provider":{"description":"Cloud provider for the data-link. Supports `aws`, `google`, `azure`, `azure_entra`, `azure-cloud`, `seqeracompute`, and `s3`.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"},"region":{"type":"string","description":"Cloud region of the data-link (e.g., `us-east-1`, `europe-west1`). May be null for some providers."},"credentials":{"type":"array","items":{"required":["id","name","provider"],"type":"object","properties":{"id":{"type":"string","description":"Credentials string identifier."},"name":{"type":"string","description":"Name of the credentials."},"provider":{"description":"Credentials cloud provider.","type":"string","enum":["aws","google","azure","azure_entra","azure-cloud","seqeracompute","s3"],"title":"DataLinkProvider"}},"title":"DataLinkCredentials"},"description":"Array of credentials that can access this data-link. Empty for public data-links."},"publicAccessible":{"type":"boolean","description":"Whether the data-link is publicly accessible without credentials."},"hidden":{"type":"boolean","description":"Visibility status flag. If `true`, data-link is hidden from default list views."},"status":{"type":"string","readOnly":true,"allOf":[{"type":"string","readOnly":true,"enum":["VALID","INVALID"],"title":"DataLink.Status"}],"description":"Status of the data-link. Can be `VALID` or `INVALID`. Set to `INVALID` when associated credentials are deleted."},"message":{"type":"string","description":"Error message for invalid data-links. Null for valid data-links."}},"title":"DataLinkDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"404":{"description":"NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-custom-data-link.api.mdx b/platform-api-docs/docs/update-custom-data-link.api.mdx index 3c1e11b88..82865b88a 100644 --- a/platform-api-docs/docs/update-custom-data-link.api.mdx +++ b/platform-api-docs/docs/update-custom-data-link.api.mdx @@ -5,9 +5,9 @@ description: "Updates the data-link associated with the given `dataLinkId`. Allo sidebar_label: "Update data-link" hide_title: true hide_table_of_contents: true -api: eJzNWNtuGzcQ/RVinxJAku0mLVA91bGTQkBqG3KcPgRGRe9SEmPucsOLZVUQ0I/oF/ZLOjPcC7UrX1IEaF5sLTnLuZ05nNlN4vjCJuNPScYdHypZ3NrkepBkwqZGlk7qIhknVyXsCsvcUrBGjnFrdSphI2Mr6Za0u5B3omAzFHoPMpNsNmLHSumVZbnO5FymHM9kes4KnosBixQNGC+y+NTUiEwUTnJlR8kg0aUw9PYka2w68dbp/LRSB0IlN3CuEwad2iSoBIRbe0BEoksld8uk6+dp45t1RhYLJkn/XAqDBhjxxUuwKRk748UgselS5DwZbxK3LlFNeCvZbgeN5pU2t7bkqWhVf/HCrHu6f68FWeFzYWQaK2fnJMYVmtFTKwsnFsLA1lybnLuw9NNrMOQ6WC2se6OzNb7zkMee4skqadSTaji3cPgSL0tVpe7gs8U3N30z9M1nkTrMgcFUOSks7oZAdGPUdf9MrAgRDFzYxdmI/QZJZjeC+UKCcQQ2WZBQE10Gb3krDCOj78H+bUfDUwYEPGUxIPfawu9l7nOmRLFwyzE7Ojw8ZOkSUJci6EhvhFuE6nM1R6+xySkp52kqrEUk7pqBEEucdEpUOURwh3OmIYEgse0ilhZsqQsbMvPD4WEfEZeedLJ//vqbddGRfTtUyGcE5rFyZL+KAukA4nbDLfyFdIGGOxAxA4bnDgDLi4ZWwHHtDQAFC5+y9ExcIiaBrXap74UYLUYDduPTW+EIty+/HnGnEdK6GkbszCtFGGiJmXHv9DCTNtV3ArLK5kbnUQ3s8GVINvk8FfOnrZnGAeojf8BkkSqf1Vi8mk4Y5VrUwZjZV+ODg3w9DFGZwcrCdlf4n7ACqNa+cCOEEpeQxlmIXjDwYYrC/RE78caAl2rNrC9LbZxls0oBslbXSwF0ivdbEMG77X6Ia8M7bjBxdnezW1Qf8LgtoZew1bfvRGmfNdjbxxmXjZ18ZSkuWi+UCPHwpv3xB/hlePM4TPFofLTiC4A91XnpHYojoiHejzoMuuApqIIfdGL9Pyiqn4IevFliNfj8al9ILupQEMQWz8J6CFKQfrCcZt4OBbdueIQ+C4+EMVwBmR0BQIB513gJFHVdWA3Yq8PeI97IJG4Mx/tWOpHTesuKn5CHKiqIcnw9+AbsdRLR+Z524j8xULfCH0FlpD3dQej/jJk9F1dka49Ek2PMHvofX49uyR1LeVFdkPAsbVxxb/PSrQklpb+BOyoi0RA3Wj0Ot+uNirNwo7USvOj3Z0sBGejUNgO14SygI94cRy2K9q6Xr6XM4PkZ2j5KOEgqCV5Yx523bK74YsQmczbDqxwKZMeIcHC4EDIx5145piS0TXdSrILucM4+vBnBs/NCreu+lit1Pqf2+SnJGjcfj99PTmF/chZ+7UHA6DLo3/ami7Cx5wo8gQRDxc/ozBm2eLNKAUwVl3DxOt2usNUSArB/emDcwMFCwVyQUSyA9i1fPKP43hoDaitxApQs7riSWYyo9q7ube3F+6nT2J7Bzut9HdgbntVN3Fe0WzGp1e49yWMPxiE2m2IwrRrHxvBXfcPP6wGNFdoxjmMf2EPSr/vSZ9q9gzYgo05zp5GPM4cnzVFswI4vJgyaHw4FljXXbPPigMW9Uvve9xpDrEiRegMlTqX2RgBIzbGHsXT86RqrBMbYpcZRF5iVJlvcSg5adB1s2rl2S1Rs7urB1xsFwkvnSuzBeClHRNijQNcjqXtQv6QddqG4wzGShSsbgk4lW9t6ST0fOR5b3PiOGusZlQiOhGAl/HhXD6ifV44ChEmYthPq23uel4GPqwH6gcJsljvDVhN8HLbnmiyrclA5iB495TtGUgKbV8LUqKYEoN24xtEEDElFo/dc/9JugCGYlKDnaPTzj6NDuoG0dTkvIkfD+NZCuGvkpsXxd/JBpko5ztsHpYJOHh2jAG0qtO58Vhok4+g7DGBqCTFAmc0GR7gro7ZbXA7fRxDEdbUn4zmoFI8E5PlfT/YafSvWvW81wOUeJQn+MCxITo3CV5n1Yloxykv22DD7kFl1A1usY3tqc6Ngbq+xuYDLGVtBsDAInAQ7hjTDtAf0OBA/V4U3sCMq3aOyMTFdXH3Ayq6+LAGe8BXDV9gpwF+yVVNYQt+Na5tE8WLhiTGTcCTyAN+lkQ5txM3IbjQAOyTxQd+KYrttguPwGeOy3f4L4+tHFQ== +api: eJzNWNuOGzcS/ZUCn2Kg1TMTG3nQU8YzzkJAYg9m7OyDMViVuksSPWyyzYtkRWggH7FfuF+yKLJbaqk1Fy8CbJ6kJous26kbt8LjwonxZ1Gix5GS+sGJ+0yU5Aoray+NFmPxqS7RkwO/JNjRATpnComeSlhLv4y7C7kiDVMm+lXqh0k5zeFSKbN2UJlSzmWBfCeYOWisKIMeowxQl/1bC0slaS9RuVxkwtRk4+lJuZPpKjhvquuWnchEjRYr8mRZqa1gJmIs9vKITEhWqUa/FMd6Xu90c95KvQAZ+c8lWRbA0tcgLZVi7G2gTLhiSRWK8Vb4Tc1s0inRNNmO89rYB1djQXvWXwPZzYD3PztC0KEiK4s+c/gQyVCxGAO2UntakBWZmBtboU9LP70RTXOfpCbn35pyw2ce0zhEe0JLzXwKoz1pz4ewrlXrurMvjk9uh2KY2RcqPPvAsqu8JMe7yRDHNjpW/z2tIyJgbuwhznL4LTgPM4Kg5ddAEWxSR6KddcFYCI4sRKG/+Vw0RxyeEyDhqewD8qQs+E1WoQJFeuGXY7g4Pz+HYokWCwZd5NvDLUP1pZx7x2ByHZljUZBzjMRDMRhiwkuvqPUhgzvdc5scKBomOURsXHC10S555sfz8yEi7kLkCf/5899wjI7yr0OFfIFhngpH+AdpTgdUwgwdlWA01NasZEk2A743A0uLXVqx5EywBQEHfvTSC3HJmDTzo9T3A+WLPINZKB7IR9y++n7EXfeQdswhh/dBqYiBfWIGDN6MSukKsyJLJcytqXoxcJAvk7Ojzrc0f16a276BhsjPQOpChbLD4qfbCURfU2eMqXs9PjurNqNklWkG04U7XsE/xmdnWBQmaJ8zlFBqstNkvSTg4ymK93O4CtaS9moDLtS1sd7BtGXAWetYS9Kh4vqWSLi2fRvx2miFlh3nDjePg+ojX9dE9EZsDeW7UiaUO+ydyhl3Ozlx7aJdjFkoSvYIdv/nX6S9xd3nqOCr+dPRV7JYmKoOnskZ0VP3+kmFce1EJhIrkYl4Y/ebGHVfiQ9Xlj4b/n59yiQ3nSkixBYvwnoyUqJ+NJymwY0InR9dsM4UOGGM1uT8xfQVZ94NFwHdxYUzFe3MPki8PZHQWuR6Kz1VcX2fFT9zHmpTQc/H99lfkL2ueun8RDvxP2Wg4wh/ApU97sUBQv/PmDlRuHqyDpKouGTvsf798uiX6KFA3RZI8Evp+hH3rqr9JqKkDjMli14STXaLq5epus5U3wszYxShHvZnS/JLOoptkK7loDZdsZ6p1KKY4Af+WsqyJP0Cbr9LJ2dSSb8B59EHB3OFixwmc5hyKZ9mh0Kki1NBKGmOQXlQ0nlYSVon3umeU3izhOUHrTZdX4tKfZjH9vk5yg43v1/+OrkWmZi8T/9OICC/S/ybwXSRNk6UwCvUHPHTeOeUW7xpy2Cawx158Ga/Ausl6UemB0BLUJIiT2W0RUXO4eIFwffOWmOhJY+AknqFSpZ9RO1r9WDrJN6vveH2rMnEm1Md2FssuybuO9qtflLr1Hs2jz1qh77Y0Qa3beO4E/z1UPAP3YAG2nhAHvuoFJH6zZD6vfG/mKDL2GkeNPJ9z/FNcybL4PJmAqV0OFPc+rRldncwg36vtD/3d7UhRyQVwUq/iaH2ltCSvQx+Kcaf7zlKKvJLw6NuHSJXnljH4myPrrPtfq5tYiq2q27wDVaJsVh6X3MPhrXMY8LOU7rOpRlA/S7uwI1Cz2MkpJJ9eTOJIdvJehd7vqh4X+Kd7syxm1FjgotEImv//NINqF/WPhqInXC7n1DffcOqTvm4HaAfCczd8tGwtTM+D9tzEyVrfdAqyBo9pztbUhbkWuLYqBYRQId27VuTKpQqjt5z8/N+o8kEOyXxucgvzn/Mz2MJMs5XqHuapvltj+FjKbd7IP9NXmRan/PAfVYrlJoVixbatnA9eFfKxLj3EHOfiaVxnmm2W57hPlnVNLycHkgYxV24i/EclaMnDPLy55OTQj/QZvBYs0IVmDLif4VWYuwUvkusH27blPIKnnlcOilW18HqTV+eTtyeMZt77i4IYy/4edsSXCU5RnGI2V8wSIL8XpVOcEtU+ydp+5np5tNHDu32aakyJR+xuOZWAddJVhPNkhpvXtsKhXoRYsoU6UpOBHiYR47yRr8bObTGdpsoPpoH0k2zM47nb7ZL0/wXe9hHOg== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the data-link associated with the given `dataLinkId`. Allows modificatio id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-data-studio-checkpoint.ParamsDetails.json b/platform-api-docs/docs/update-data-studio-checkpoint.ParamsDetails.json new file mode 100644 index 000000000..f05dd488c --- /dev/null +++ b/platform-api-docs/docs/update-data-studio-checkpoint.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"sessionId","in":"path","description":"Studio session string identifier.","required":true,"schema":{"type":"string"}},{"name":"checkpointId","in":"path","description":"Checkpoint numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the checkpoint is updated in the user context.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-data-studio-checkpoint.RequestSchema.json b/platform-api-docs/docs/update-data-studio-checkpoint.RequestSchema.json new file mode 100644 index 000000000..86a05187f --- /dev/null +++ b/platform-api-docs/docs/update-data-studio-checkpoint.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New checkpoint name. Must be unique per Studio. Spaces are automatically converted to underscores."}},"title":"DataStudioCheckpointUpdateRequest"}}},"required":true,"description":"Checkpoint update request for modifying the checkpoint name."}} diff --git a/platform-api-docs/docs/update-data-studio-checkpoint.StatusCodes.json b/platform-api-docs/docs/update-data-studio-checkpoint.StatusCodes.json new file mode 100644 index 000000000..d2a74f062 --- /dev/null +++ b/platform-api-docs/docs/update-data-studio-checkpoint.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["author","dateCreated","dateSaved","id","name","path","status"],"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Checkpoint numeric identifier."},"name":{"type":"string","description":"Checkpoint name."},"dateCreated":{"type":"string","format":"date-time"},"dateSaved":{"type":"string","format":"date-time"},"author":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"path":{"type":"string"},"status":{"description":"Checkpoint status.","type":"string","enum":["empty","interim","finalized","invalid"],"x-enum-varnames":["empty","interim","finalized","invalid"],"title":"StudioCheckpointStatus"}},"title":"DataStudioCheckpointDto"}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed."},"404":{"description":"NotFound, when the studio or the checkpoint is not found or when the API is disabled for the workspace","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"409":{"description":"Conflict, when the checkpoint name conflicts with an existing checkpoint for the same Studio.","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx b/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx index 17ce60506..c6c6ac7e1 100644 --- a/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx +++ b/platform-api-docs/docs/update-data-studio-checkpoint.api.mdx @@ -5,9 +5,9 @@ description: "Updates the name of the given Studio checkpoint ID. Append `?works sidebar_label: "Update Studio checkpoint name" hide_title: true hide_table_of_contents: true -api: eJzNV21PIzcQ/iuWP7VSSGhLK12kquXlTkJVKSKg+4CQzuxOEsPGXmxvQi7a/94Z27txki0E1Kr3BbK7M/Yzz4yfGa+4ExPLh7fcuiqX2vK7Hs/BZkaWTmrFh/ymzIUDy9wUmBIzYHrsf0/kHBQbeTeWTSF7LLVUjp2f9dlxWYLK2ZffFto82lJkcJ7/+oU5zSq/GhOph1T43FqyTCsHz67Pe1yXYAThOM9bJGfCibDrabsEmpbCIDgHhqJZcUKKLhasDe49LimaUrgp3w4xBhGNmXVGqgmTOSgnxxIMQTHwVEkDiMOZCnrcYgAzwYcr7pal38p78brutbuvY3wFwDoSpqoZGJm9dXd0hQkYNB1rMxMuvPrlaANPko0GzlMFZrmD53ObjA447PMUE69n0jnIe74W0mTamOOc8kofKwsmTepbsN+F0MG6E50vyccvhBnHn6IsC5n5+hg8WAK+2l1c3z9A5gvEUDU5CZa+Bka2k7fNwwUs0tjIqc/+rKxj9xiXkoiM4aLxFPTZiDizTBis8MppjAXxFcWSwp/j5kgKnQGVY5lm2oDtU364k64gFF2lHYr+KpCA1vVuMfxjLcXDFhlkyC6b6VyOl1TeW3nzsXG/ui21soGmHw8P6d/mDn/9gUTtnYc12luOpEw1JZpwnRqgMolPIzH3vyX98dnpNWfFOuEqr0wv5xRd9yiqN569urdnrZx2cJmG2bFAi4zsDpzEbeqUjb1dIq/bbM+xnogBzIQsGm7pOF5QRP8Sn3Wy5K4aNpt3fYn4uiS0PRI3uPS5Gmuy9+XQtVAskJ1CTVISTEh+thkFzDqxBbPSLb0sYhORMwpUKlHIr6Es1Rx/50Ta8wG5HMyFoTzbN/k2YW2f8lGI4DUxOHOaJACtjroO5onIG6F45wHFeKyY7FEbjeGLyftojDZXUU9a4D91KErT55nSjqFi6gXk/gQdHR7tml9o90mjivbYgloRKVkYXxgq3G4/ojXHZE+fW4/jy3P6mEsr7gsU5nH0bZvkt8zhh45i12qMCF1Cypa8UxfyJpYtpJsyoRg8S+uoGySmDRGWXGJn+1a5oMMPWWUkHj8a+04Ae685rkgobu9ofMCZcKppeiwr17SUIR/EcXewaifEerDmAN+ns1tNTQjMvBkuK4OCxqfOlXY4GIhS9rNCV3nfwhPWcV/q3QnTf2GXhXAkn+yU7KkEOWFsQhgRh4GPNJCWEtqxGaDo+d4b4Zvw41MjzA8L53mj3Fytx6ePz2JWFrAefxIJlaSxtFMjUAEwIXwtFmJG0tgTjKlORObrZJOnlJ3YFPy2v68/IBAiOezzQ//Dz/1DL/zauplQCfAwFXXcPuLksIE4GRr/19tMzCI9DspC4PxNvdP45hjqcn0N6/FhendJSpM+bVwssICmSBB5r1b3wsKNKeqaXofhniq2UTk+HIvCbs+MKUH/6ejfycAjLHfuJtgwK7L0xwM7rST0b4zku6soRN+zfS54ndjiS6GWKagG8zpDdMl6F7JXb37vgLVRHfUd2k9B4JXD8xdMTgOWg2taaL3EjrBTXMHjOMugdC/apmp7eXNNuhQvbXjrIBcjFnSXxb8erfbUeLnz71a8EGpS+TbAw5J1HG4TEdwSPR9UJx94GLzFtX4EVdctPY6eiZe6/hvDl+vd +api: eJzNV21v4zYM/iuCPm2Am/RuxYAFGLa+3AHFsK5oWtyHosCxFpOotSVXopPmAv/3gZLtOInXpsWG3ZfEtkjp4UPqEbWSBFMvR7fSU6m09fIukQp96nRB2ho5kjeFAkIvaIbCQI7CTsLzVM/RiHFwE+kM08fCakPi/GwgjosCjRJff1tY9+gLSPFc/fpVkBVlmE1A10MbAaK1FKk1hM80kIm0BTpgHOeqRXIGBHHV03YKmcgCHORI6DialWSkciQ9eh/dE6k5mgJoJrdDrIOojYUnp81UaIWG9ESjYygOn0rtUMkRuRIT6dMZ5iBHK0nLIiwVvGRVJe3q6xhfAbCORJgyR6fTt66uDeEUnUzkxLocKH76+WgDTycbDZynEt1yB8+XNhk9cMSXGRphc02EKgm10E2mr3OsOK88WHp03aS+BftdDB09nVi1ZJ8wkSF+hKLIdBrqY/jgGfhqd3J7/4BpKBDH1UQaPY9GRraTt83DBS66sbHTQPxZehL3KEqjn0oUBbp6FwzEmDnzAhwKKMnmQDqFLFty+HN0TArvAaPQ+dQ69APOjyRNGaPoK+1Y9FeRBFmx+XYx/GMt1ZutZlBMrBO5VXqy5PLeyluITYbZfWGNjzR9PDzkv80V/vpDJvvnYY32VkJJM8uJZlynDrlM6rcxzMOz5p+QnaTZK56AyqBML+dUq32K6o17r0r2rJXTHi67YfZM0CJjuwPSOTZOkY29XWpet9meAwEzgDnorOGWt+MFR/Qv8Vl1ptxVw2bxvpEaX5+EtlvixqM7NxPL9qEc+iaqC2SnUDspiSYsP9uMoilzZgvzgpZBFgmdzjlQbSDT32JZmjlkWjFpzwfscjAHx3n2b/Jtwtre5eMYwWticEaWJaBK5FHfxjwB1QjFOzdojt7DdI/aaAxfTN4n56y7qvWkBf5Tj6I057wwlgRkmV2gCjvo6PBo1/zC0mdbGpWIBR9FrGSxfRHW9ZxHPOeE7Xm49Ti+POdBpT3cZ6iCOvL39pD8njn8pafYrZlkOqUOKVvyzqdQMPFioWkmwAh81p74NOiYNkR4dqlPtu+VC978mJZO0zK0fScIDt1xyUJxe8ftQ440s9w9FiU1R8pIDut2d7hqO8RquObAD1fd3q3iQwjdvGkuS5fJkZwRFX40HEKhB2lmSzXw+IQOBtrudphhRFxmQCyf4pTtuQQlY2xCGDOHkY9uIC0lvGLTQPH7fTCSSf3wuRHmhwUF3jg3V+v26dMz5EWG6/anI6GaNZZXagQqAmaEr8XCzGhue6Ix1wmkoU42eeqyUx8KYdnf1wNVIpnkuM6HwYfDj4PDoPzWUw6mgzy2RT3Xj7p12IDc6Rr/1+tMnUZ+HRYZaBMOTxdOx1iY63tYIkfdy0unNnlo42Zxl8iZ9cTeq9U9eLxxWVXx59jdc8k2MidHE8j8dtPYJeg/7f17GXjE5c7lZA5ZyZZhf8zBaUb/xkh+uKqV6Eexzw2vF1v9EcyyC6rBvM4Q37LehezVq987YG1UR3VXJXKGoNAF/qLJacRycM0TrafYUXaOK3ocpykW9KJtV24vb65ZmOpbW24VuzhY8GUWFhGtDdQEvQvfVjIDMy3DOSDjlFXd3XZUcEv1QlC9fKxW0eLaPqKpqpYe4nfmpar+Bs8K7AI= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the name of the given Studio checkpoint ID. Append `?workspaceId=` to up id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-data-studios-workspace-settings.ParamsDetails.json b/platform-api-docs/docs/update-data-studios-workspace-settings.ParamsDetails.json new file mode 100644 index 000000000..e75286b91 --- /dev/null +++ b/platform-api-docs/docs/update-data-studios-workspace-settings.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-data-studios-workspace-settings.RequestSchema.json b/platform-api-docs/docs/update-data-studios-workspace-settings.RequestSchema.json new file mode 100644 index 000000000..80a21e55b --- /dev/null +++ b/platform-api-docs/docs/update-data-studios-workspace-settings.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Workspace update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"description":{"type":"string"},"visibility":{"type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"}},"title":"UpdateWorkspaceRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-data-studios-workspace-settings.StatusCodes.json b/platform-api-docs/docs/update-data-studios-workspace-settings.StatusCodes.json new file mode 100644 index 000000000..4a093faaa --- /dev/null +++ b/platform-api-docs/docs/update-data-studios-workspace-settings.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"UpdateDataStudiosWorkspaceSettings 200 response","content":{"application/json":{"schema":{"type":"object"}}}},"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx b/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx index c5e4f611d..b7adc7f12 100644 --- a/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx +++ b/platform-api-docs/docs/update-data-studios-workspace-settings.api.mdx @@ -5,9 +5,9 @@ description: "Updates the Studios settings of the workspace identified by the gi sidebar_label: "Update workspace Studios settings" hide_title: true hide_table_of_contents: true -api: eJzNVt9P2zAQ/lcsP21S13Qbm0SfVgbT0KSBWmAPCAk3ubYGJ/ZsB+ii/O+7c36WdiChTdpLlJzPd999d/nsgnuxdHx8ye+1vXVGxOD41YAn4GIrjZc642N+bhLhwTG/AjbzeSK1Yw68l9nSMb0I9nY/kwlkXi4kJGy+DmtLeQcZu25djpPrIR9wbcAKSnGctEkOhRd1ih+N+6xOhVuMsCIFD5YwFzzDD9yq7RJDDLgksEb4FX9cwYldikz+CtlYlqdgZdwBtehv4WcuLSASb3MYcBevIBV8XHC/NpREZh6WwXWhbSp8Zfq4x8ty0CLplfgknra2vw/mqtoOzh/oZE17/pQ6D4yz2htjxRrDZp72CGOUjANf0Y2jjcU2Cj2/gZg2Gku99BKHZ9xw0Xo5b7F7vESsuVLf/7S4gXLH+p10ci6V9Ovt5QEH5JHG+HR6fDE5O0LL7OtkenRIw+ylV+R80UXAnrXmavBaWqY1HSX5bDYiGJzRmasKfTcabfP7/Bwz3MeaQC+nvQwI3432tjGcfGNv2HfNmsjot7cL64FIXtL+jpVLnoJzYgmB5yenonHc7m2vF0fWajttqKkq3Bu931Fhox0s054JpfQ94gne+9veh3lVDjBQkFKN/2m1uOggzm2YchS4AxAW7CRHCRlfXtG/jeq30qSXJg9ZSV3GPEIJdFERhLCMOi2Pip4ilVEj2pGrRpNTOnvXyGluFcZaeW/cOIqEkcNY6TwZOviJbA+l3tKxWVhhp0p4EiL2mfzZ5PSYE9amlBlxWfHSL6ilhjLyWuXoex6c0FK9fGkk7ubeB/6oR9NO444eRGoUdNLTyUKnOJ1ts4LW3NeXVkZKEvGFDljrptUlU43PsUHcSuxC7UwTJ+IwcZtM9/nFoZMqyPlCf+oWSACxTVWet8P9D8MR2Yx2PhVZr/RKfnrH8eMD+zHqovsT/tVBX7fZw4OPjBJ4LCL0QEFRD/AlneEEbdyc5b37CFo3z9VeKc0g47StkAuKVBRz4eDcqrIkM46JpZ8JX++ElWJOXcRhT6Sjd/yVFkI5eIKVV9NaAV6z5+8RO2utjSJb06AJldMXvt7Cur2+0C3iRZieuUu8AFCf7fIK3VcgEgxGtFUenysgb84oThdhS0ipqGrHJI7B+Cd9++p2en5G/399g0l1QlusuKfLET4DWB14CbISbAVXIlvmQXZ5FZLUQmyKzSNxCUXtpAPnKHic6VvIcJYadjx9Ey9l+RvNFelb +api: eJzNVt9v2zYQ/leIe9oA1nKzYMD0NKfJMGNAGzhJ92AYKC2dZSYSqZBUXFfg/z4c9dOxmwBBC+zNOh553/fd+SNrcCKzEC9hp82DLUWCFlYcUrSJkaWTWkEMd2UqHFrmtshuXJVKbZlF56TKLNObEO/3M5micnIjMWXrfVjL5BMq9qVPmadfJsBBl2gElZinfZFL4URb4t8u/aYtBRxKYUSBDg1hrkGJAiEGbbJ5ChwkgS2F28JzBp9MJpT8FqoxVRVoZDIANcDB4GMlDaYQO1MhB5tssRAQ1+D2JRWRymEWUjfaFMI1od/PwXveIxlRfBFPz+3Hg1k129G6C53uac/3SldBcdZmA4dEK4fK0R5RlrlMgl7RvaWN9TEKvb7HhDaWhnrpJFpabbTos6wzUmXgOWyqPP/4vcUDlCfWn6SVa5lLtz9e5oCqKmiMrxfzz7PbK+Bw8/dscXVJw+ykyyn583CC90O4GbxelkUrh6ecw0aEgC21sg3Rs+n0WN/X55idTaesO+jtsvuA8Gx6fozh0z/sHfuoWXey53B+CuuFSN/S/kGVJRRorcgw6PziVHSJx70d9eLKGG0WnTQNw/PpbycYdt7BlHZM5LneYdrw/OM4+7Jq6CDDHAvi+D9l6zlYTCoTpnxZwwUKg2ZWuS3EyxX9twt0W01+WVahKrlLDJE2mY3qYIQ+Grw8qkeO5KPOtCPbjCZQOfPU2Wllcohh61xp4ygSpZwkua7SicVHNGIi9ZGP3YQVdp0LR0bEPlA+m13PgbB2VG5Iy0aXMaFeGqoIrcvR9zokAW9//NVZ3P3OBf2oR4vB466+iqLMcbCewRYGxxlihwz68NhfehvxZOIbHbC2TWspE8fX1CBtZYK2TaaJE0mYuEOlx/piIWQe7Hyj/xwWyADR2KbO+8n76dlkSsFSW1cINeLe+M/oPn5+Yz+HXQ9/hZ9107d9dvjVRWUupCLoQYO6neAlXeIELe4u89GDhEN8eLGOqHSTvOKw1dbRSXW9FhbvTO49hR8rNPRvWnF4EkaKNbVxWUMqLf1OId6I3OILqvyyaC3gV/b6Q+Ik1zYo1J4mTeQVfQGHB9z37xd6RrwJ0yuPiTcAGqvtV57DFkWKJsjWZHxogLy7pXOGE46clEg1O2ZJgqV7MXdsb9d3t2QA7ROm0CltMWJHryOxa8DqoEvwlRCrIRcqq4LvQnMk2YU4dJtn7hJInZSjrpuMW/2AyvteHUffpIv3/wEC/umA sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the Studios settings of the workspace identified by the given `workspace id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-dataset-v-2.ParamsDetails.json b/platform-api-docs/docs/update-dataset-v-2.ParamsDetails.json new file mode 100644 index 000000000..3bbd1a82a --- /dev/null +++ b/platform-api-docs/docs/update-dataset-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier.","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/update-dataset-v-2.RequestSchema.json b/platform-api-docs/docs/update-dataset-v-2.RequestSchema.json new file mode 100644 index 000000000..13a743c69 --- /dev/null +++ b/platform-api-docs/docs/update-dataset-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Dataset update request.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"title":"UpdateDatasetRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-dataset-v-2.StatusCodes.json b/platform-api-docs/docs/update-dataset-v-2.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/update-dataset-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-dataset-v-2.api.mdx b/platform-api-docs/docs/update-dataset-v-2.api.mdx index ddaca6db3..8f2ac0c30 100644 --- a/platform-api-docs/docs/update-dataset-v-2.api.mdx +++ b/platform-api-docs/docs/update-dataset-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Updates the name and description of the dataset identified by the sidebar_label: "Update dataset" hide_title: true hide_table_of_contents: true -api: eJzNVdFO2zAU/RXLT5tU2o6xSfRpwJiEJm2og+0BVcJNbluDYxvbaYmi/Pt87aQpSVXEw6S9IGof555z7HNvSR1bWjq5oylzzIKzdDagKdjEcO24knRCb7XfA0vcCohkGRAmU7IDIWoR9uovEJ6CdHzBISXzIuws+Rokua8BV+n9kA6o0mAYnr9Kt0W+RsTvY7+vmfHFHBikV1Ks7HEbZR6tZgn4UwPKkd9TDqagXdZ/GiCReQaGJy0vg+VtsoKM0UlJXaHxy1w6WILxWwtlMubi0ucTWlWDbfmthKa4Zm7Vq13LINYZLpedwgaecm7Ai3Ymhz1E4ilfdhbBYN25SgtE7C+TB+9IjcUaifJipMMjTGvBk2D06MHiubJfUs0fIHFousFrcRws7kbRPWIduX3iA+q4E9C91mkk6AFV14awYLWSNlY+Hp/09f78To7ID0Uadf7QyXjcx52ztDHjLV60jO5oBtayJWAYDlvUAA+6cGmMMtNaH8oPzD/uUdhkgkjlCBNCbTyfgD7dc/95lAMEBGSo8T9V6zctJLnhrghZPgdmwJzlPjqTuxm+cx/0lcI+oPNQFVM1oaOmKY3KbfAqzC6YddMXciM8cuWctpPRiGk+TITK06GFJ+/lkKteOn+FHXItmMOkkwvEk7PrK4pMGqK/0KmoepfuVjhWbNoI/p4HkF+J/3xresjDxgV38AambZovn1mmBbQpa5zssm1Dx+VCBQK1z7UOJP6aRDSMJ76HRzA+EpaER/LSvl3T/DvhIjTBhfrSbngi6H2s82F4+mk4xjWtrMuY3NETo99MhS7Fsn2p/2rA1Bfl4NmNtGC+XXueQW9ZP7CdqTegk7a3+2ew8noQUJZzv3hrRFXhcpw1+O5SbtlcYH4WTFg4IO+1SbSX5yMUvWm3ZiJHZHina2Y4EngjmXfTOvfvycEptZdUvchkscumIdv6V808eAUs9YFAenH/IpI4usGvtOd7bQrHbTxxliSg3UHsbu+4vr3B/NWzMlMpHjFsg0PX/w1UVfAkxDqslVQwucxDU6Pxk5hW9jLsnXAHUXvN8M8lIG7UI8iq2nrj8Df6UlV/ATfpRbU= +api: eJzNVcFu2zgQ/RViTi2g2m4aLFCdNul2gWCBbpAm3UNgIGNpbDORSIUcxTUE/XsxpGQ5luGihwJ7s8lHzXuPfDMNMK48pPeQI6Mn9jBPICefOV2xtgZSuKtyZPKK16QMlqTQ5GoPouwy7HVfUDonw3qpKVeLbdhZ6Rcy6qEDXOUPE0jAVuRQzl/luyJ/RcS3M0igQoclMTmh14BUhhQ21j35CjO6yiEBLfyea3JbOGT9Xw9Upi7J6Wzg5aS8z9ZUIqQN8LaSL2vDtCIHCSytK5Hj0h/n0LbJrvxOQl+8Ql6PancylGenzeqgsKPnWjvKIWVX0xEi8RS07TyCyfOlzbeCOF6mDt6pDis1MmuYDMsRrKpCZ8Ho6aOXc824pF08UsZiupNrYU1edqPoEbEDuWPiCbDmgg6v9SYShFYQr20IC76yxsfKZ7Pzsd5//1Hv1BerenVtAuez2Rh3iXlvxq94MTC6h5K8xxVJGE5b1ANPuvDZOetuOn0iPzD/cERhnwllLCssCruhPOr8eOT+6yiHFBVUisb/qdo2AU9Z7TRvQ5YvCR25i5rXkN7P5Z2XxGsrfaCqQ1VJVQrTvilNm13wWskuuZe+L9SugBTWzJVPp1Os9CQrbJ1PPD2Tw4m2o3R+DTvqukCWpKtPglcX11cgTHqiX8WpqHqf7k64VOzbiPxfBBAk3Y+/+x7yuOHgjtzAzZDmz9+xrAoaUtY7ech2CJ02SxsIdD53OoT4zySKYToj34HlkWAWHslr+/ZNoxJ1EZrg0v45bLQJiPexzvvJ+9nZZCaLlfVcotkTFLPfj4VDjs3wVH/XhOluiuk7T6sCtRGeQXDTvbC9sZdAOjT3eQJr61kATbNAT3euaFtZjsNGHl6uPS4KCdASC08n5P1sFB3l+UTb0bh7waIWZHioL+i0EPhFMm9uuuC/VSfH1FFS3SKa7T6bnuzgXztvE1gT5uQCvbj/KZJ4dytfGc6P+pTM23jiIsuo4pPY/eZxfXcrAeyGZWlzOeJwI1MXN5GqDZ6EXIe1Bgo0qzp0NYiflLji67QfpDuIOmpG00TErX0i07Y7b1j+iy9t+wPcP0Xa sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the name and description of the dataset identified by the given `dataset id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-dataset.ParamsDetails.json b/platform-api-docs/docs/update-dataset.ParamsDetails.json new file mode 100644 index 000000000..cba1d0d1d --- /dev/null +++ b/platform-api-docs/docs/update-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier","required":true,"schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/update-dataset.RequestSchema.json b/platform-api-docs/docs/update-dataset.RequestSchema.json new file mode 100644 index 000000000..eadcf2eca --- /dev/null +++ b/platform-api-docs/docs/update-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Dataset update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"title":"UpdateDatasetRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-dataset.StatusCodes.json b/platform-api-docs/docs/update-dataset.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/update-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-dataset.api.mdx b/platform-api-docs/docs/update-dataset.api.mdx index c42b8f053..945d44545 100644 --- a/platform-api-docs/docs/update-dataset.api.mdx +++ b/platform-api-docs/docs/update-dataset.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [Update dataset](https://docs.s sidebar_label: "(Deprecated) Update dataset" hide_title: true hide_table_of_contents: true -api: eJzdVslu2zAQ/RWCpySwrbRNC9SnJl2AoEAbZEEProHS0thmIpEsSSU1BP17Z0gt3uCiORW9GBI5o3nvcebRFfdi4fh4wjPhhQPv+HTAM3CplcZLrfiYn5zcLqVjoDKjpfIMnzMwFlLhIRuxGwA2uTOYD6z5yPRo6b1x4yTJdOpGDn6CFSOpE5MLP9e2GAojkzLkDJuc4ePw5THDTeaXwNLSWsBabdHRycl39V3FMi6EZOCFzB3T8/gaP8NkhnlyLiFjs1XYWchHUOxHE3CZ/RjxAdcGIRHBywwpxu9+iBG4a4QVBXiwJE3FFb5g1JO2D86IFDBnwCVpY4Rf8m3BvrVxTJUFWJn2oCwGW/hZSgtY19sSBtylSygEH1fcrwzVQb6wCKGklfBx6c0Zr+tBB6ajcxBKQ4k5b6Va/CWOmIRVpzEYnL/Q2Yoi9leJJ8qaWCyRaqSiPGUIY3KZBsmTe0dp1W5FPbuHNByApQPyEhztRso7uLbI7uIecC99DtsHfN3gqyliU4Ww4IxWLlZ+eXq2S/frZzZkXzRr2WHS2enpbtyFyJ6jRY9owgtwTiyAhvKwRG3gQRU+WqvtdcOP6Afkr/YwbKeDKe2ZyHP9hHhC9Ns9x19GOsAgh4I4/qNsQ8e0ztW1PaDZSL8Kk34BwoI9L3GUxpMpNT7awFKTR5gyOgNt8aTzApdUa75QJ62PJlU3oTWnKvaxtZPS5viJ1iLRCkdprsus98mdMb4JO+yqsU/2nuLZ+dUlJ4gtgxsSNQq0zqPTiCryZs7pfRaCcCU+fGrN5v7JByHpsK77uf/4SxQmh34gW9G30fbzKdVcBwDNkTQ8CPifKJJgEuVtgqmfRBr6aVO+ddGwpWQe3HKu3/UbCIS0j3VejN6+Hp3SmtHOF0Kt8Tn60HXHMdu80rbxVn2H/58XZNMzHn55QoVXDEoWpK+aIZj0F6LDhPHm9dj9n8Cd/q7Cbl2i7JRcVTNcvLN5XdMytpmlGcTHR2GlmFHD4LBk0tEzTuBc5A4OHMPRdWMlx+wPN/Bebs2iUCtOEPKS3vDxAVZbdz/dws+Cdeg2fgamXtZ6isFLEBl+ikSL++8jhuEtfaXP3/Fj4hMzztMUjD8Yu26JV3e35B7Nf4JCZ5RixRP9ucDfAFUHSYIphbWK50ItyuDePH6SvEZsWtWWNQVSe8XALgoRt/oBVF132nh6J13q+jfCrsqM +api: eJzdVttu2zgQ/RVinpJAttxssMDqaZO2CwQL7Aa5YB9cA6XFsc1EIhmSimsI+vdiSF18g4vNU9E3kZzhnHPIOVQNni8dZFMQ3HOH3sEsAYEut9J4qRVkcHHxuJKOoRJGS+WZdEygsZhzj2LMHhDZ9MkI7pG1m8zOVt4bl6Wp0LkbO3xFy8dSp6bgfqFtOeJGplXIGbU5o7fR5TlbaMv8ClleWYvK90XHFxdf1BcVy7gQItBzWTimF3EYt2FSoPJyIVGw+SasLOUbKva1DbgVX8eQgDZoORG8FZBB3PdTjIAEDLe8RI+WpKlB8RIhg7W2L87wHG8FJCBJG8P9CvYF+6+LY6oq0cp8AGUhAYuvlbQoIPO2wgRcvsKSQ1aD3xiqI5XHZQglrbiPU79fQdMkPZiezkkoLSXmvJVq+T9xxCRomlkMRudvtNhQxPEq8URZGwsJ5Fp5VJ4yuDGFzIPk6bOjtPqwop4/Yx4OwNIBeYmOViPlA1x7ZA9xJ+ClL3D/gO9bfA1F7KoQJpzRysXKl5OrQ7r//s1G7B/NOnZNAleTyWHcDRfv0WJANIUSneNLpKY8LVEXeFKFz9Zqe9/yI/oB+W9HGHbdwZT2jBeFXqOIPP84cvxVpIMMCyyJ40/KNtyYzrn6a495ZaXfhE6/QW7RXld+Bdl0Rhe/RL/S5BGmis5AS5D2XuDSessXmrTz0bTuO7QBqmLfOjupbAEZdBbJjRznha7E4JMHbfwQVthda5/sI8Wz67tbIIgdgwcSNQq0zaPXiCpC2+c0nocgSNqPvzqzeV77ICQd1v3Q95+/8dIUODRkJ/o+2qE/pVroAKA9kpYHAf8RRRJM5ujaYLpPPA/3aVe+bdGw5LIIbrnQfw4LTQKkfazzYfxhcjme0KTRzpdcbRE6+9Rfj3O2+6btA66HK/5rvpDtpfH4zRMqqUiyoH3ddsF0eBEdJJDtvo/9D0UC2fBYzRJYaecpua7n3OGTLZqGpl8rtNSEswTeuJV8TjdmWoOQjr4FZAteODxxDGf3rZecsx88wUe5tZNcbYAgFBWNIIEX3Ow9/vQMvwvWqef4HZgGWZtZk8AKuUAbRIvrHyOG0SPtMuQfGDLxiRnXeY7Gn4zd9sS7p0eyj/anoNSCUixf098FX0eoOkgSXCnM1VBwtayCfUPcksyG73rVnjcFUkfFqOsY8ahfUDVNr42nMenSNN8BxHrKsQ== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Updates the details of the dataset identified by the given `datasetId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-label.ParamsDetails.json b/platform-api-docs/docs/update-label.ParamsDetails.json new file mode 100644 index 000000000..2c8c963fc --- /dev/null +++ b/platform-api-docs/docs/update-label.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"labelId","in":"path","description":"Label numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-label.RequestSchema.json b/platform-api-docs/docs/update-label.RequestSchema.json new file mode 100644 index 000000000..bbd3d35ca --- /dev/null +++ b/platform-api-docs/docs/update-label.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Label update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"UpdateLabelRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-label.StatusCodes.json b/platform-api-docs/docs/update-label.StatusCodes.json new file mode 100644 index 000000000..dc46c908d --- /dev/null +++ b/platform-api-docs/docs/update-label.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"isDefault":{"type":"boolean"}},"title":"UpdateLabelResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-label.api.mdx b/platform-api-docs/docs/update-label.api.mdx index 32fc0a264..b03ba325e 100644 --- a/platform-api-docs/docs/update-label.api.mdx +++ b/platform-api-docs/docs/update-label.api.mdx @@ -5,9 +5,9 @@ description: "Updates the label identified by the given `labelId`." sidebar_label: "Update label" hide_title: true hide_table_of_contents: true -api: eJy9Vm1r2zAQ/itGnzbIkm7rBsuntV0HZYOVvrAPJdCLfUnUypIqyUmD8X+fTrLjpDbpWsa+hOTu0em5516UkjmYWza+YQKmKCybDFiGNjVcO64kG7NrnYFDm7gFJgGT8Ayl4zOOWTJdB/ucL1Emt8F9lt0O2YApjQYoxFm2CfKT/N6nwUCODg1dXDLpf3hMfdr7Od2rwS3YUzIhQiKLHA1PWyLGAw0+FNygv82ZAgfMpgvMgY1L5taa4nPpcB6gM2VycNH0+ZBV1WBDYqXMvdWQYkvkoUCz7jD53QD72bzk9kkkj9Ydq2xNZ/qSLoKESY30cVLlQ0pHeNBa8DTIPbqzdKjsMlDTO0zpoDZUHMfRkjcmvkFZZ7ics2rAliCKfg+333AGhXBb3qlSAkGSmMxxJ3C36hc17Yr8u6UKBquVtJHQh4ODrga/fvy7jHn2V3UZ/DdpYvKkjUcc9qV/DNlrKt8KfcNytBbmSAO+X54G2E1vi/+pMcp0mH/sKVyzBxKpXAJCqJXnQ3CLaWG4W4cdcIxg0BwVfubHNxMaCb8gFop2hy4CR1oHYzaKa2pU1tuiollDs2x2SWGERy2c03Y8GoHmw1SoIhtafPA8hlx1BvkyeJJzAY46IDkhfHJ0fsaIRUPykjSN+mxT3UhENzZjH2oeQN4Sv3xveutu5ULyVKuLduhPHyHXAtt5bDTf9Fpr2Gqxeny4nKnApS5OnRLl8Fy2pB1P/XqPYOosSENn7Sq5rZ9vLi7CnMzU19ZBc+HLEO95P/zyaXhANq2sy0FupRZ7Pz4mTwmWbXO/9uWpK+Lw0Y20AL/DPYuQTVl30eaxG7Bx8+r4Wi88U3KW5RQsXhtRVWSO+5+aK+MWpoLGaQbC4h7qz7wOvRTvcd15gJrih15cguF0/wu5vLmot8DbZM/z2UupNoJcb3NpqDbSVRMPXSBkPhBRi96TSODdFcVoT3cWFj2+8cRRmqJ2e7Hbe+H8+ormq34yc5XREQMr+i/gPwNRFfQIYxtspSct50VYbyyGpGmE3WF+MrwhqV4pfKcExJW6R1lVG2Uc/SZdquoPqVc5iA== +api: eJy9Vttu2zAM/RWDTxvgJd0Fe/DT2l2AYgNWdC32UAQoYzOJWllSJbpZYPjfB0p2nDZBd8Gwt4SkpMNDHtItMC4DFFegcU46wCyHikLplWNlDRRw6SpkChmvKIsxmarIsFooqrL5JtqX6p5Mdh3dp9X1BHKwjjzKFafV9pIv4occHHqsicnLwy0YrAkK6E9DDkredcgreAwm3pCZpiavyhGIhxw83TXKUwUF+4ZyCOWKaoSiBd44uV8ZpmUMXVhfIyfT2zfQdfkWxNr62+CwpBHIXUN+s4fk+xB4GM2fvD5L4Cnwia02cuZQ0k2kMOsjIYfSGibDEo/OaVVGuqc3QQ61+wjs/IZKOei8FIcVBfGmxLdRgb0yS+hyuEfdHPao8IEW2Gje8c6t1YRGyARWrOlh1c972J34H5YqGoKzJiRAr46O9jn4+vnfZayq36pL/t+oSckLN10Obw6lf4LV31R+JPoKagoBlyQCf5qeIXA/vR38H723fg/56wOFG+ZAZixnqLVdUxWvClQ2XvEmzoATQk/+uOEVFFczkURNvLIyO1wTMco4KGCaxtS07adFJ1ojfz/MksZrKGDF7EIxnaJTk1LbppoEuiOPE2X3hPwterIzjSwdkL2X+Oz47BQExQDym3Ca+NmFuqVIXhxkH2segyDvf3waeutmzTF5qdX5KPqPP7B2mkY9Dpxve2007LRYLx9lFjZi6YvTpyQ5/Cpb4U6VFPpg6SwsY2c9ZHKXP6pR6aiThX03OkQX5EN65+Xk5dGryZEYnQ1co9nJLTV/2iaPEbZjd//t6ulLwvSDp06jMoIiptP2bbTddjkUw9qZ5bCygcXZtnMMdOl114k5LQDprkoFnGvR0wJ1oCeg/2I9HIR4S5u9DTRUPzbjPXol7/8hlmfn/Rh4nj2xPw9C6o1oNrtYBqgDdd2sy2FFWJGP0JL3fQLw4kLuGE/vTSzZvunEcVmS4ydjdwfD2eWFCKzfmbWt5IjHtXwM4DoBtZGPqNtoa0GjWTZxvkG6UuSID9X8SL0xqYNUtG2KuLC3ZLpuywzLf+Gl634CS9A5rQ== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the label identified by the given `labelId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-managed-credentials.ParamsDetails.json b/platform-api-docs/docs/update-managed-credentials.ParamsDetails.json new file mode 100644 index 000000000..b7f3e6178 --- /dev/null +++ b/platform-api-docs/docs/update-managed-credentials.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"managedCredentialsId","in":"path","description":"Managed credentials numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-managed-credentials.RequestSchema.json b/platform-api-docs/docs/update-managed-credentials.RequestSchema.json new file mode 100644 index 000000000..97af08944 --- /dev/null +++ b/platform-api-docs/docs/update-managed-credentials.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Managed credentials update request.","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["ssh"],"description":"Authentication provider type. Currently supports `ssh`."},"credentials":{"required":["name","provider"],"type":"object","properties":{"id":{"maxLength":22,"type":"string"},"name":{"maxLength":100,"type":"string"},"description":{"type":"string"},"provider":{"maxLength":16,"type":"string","enum":["aws","azure","azure_entra","google","github","gitlab","bitbucket","ssh","k8s","container-reg","tw-agent","codecommit","gitea","azurerepos","seqeracompute","azure-cloud","s3"]},"baseUrl":{"maxLength":200,"pattern":"","type":"string"},"category":{"maxLength":20,"type":"string"},"deleted":{"type":"boolean","readOnly":true},"lastUsed":{"type":"string","format":"date-time","readOnly":true},"dateCreated":{"type":"string","format":"date-time","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"keys":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true}},"discriminator":{"propertyName":"discriminator","mapping":{"s3":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"},"github":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},"azurerepos":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},"azure_entra":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},"container-reg":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},"tw-agent":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},"k8s":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},"ssh":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},"google":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},"bitbucket":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},"gitea":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},"seqeracompute":{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},"codecommit":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},"gitlab":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},"aws":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},"azure":{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"}}},"oneOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"data":{"type":"string","writeOnly":true}},"title":"GoogleSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitHubSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GitLabSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"token":{"type":"string","writeOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"BitBucketSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"GiteaSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"privateKey":{"type":"string","writeOnly":true},"passphrase":{"type":"string","writeOnly":true}},"title":"SSHSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"certificate":{"type":"string"},"privateKey":{"type":"string","writeOnly":true},"token":{"type":"string","writeOnly":true}},"title":"K8sSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"AzureReposSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"userName":{"type":"string"},"password":{"type":"string","writeOnly":true},"registry":{"type":"string"}},"title":"ContainerRegistryKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"connectionId":{"type":"string"},"workDir":{"type":"string"},"shared":{"type":"boolean"}},"title":"AgentSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"username":{"type":"string"},"password":{"type":"string","writeOnly":true}},"title":"CodeCommitSecurityKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"batchName":{"type":"string"},"storageName":{"type":"string"},"batchKey":{"type":"string","writeOnly":true},"storageKey":{"type":"string","writeOnly":true}},"title":"AzureSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true},"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string","writeOnly":true}}}],"title":"AzureEntraKeys"},{"type":"object","allOf":[{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"assumeRoleArn":{"type":"string"}},"title":"AwsSecurityKeys"},{"properties":{"discriminator":{"type":"string","readOnly":true}}}],"title":"SeqeraComputeSecurityKeys"},{"type":"object","properties":{"discriminator":{"type":"string","readOnly":true},"accessKey":{"type":"string"},"secretKey":{"type":"string","writeOnly":true},"pathStyleAccessEnabled":{"type":"boolean"}},"title":"S3SecurityKeys"}],"title":"SecurityKeys"}},"title":"Credentials","description":"Updated authentication credentials configuration."},"metadata":{"description":"Additional metadata for the managed credentials.","type":"object","properties":{"discriminator":{"type":"string","readOnly":true,"description":"Type discriminator for metadata structure (read-only)."}},"title":"ManagedCredentialsMetadata"}},"title":"UpdateManagedCredentialsRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-managed-credentials.StatusCodes.json b/platform-api-docs/docs/update-managed-credentials.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-managed-credentials.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-managed-credentials.api.mdx b/platform-api-docs/docs/update-managed-credentials.api.mdx index 2bee815ed..a953fb102 100644 --- a/platform-api-docs/docs/update-managed-credentials.api.mdx +++ b/platform-api-docs/docs/update-managed-credentials.api.mdx @@ -5,9 +5,9 @@ description: "Updates the managed credentials identified by the given `managedCr sidebar_label: "Update managed credentials" hide_title: true hide_table_of_contents: true -api: eJztWm1z0zgQ/isefYKZvBTKMVw+XZvrQadAmYZ+YjqHYiuOqGMZSW4wGf/325Xs+DVNcm3umpYvEEur1T6r3dVLnwXR1Fdk8IVwj4Waa84UueoQjylX8khzEZIBuYw8qply9JQ5MxpSn3mOK5kZQQPl2LETDs3jxEj5/IaFztdMeFjInnpfnTnXUx62yJ1aGxIQ6pEOERGTFE049ZZGfGhoBMGISjpjmklEsiAhfMCAhlKQ5AgnonpK6hgzxRkWnThhPGOSuwU4iTZJ9j3mMDkZaBmzDlHulM0oGSyITiKclYea+UyC6ETIGdW26fUrkqadumkVv2xkXdnruzRQSL+w6HvMZNIw6Vz6NOQ/zQKtsGWbua+s6UzpY+ElOGa9B2ITEk42Dmd0BcwQahxOoyjgrjGv/02hjkXTIDH+xlyNISQx2kz4Qy983QAUWZJUWvLQB0kGWDFhlJo2M+UohqgG6+y8Tq7HQSU9ZxhLCb1B4qg4ioTUyvkKaiDYUzC9FNIwbbGOX+yidAqrYNrb7ece/jujP96z0IdwGrx82akBgRntWlfkXhwctAhWMNY9knYq7iore13XVXiPzjFx6c9Ysvz/vwG9pPDlC+EH2OxDoYjH9kdA8ceY63HsXjOEjAvQIddvVLbulIdMdiXDafS8C9ESatPlMVfMZlxbRYzmE0oWCRys2HcoNCATxXppTdcNRIwpoA7JFWAcU8UuZVD3K/oLMhZqDy4/aXEehALzhUwaI1sdHUAZ80pOHgsRMBqaxKbeeRgkNrFBOKBKX6qK9NLNy/TCBOlqbuKnoQE7oQZRfRclxgyTiHdQcs0StT4tPY5xOOMh1aI1N2t6EWJ9SKYx+WgLXbW/AysURagLi8Xh/VsEweW6TKkzlrRmkmJQBnRrb4fMJURvRRnuFSOdBOzIaD0J6ThoDR90BexqAbaNDkfMjUFXcoZeT5d5tgO0sYLEyMpMs2xQpeZCtoZNHWvJ/rdcv4vHdQyljN4THEdo8QVa3IolK4ctYGgQnE/MSee+YY6pdqcfV+FUoAaq6sp+M3rj2M20bShf91vNZYs7Q4djAw31acsiYg0POFvTOTKZuxEUPOtUwJzgSueLX93KdhTLK9dwm1hG3T6H7rZaVlqwYY7oIhPPoS536R2gBDeGoCm7PbQgBZTXf/IWZRibUyrX1tEj3y57JXXxOLILNDh4gsfKFcsm+Q30bZx8WlyzlrPcrXl39qZRqPAItgO026LBoI2mEk5oW0Iajd419kJ7+NwBKjgA0S3te2uMqZtYHIJ3YOXGkbGbTfGY62ODreWMwja4uT2Mrf0tGttIlso14z/d1+/10Akugdv+BRTEI9l2HyyXyHm9ZNx1o65sniPj0aH1aN3dpXvfnkTNECweGotbgh/vv48v3SFR3tPmWX6+k0304WRB9vCxA4z7eoLHbhGyJ1D/HuqxYj9qZOvl/2mUxUeHctVZb28isXHGe1RXoadyi/21Ce9Z5q18OH3Eb2WP5YFsPyJs5U3s12P8k3qM//VGs9M3mgfuxHv562rFFZUbb6ncVNhMbdwrz6FVZkmZBgOVfML92HKlDJdkxjTN74U1gorncfxJAycXciZCrqJ29QpGw/2sUR3eZ5B2KjqMOUvbQE3sakhL5xkq6grQ9LxX8V6TEvYhh18WW8Ufu7DsIfsEUWVPmQYViVBZrC8PXjU9en7mdJ2PwsmpRzDo1cFBU+6YejlTiWxBVCrzgGYQhWD9ev5PLnhr4p9IKeCYYfEhfGP5YQvCnIfnhEI7UAHFHOxJbUKZiDYF8ZjBmUAiAwo+rzDwYRWnArl7kPvE5hN89AuqYX/RIOml/VL4LfsrTLmU4MzyJuf7xUjLIVOtIzXo92nEe4a707MP7j0uGklli5LzKaAa+SnOEOWdo0+nJl9zVCNcBOvQMralT3FGkrHcTDkwQtBif/yVM1++zbXxFi7uRcFxO/lBZ5H9U1NBoMpYTTUyGPK5iozKOHrL7yq2ZXNJqWVbLSlMhUxBTiraci5OqZYWnaUSWjTWdptysJUqEX7ycCKMByu7g/H8ujXCFedgUSZs/kzumgSqrn951SGHOPbhtH8UHWAIBo+d50Xv9996B+awKJSGeEOVmYttzWgrjHVzF0VG/1902SwqNfuh+1EAlwjEFFvKmk29Csu3QwZtDNkqxkErUxVyZAq+QoWLRRZVaYrNliqKSQk1PdsuJzCoXvfL7tqASNoK7doEYc5UvaFBjDImg2+o5Dj7lpY8u8iK7XNnQzpwq2FZIw2Tsl25wU2n40HoTkauZwX/ezurK58iFXIKGzGWFfCtFR1a47q4mZdUNTY2BGpH4Ikq0rfKlvePT5efsX5lxOAZ3M6gUdI5Hi/gX2O1ML6y3FlsW5CAhn5stkFiVWIFotUaXqvZ5ZN91S8Q6EbiM745penSTfYNCvySpv8A0ZSr8A== +api: eJztWltv28YS/ivEPrUALTsXFIWeauukqZE2CezkKTCOR+SI2pjkMrtDK6zA/17MLileFcnH0Wns5MWWyNnZ+ea2F31rQRAZMf0gZIgpSZJoxJUvQjSBlhlJlYqpeJ+FQGg8WqKXQAoRhl6g0Y6A2Hhu7EJi6M0LKxXJW0y960p41sieh9feStJSpiNy586G4jy8nghfqAw1sAnn4caIvwYahS8y0JAgoWYka5FCgmIqBkqFLyTDyYCWoo+xUlxhocJL8wS1DBpwmm3S+CmXGkMxJZ2jL0ywxATEdC2oyHhWmRJGqIUvFkonQO7RL89FWfp90zp+2cu6ttcPaaDSUWPRpxx1MTDpjY4glX/bAG2x5S5zXznT0dCZCgses9sDuU0JrxrHMwYqJUyJh0OWxTKw5h1/NKxjPTRIzT9iQJxCmrPNpv90zd9uZYi6JWlIyzQSvsA0T7hgjFkOK+U0pyVb5+b1aj0eK5l4s1xrTCkuPJNnmdJkvGtjltcTUfqiBYynbeL4wQXFb6y68nfYL0P+m8DnPzGNaCmmT5/6PSClX8W6I/fk5GREsIOx75HS77irreyXvq7Ge7DiwoW/c431//9iShqELyKlopgfR5KW+dx9iIE/zCXN8+AGGTIHwBc3v5oq7iBT1EcaeRpaHUHEicCvQgxUkkhyihDqCTVmigcb/IQaApVkOW2sOQpilXMJmGfiqvTFHAy+13Hfr+yvDIhQc/jFiPMCIIyULgYjRx0dI2HYcvJcqRghtYUN4Zs0Llxhl76IwdB705HeuHlTXlwgRyRt/gw08MuZRqD7KLFm2EK8h5IbLMzusgwl52EiUyA1Wps9vQyxP6TSWLx2ja773hcJZBnr4mbx7Otb5AsIAjTmFRajlWQw0Eijb32x0pKwo4zXiksqYjy1Wl+kMI9H04ddQZJifnb57BKDXEsqXrHXy02dHQBtblDXbWbYNsCYldKjadPH2rL/paQ/8nkfQ6uiHwiOU7b4gi0exVK1wxEwEMdvFnan87VhzoGC5ettOA0pDRFufW9H7527lbY95ft+67lsfW/ohCmkdD4SRO7hscQdLy9t5e4Fhfc6HTAvONJ18LtL2YFyeWsM75LLrDuShvRYL2sFbFYjuqjEa6ibVfoAKAOVphjUp4cRpCulb/4jR5Rxbi5B7+yjp5ELe6d0eTtyCDQ8eMHbyi1h0/IWaN9i8gWpGxzZy32x7l79OmhUvAU7ANq7ouGkzZYazIhzvgjp8vKPwVroNp8HQBUCwR3te2mN6ZvYbIIPYOXemXGYRfFM0pnFNrJHwT1Obt/G0v6SjR0US+eY8X9d17/qphOMyRO8UDGe6rHzYLtFrvot474LdWfxvLQenTmP9t3dOvc9kKyZqRBn1uKR5Ofz7+Mr95eS/oThXn51kEX026mC6uLjABgf6g6eX6sUv4P+961uKx5Gjxw9/H8fbfHRody213swmTjY4z2qo9D3cor9sQg/sMrbenH6iO/KHssF2cPIsK0nsR+X8d/VZfyPO5qD3tF84078Kr+udlzROfG22k2HzTTGvQo96DJL2jSYQKULGeWOK2W5JAkS1OfCHkElDCV/hNirhbyF0tuoXROxi2pyxxj14b0rMvQ6Oqw5G9sM6TygXKP3Eys6Umlc/DzpeG9ICfurht8W28Yfu3DsIXcF0WVP2QcmU6lxWJ+ePB969M0r78h7rbyaelT64vnJyVDuDMKaqXQXolKbB5SgMRDhbv5PLfjFwn+htdIXFT6Gby1/NoKw5uF5qSIP4litMLSqTJXRtiGeIWjUzIAS0w9XnPgJ0lIxdy/LrY3MbJuK44ZqeLwekPTK41b6bd53mHKl5ezo25rvlzMtRyyJMjM9PoZMTix3Z+Iu3CdSDYrKNSXvbQzE/BRvxvLe6dtzW681qksOgnNoG9vGpzxjzXKz7cAKMUvJfvi9Zr58XJH1Fgf3ouG4vfgMSeZ+amoIVBWrqUcGYz5XU1EVR2/zvYtt87il1LGtNhSmRqYhJzXPai5Oq5c2L1sttHnYW23aydbqRPxVpgtlPdhZHaznd8WIIy4DNJWw/Zk8sAXUjX876piAjC3JcKF+a16UvuDkcfM8mTw5eTo5sbtFZSgBW4CVj13TGOuMfXvXTUn/W3zZKi0JP9NxFoNMGVPuOGuu9jo0X19MxyiyXYzTUarqlS+WyhArXK+rtCpLfuy4olyVoTTVermA2PQbf9tdezBJR6Hd2Cysqaq3EOcsY0v4FrTk2e9oyU8XVbf92duTDzxqWPUQ0qJtV23w0Om8E7qXkbtpwf+7nd3Il8yFXCLYvvJhXYnOnHFHvJq3VA1WNgbqRvCWKqMvyrYXkLfv33EDq5jBiQp5iIYV7y9g5axW1leOPMvP1iKGNMrtOiicSm5B0G3ivabd3tp3/bJeO4l3fOlUlhs3uUuo8qosy38AoHasFQ== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the managed credentials identified by the given `managedCredentialsId` w id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-managed-identity.ParamsDetails.json b/platform-api-docs/docs/update-managed-identity.ParamsDetails.json new file mode 100644 index 000000000..b33b78de8 --- /dev/null +++ b/platform-api-docs/docs/update-managed-identity.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"query","description":"Organization numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"managedIdentityId","in":"path","description":"Managed identity numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-managed-identity.RequestSchema.json b/platform-api-docs/docs/update-managed-identity.RequestSchema.json new file mode 100644 index 000000000..bf1371a40 --- /dev/null +++ b/platform-api-docs/docs/update-managed-identity.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Managed identity update request.","content":{"application/json":{"schema":{"type":"object","properties":{"managedIdentity":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Managed identity numeric identifier."},"name":{"type":"string","description":"Name of the managed identity."},"platform":{"type":"string","enum":["altair-platform","lsf-platform","moab-platform","slurm-platform","uge-platform"],"description":"HPC platform type."},"config":{"type":"object","properties":{"workDir":{"type":"string","description":"Compute environment working directory."},"preRunScript":{"type":"string","description":"Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"nextflowConfig":{"type":"string","description":"Additional Nextflow configuration content."},"launchDir":{"type":"string","description":"Launch directory for Nextflow execution."},"userName":{"type":"string","description":"Username for SSH authentication to the HPC cluster."},"hostName":{"type":"string","description":"Hostname or IP address of the HPC cluster head node."},"port":{"type":"integer","format":"int32","description":"SSH port for connecting to the HPC cluster. Default: `22`."},"headQueue":{"type":"string","description":"Queue name for submitting the Nextflow head job."},"computeQueue":{"type":"string","description":"Queue name for submitting Nextflow compute jobs."},"maxQueueSize":{"type":"integer","format":"int32","description":"Maximum number of jobs that can be queued at one time."},"headJobOptions":{"type":"string","description":"Additional options for the head job submission."},"propagateHeadJobOptions":{"type":"boolean","description":"If true, head job options are propagated to compute jobs. Default: `false`."}},"title":"AbstractGridConfig","description":"HPC platform-specific configuration for the managed identity."}},"title":"ManagedIdentityDbDto_AbstractGridConfig_","description":"Updated managed identity configuration object."}},"title":"UpdateManagedIdentityRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-managed-identity.StatusCodes.json b/platform-api-docs/docs/update-managed-identity.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-managed-identity.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-managed-identity.api.mdx b/platform-api-docs/docs/update-managed-identity.api.mdx index c2a2ba645..13e6f72b1 100644 --- a/platform-api-docs/docs/update-managed-identity.api.mdx +++ b/platform-api-docs/docs/update-managed-identity.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the managed identity associated with the gi sidebar_label: "Update managed identity" hide_title: true hide_table_of_contents: true -api: eJzFWNtu4zYQ/RVCfeguYNne7LZA/dRctk1aZDfN5SkI1pRE2UwkUiEpO17D/94ZkrIky4mdYIu+BDE5nDlzOxxqGRg60cHoNuAJE4YbznRw1wsSpmPFC8OlCEbBTZFQwzQxU0YSZijPNJGp/ZlTQScsIf74glCtZcxBPCFzbqZWaMJnTJCxlz3zomfJuB/0AlkwRdHQWbI2dd6WBKmCKpozwxSCXQYCfoC0VBM41Qs4onwsmULRNvavakIF/24tEFHmTPHYo005U4hAx1OW02C0DMyiQLVcGDZhCrZSqXJq3NKvn4LVqre23fGmwlFQM+3AON+M03Yoij2WXDGIhFElex20O3ecaXMkkwWe2QGhtLEm/hCajyWoFwbP0qLIeGzDNrjXqGDZRSOjexYbTI/CNNrqgd2N0Ow+wJN9XHxTTFc9n7C1fm0UF5OOti8g9VxVWzVFRg0i2qaKgWnsIppBd6hwLdoLMp02f+aSRs3fOitV3lwoJ6z+2enE04tjUu0SBGGRQdpSPtkd5rlUDydc7REL9mTSTM4JniAJVGRspFoQaCEMT5yVGlrxZ030lEK1kpRnjOgFLOZ9cg6bJGKECkIjLbMSagx7AhYSEoM4xpQCheQoOKUzLEGahHPFQZLGMdPaBVyxy1JcWVy7MR8mCaHErQBKagh7YnGJvMUdbJGGGS1FPK2kCsWlIkaCwEw+gFKydhwChziY7pMrxsjthWIWfyG1CVUpvAp9925qTKFHg0EiY93X7BHYrM/loMpSGGeyTAbO8IAmMypilvwEvoWgL6z0hV7fe+c5rP4Y12kKiSI0y7a45mIfy7zIgFmT/8VT4VEdb5bw865y/Jc2HHLlX7pbBNOJ3LXw7mxI2VJ9qysV2NDpClGXc8NJ7tVbJ+tumk8ZxHoNEGKjf1D3kLOUyJwbyGoPbuyUlpnRGJmxp4CxRV1qpr7sRY43IIk0SiA65OrqFKMpwA0fcKSlKaAgQiaOkqaQ7f1Un4KkVQ2azy4ITRIFLiATd7UWUpmdN8XHg44NRIxn++TEBWNExgcHLgho4Z+SlXtAvUYSaVwTj3hsgxQJBDXBmHiqwa11il1bgjJP23kB6X2D8a2GweZ8ysFkwQuWccHIvYyAAaDGdBm5auiTYygsKC85Y0rxBKqJRAurZn2q1U4WaE6fLMgr/p29JfzX9kp94nmZ4x0dAVhwwqKr2xNwOZjoSB1dDafgUhVMlhqbuk7gh+GwzuBfMvpqzelXcYi3KN1RW92thNnyA6D+PpIFncDIdPqcwUjKjFHRsQjtaOc5Mm5jHdvsQDc7zuKucpoIwnXqiC8XG7c+jqIBjCYZmj2MwFMamz8ho55IXxocQl2wGMajeIM5K++3TD8NYxuz+Ul0YuS3LoJvXQ6x42bSfTK0UbjZpW1z66vg0s2tILjaHJztgi4gwm7wORh+6s7DX/8mIfkiSTX0wqFPw2FX7ghKwM/IrxmRa0S3QQ6MBtBxntsxOXvBTg03o/FZKakuvX/ovkX+cYuH1dMKGNTgECDngAfFNfCQsqM5PKaOGFShOizh2TK6vcN3BLy0phKfY1Bw9vGFW8GgfiMOlp3nzwqnWaZm1ROtVBmcqS5aWvC+vVTr27bL0naHXFTz7THKk8OLswAxVZCvMMIuWk3g64ChxepRZ3vSCsGK++ePiqru58aGAjN3Wb+bPj9RnIeeecbgQ2VYvShqfqmfBlteAPV0vp6/GydbM25jvT0B1hubA1O905hB6sX6iq/X6ru5aQ9v1mHrOqx32zdVvd6+GIZdKm46+gx52n7FRHCRSptHX+a+HDD/uyoF647D5OOFsUeBjFBZuwqbtQdtyjN7ZaXy93oDgGAJOzsf+r/90h9WEznUA6r0yXec1GGzTazLmjH+2+8ovvwN1AfOsVzYCQ/dX/oGbn3k6QWj7heMO1ccKLpcRlSzG5WtVrjsPq5gXydc0yhDXkvh4mIvuLvHp5etoB/YovFtZ0YzW3SWBGZUcbT+SiTvLj0Zvyd7fojZCswvUrFo4qoAd8O5uvPTCfAPAnZyxw5WeI3aaj2d2wS/NbkThzDVF+ZF2SZpX9xcI935j0A5DM+wqOgcvy/BXwtZ1rOLXVsCfYhJae+ewKnEnqRtbt3gUuvU1qBA9ViJa/nAxGq1jpHB3xiX1epfrG43ig== +api: eJzFWE1z2zYQ/SsY9JLMSJbiZHrQqY6d1m4bx7Xik8cTr4ilBIcEaGAp29Hov3cWIEVKlCM5mU5vJLjYfbvYjwcuJMHUy9G11AoNadLo5U1PKvSJ0wVpa+RIXhUKCL2gGQqFBDrzwqbhNQcDU1Si2v4kwHubaCBU4kHTLAhN9RyNuK1kzyrRM3V7IHvSFuiADZ2plamP65KyJwtwkCOhY7ALaSBHOZLWTc+U7EnNKO9LdCy6jv2Tm4LR34IFYcocnU4qtKlGxwh8MsMc5Ggh6algtdoQTtHJnkyty4Hi0q/v5HLZW9nueFPjKIBmHRgfN+O0HYrD+1I7VHJErsSXQbuJ29HTe6ueeM8OCGWItag2sfnEGkJDvBeKItNJCNvgzrOCRReNndxhQnw8jo8xZM9osRma3Ru02sfFH4rpslcd2Eq/J6fNtKPtHHJ8LquDmiIDYkTbVKEpc64iyAi0669EezLzafs1tzBpv/usdHl7oZxi89qpxNOLY1F/FQwiIEusSfV0d5gfrPt6ot3uWBzbvCgJBZq5dtbkaEjwZm2mQmmHCVlXBcXhZWnGYe9uvVFO0AxI4CMmJXcVbULMTdrPoDTJTMQdonDaOkFWaDO3wfQ5PlKa2QdROJug9+gPxBhRXF84FGCUKKynvitNpcLfvJoRFX40GCib+AOP9+jgQNtBHcN+ktlSDaLhAag5mATVL4XDPhjVr/X1K32vo8/W0886DSmhE5BlW5wSM5ijSGxeZEio/hcfTYXqeDO1nnHySCnNj9ByKKZlGbu7qHpL0B6x7JWKf8ecWGWdSK1rTMR4amuC2tKjO9+r2K88Om4LQdt4fCqgpBnXeux4nHWck1xuSVZ6qjrJzHraz8Cp9RQMWCfOLgQo5dCvpmZLr5ghKGGswiq3HO3shW8Pu0k2PhW8NziUWGMwIS6ZLY6IE0yhzGgkbg8Pb6NfCOqfEss9HAtiYhU7X05yTdHUDJuDCV7d2UnVn0I7+WkLrcyK/enOTnywkMNj2DbW3/BHwvcRHnVe5jxBJuj4mFh1rNkEjJiguGf9SgAJa1CQznEVuj/t5FPQ5F9UKDbuCV5y8OqYRZe9r9OamzhMgfD0OVsTazME0zF2lorAIxrVtU1wKFZ6FafJWkxbOZJC5pHTZNmTpClje0cTTw4S+sNpVXWI702qvi8w0alONlpC7fiWcdsytkEGTyYnZL90EXzpFnngN6rLUddRxGG5bnMrDb2MREkuWXKdqYUFX1jj46Q9HL7rErBPf4m+OLd1J+SjfTccduXeg6pJ2Us4WYPoWuboPUyRCcQOqlYJdvK2HY0Pzll3WfnH7gfkb7d4WHN5YSzxdLMPqIIqj0npAhe8Xsj3CA7dUUkzObq+YeKaI80s8/+iDBiZQo/koLmUDBYdvr1k+oRuXt8JSpfJkayHIRT6IAy+ZiJ2m2b4Ii5qQnXM8uLo4kwyphrymCMco9UGvgoYW6xvEaEYg5DsVQ+/153n7oFCKPjkLhui/uEReNA/w5uZGQ9rCtv0lIaLbqGcDR1cEb7WzjXC1lpfJzXNh00m0HxpTfFmsZnBzVozNtv2eNAN12ZP83V9YjTr631+2G2/bUef6ZqhXvkgtEltOMcqzat04PPflSmcdzpBXwlzjUISanQ9C9u5hznoLEyg1P7WfFj2JKdwtPPm4M3w8GBYs8wcQo1Xpx+bUqedbYJdNC3jv725V/lP+EhMNrUJHIz9X1QVvPZboSdH3TvzTcwOFl0sJuDxymXLJS/H6zwXttIeJhk3tjCLvuPuHpf9raC/4lPrb8IcspB1oQvMwWm2/kIkry6rbvxa7Hn13wqsWgTz1MZVA+6Gc3lTURJ0AXCUO46w+p9ZW6OnM07470bccZQkWNB3Zdtd++LqM/e76rdDbhVvcfDAfzTgIUK2DWsJawuZgZmWYfjIqJKLEtab60YzDU5tDcpiESU+269olstVjIjfOS7L5b/3uKfm sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the managed identity associated with the given `managedId id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-organization-member-role.ParamsDetails.json b/platform-api-docs/docs/update-organization-member-role.ParamsDetails.json new file mode 100644 index 000000000..651c34df4 --- /dev/null +++ b/platform-api-docs/docs/update-organization-member-role.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"memberId","in":"path","description":"Member numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-organization-member-role.RequestSchema.json b/platform-api-docs/docs/update-organization-member-role.RequestSchema.json new file mode 100644 index 000000000..7289ce61f --- /dev/null +++ b/platform-api-docs/docs/update-organization-member-role.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Updated role for the organization member. Accepts: `owner`, `member`.","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["owner","member","collaborator"],"x-enum-varnames":["owner","member","collaborator"],"title":"OrgRole","description":"Updated organization role for the member. Accepts: `owner`, `member`. See [Organization user roles](https://docs.seqera.io/platform-cloud/orgs-and-teams/roles#organization-user-roles) for more information."}},"title":"UpdateMemberRoleRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-organization-member-role.StatusCodes.json b/platform-api-docs/docs/update-organization-member-role.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-organization-member-role.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-organization-member-role.api.mdx b/platform-api-docs/docs/update-organization-member-role.api.mdx index b0d714f34..1bde6c810 100644 --- a/platform-api-docs/docs/update-organization-member-role.api.mdx +++ b/platform-api-docs/docs/update-organization-member-role.api.mdx @@ -5,9 +5,9 @@ description: "Updates the role of the member identified by the given `memberId` sidebar_label: "Update organization member role" hide_title: true hide_table_of_contents: true -api: eJzNVlFv2zgM/iuC7mUD4qS79QZcnq4dNqA47Fqk7VMQoIrNJOpsyZXktjnD/30kZSdOk+V6AwbspbUkUvz48SOVWga19HI8ldbh/9lAZuBTp8ugrZFjeVtmKoAXYQXC2RyEXfB3AcUcnNAZmKAXGjIxX/PBUj+CEXfx/CK7E9rwPl6vjP5X0b3fd0Mr9BmKszSFMuDxo8or8GM8eTLg7gbdzXdDOZC2BMcXXmQbqJe9OF/YdIKw0bhUThUQwFG2tTS4QCcOiKeaki1VWMmXDPQvFKYqwOl0m4AjHA4eKu0AQQRXwUD6dAWFkuNahnVJUbQJsASHpgvrChXi1odT2TSDDZSOsqNoYko/AccsuoMP5zZbk88hIWRRBOi9X9SIv6vd92qWWsRgAgVQZZnrlJ1H956i1PuQ7fwe0kD1c1TuoMHTKcHoWfngtFmiFSAzrGYKjesYmePmuZpb1It1JPPnhEyTR+WIfv8qn6ADRSVJtKI6zNEOLTuEvYIjcQ0gpjuqqzyWnO7xszerEEo/Ho0ym/qhhwfsgKG2ozJXgWqapLmtshE1c6JMlgRQhR+x7299WAndmfD+W0ZXWAfYq1EXaDAkbW4yjplt+2kSpYI2zUvZ8YYvrfGxUr+fnO6r6fJvkYh/rOjUgE6nJyf7ducKFdfG+h/a2SKaYjW9V0vg+h2VVGe4p6o+EZ+cs27S5kfpM/L3BzLsZpMwNgiV5/YJ8ZC5h7RyOqx5DJ2DcuDOKmz18XRGXYgzamVpnpUVY6QpMJZc0VHN46oZRa3gupsZDZdY0uXusRtxlcvRsxOMKvWQxbFVzZ6Ar/lEXLViEh/JXpxdXUhC1gG/Jp4jZ334G9ooomynD63nbIQ78eNzN3runwITQvWbbGfPp2dVlLG7Y5e3jdnQXFxYDtRWo8VLAP8rFSJGp/iSRWOSkkpZSrs09clBNemcZ+TC/rU9QCDEcYzzbvjnH8MT2iutD4ViJbYTPXbNoSkp3IH5UW8F/mu/u22dAzwHGjz4WmH6TGPd6rX9OTGQ4+6BbSVLW72HjmlAaa2QO/Kq67nycOvypqFt1ISjPsFPHNRazanqqOxMe/rGLlmo3MMRHt9M2lHwVrziIT+YWLupzFoSDOQFV/j5FdabHxD0jP8QqKPv+Q/A2XDbzNB2BSrDziHK4vHHiCG5oUu27nvTlPKJHlERR237Q+vq9oYavf0JUdiMXJx6olrjX0ZqmZL4jNNeLXNllhXPXhmvpLGgdqfKiynCSR3kAjXEFjf2KxjUUUdNoDXx0jTfAMs0z6c= +api: eJzNVtuO2zYQ/RVi+pIA8iXpog966m6QAouizWIvT4YB0+LY5kYitUPKXlfQvxdDUr7EjrsNUKBvEjXDOXPm8FAteLl0kE/A0tLBNAOFriBde20N5PBUK+nRCb9CQbZEYRfhucJqjiS0QuP1QqMS8234sNRrNGIWv9+qmdAmrFtaSqP/krzv99MsLW/VbCiuiwJrj0qsZdmgy8XMbgzSLOt3ng0hA1sjhQ1v1Q7ql4M6f4TQe1siZFBLkhV6JO62BSMrhBxCQchAc7O19Cv4loHDDYVpKiRd7BsgxkH40mhCBbmnBjNwxQorCXkLfltzFW08LpEgg4WlSvq49MsVdF22g9JTdhFNbOk/wDGN6ej8jVVbzjknBBVFsLB0OtSIv5/d92ZWWOPReC4g67rURUgePTuu0p5CtvNnLDzPj3jcXqPjrwzjIMp50mYJGaBpqqBmLg1ZIjXULUs5tyS9JZb564BDB2tJTL97U47XnquyJJKoznN0RMsRYW/gSDwgismR6hqHFPZx03cr72uXj0bKFm7o8AVJDrUd1aX0PNNBUdpGjfgwD6RRA4+ycqOQ+9MhrAHvOQjr7wO6yhIKbaIutDVD1uau49jZ/jzdR6lAx0HHsgsLrrbGxUl9HF+dqunL72Ig/rSiV0OXwdV4fBp3I5VIsvw32tkjmkCFzsklhvldlFQfeKKqQyI+E1m6T/1x+wH5z2c67L1JGOuFLEu7QRW2clg0pP022NANSkK6bvwK8smUT2GFfmXZz+omYGQXyCFMdNQGu+pGUStu1Pae0YURA29O697iGiohh14wstbDII69ak4E/BC+iLskJvGJ48X13S0wsh74A/McOTuEv6ONK0JyH36fhyDI0sNvvfU8b3wghOd3v/eez6+yquPpjqc8HcyOfXFhQ6E0jYSXAf5TK0yMLtClYJaSLIKUjmk6JAcrqcvgkQv76/5DlwFzHOt8GH4YfxyOebG2zlcySDFZejw252xS0BkDafcK/39fvGnQHl89O4823H7gsU2CTf8TGeT9DZs0y0sHN12gYZrByjrPWW07lw6fqOw6Xn5pkPigTDNYS9JyzmOftKC042cF+UKWDi/w+O4+ecF78Yab/GxjaVGaLTCMsuE3yOArbnd/EHyP/xCoixf6D8DZcdtNuwxWKBVSoCx+/hQxDB55k336iZ1yPzEjKuJi7KFr3T098klP/xCVVZxCcsOzlpuI1AZK4j3Oay2U0iybYL4Qt2RfkMe28o2NhKbOctG2MeLRfkXTdTtqPL8zL133N+BIz8w= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the role of the member identified by the given `memberId` in the organiz id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-organization-team.ParamsDetails.json b/platform-api-docs/docs/update-organization-team.ParamsDetails.json new file mode 100644 index 000000000..77a4c6e23 --- /dev/null +++ b/platform-api-docs/docs/update-organization-team.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"teamId","in":"path","description":"Team numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-organization-team.RequestSchema.json b/platform-api-docs/docs/update-organization-team.RequestSchema.json new file mode 100644 index 000000000..4b0dbd1dc --- /dev/null +++ b/platform-api-docs/docs/update-organization-team.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Updated team details.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"avatarId":{"type":"string","description":"Updated avatar image identifier for the team. See [Create avatar](https://docs.seqera.io/platform-api/create-avatar) to upload images and obtain an avatar ID."}},"title":"UpdateTeamRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-organization-team.StatusCodes.json b/platform-api-docs/docs/update-organization-team.StatusCodes.json new file mode 100644 index 000000000..eeab6550a --- /dev/null +++ b/platform-api-docs/docs/update-organization-team.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK"},"204":{"description":"UpdateOrganizationTeam 204 response"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicated element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-organization-team.api.mdx b/platform-api-docs/docs/update-organization-team.api.mdx index b29831f77..288edc07c 100644 --- a/platform-api-docs/docs/update-organization-team.api.mdx +++ b/platform-api-docs/docs/update-organization-team.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the team identified by the given `teamId`." sidebar_label: "Update organization team" hide_title: true hide_table_of_contents: true -api: eJzNVk1v2zgQ/SsETy3gWN42u0B92iRtgWAPDfJxMgyUFsc2U4lkSSqpV9B/7wypr9qud7dogb0I0nCGfPNm5lE1D2Lj+XzBA4jS8+WES/C5UzYoo/mcP1gpAngWtsAkBKEKz8w6flIEUxJ0UGsFkq120bxRT6DZR1q9lh+nfMKNBSdov2vZ7/jBbYRWf0fzPbqimxVOlBDAEZ6aa/xAd+M2GDbhitBYEbZ8H+J4K6arEpzKB1yOEDj4XCkHeHxwFUy4z7dQCj6vedhZOkXpABtw6Lo2rhQhmf44500z6aGklE5ioVR+AYZlCgcfLo3cUcyxKslUkrZMdGZucE8dKEBYW6g8kpQ9eoqqDyGY1SPkgWrhqGhBgafVlH/v5YNTesObveSPrIsnEYSjsu8vHu8zyVIEU6XYwIhAhpT0TTdldwBsceUAQ9qI5YttCNbPs0ya3E89fMaemyqT2UIE4vNMWJXlMeQshbxkwbDKFkbIdJ5nQktmVkifxtcOy/XbKbUBDyoU0EOlSt+mmuBqs1/faPDWaJ8ofDWbHZbtw19E0qvZ+fcquj8lDH1Zty/Fnh/b9hITatvlv/TAkMCCl+A9MkJ6cLo1OsfD6o8Ye+eccbc97EjX+ez1EUI6pWDaBCaKwjwjnuj95tD7bZXSwbaBAkpK8n+aLi56yCunwi5q2yUIB+6iQgWZL5Y03ih8W0PyaKt4KonLnGeofj6rowY2WZTorE4y1HDa0z11clm5AgO6IcBmn+aFqeQwCQcjdxdX2E07IOyK/NnFzTUnQB3eOyIsJT9G3edPJ/JWzeh7FZ3Qkl7ed1L2+BwiSVSI20HL3n0RpS1gUJnvCURvHjRlJDRKr00E1ZagzY2S+ae0iUSV4/AnZ+ofkcf++ZbSMZHYQqqI+rw2fw4LCITqkc75bfrm9+mMbNb4UAo9yjFNNzPjmyukW3BPUvt2/ik3cVuzAF8CCSPeYwgvplm3LbegC9ej67y7eNOPARra6w97Y4sJkWtdr4SHB1c0DZmxqI76G1+fhFNiRaXA1pTK0ztWbC0KDydyfHHbDuVL9i9u9aPZtEahd5xgFBV94esn2PV/E3Sn/xCoE9f7D4BpCW2W6LkFIXFsiK60eJXOP7unLYbgA02jXFLERZ6DDSd9x0Jz83BPU9r+T5RGUogTz/Srgs+I00Q64vBHW80LoTdVVECetqSZFt9Kwp4ExKSOMoH9Ez3uzSfQTTMQQ9/ES9N8BdF6q1s= +api: eJzNVk1v4zYQ/SvEnHYBxfamRoHq1CS7BYweNsjHyTCwY3FsMyuRCjlK1hX034sh5Y/YXrddtEBvEskh33sz88gWGJcB8ikwYRVgloGmUHhTs3EWcnisNTIFxStSmhhNGZRbxF+JUEaTZbMwpNV8HYeX5oWs+iKzE/1lABm4mjzKfhO93fGzX6I1f8ThB8IKMqjRY0VMXvC0YLEiyMH55URDBkbQ1MgrOIS4v5WyTUXeFDtcXhB4em6MJw05+4YyCMWKKoS8BV7XcoqxTEvykMHC+Qo5Df08hq7LtlASpbNYhMp/gGGWwinwtdNriTmVJZ1S0qdJziycZbIsAVjXpSmiSMOnIFHtMQQ3f6KCJRdeksaGgswm/ttVgb2xS+gOyJ+Yxxdk9JL2w8nTdaZVilCmwiXtCagWzm+LbqDuidT0xhMy9RGzdyvmOuTDoXZFGAR6Jo8D44Z1iSx6XmBthkUMuUgh7xU71dSlQ53OCwqtVm7OaKxCu8Ey+TiQMgA2XNIWqmT6LuUEOpl+m984EGpnQ5LwcjQ6Ttvn30Wky9H4exk97BJ1ORqrzb4SOz617TVq1ZfLP6mBHYEpVBQCLkn84HxpbBYeZ39PsU/eO3+3hR3lGo9+OiHIximUdaywLN0r6cTzl+PVH5tEh7Sikioh+T+l22UQqGi84XX0tmtCT/6q4RXk05m0d0W8cmKPdRNPFXPJYej8Mgzb6IHdMFr0sE021IHs6V82dtn4EnLYNAHWZlCUrtG7Tjhqufs4o277BlE3sl5d3U5AAG3w3otgifw+6i1/ORF6N5P/eVwEWf/x28bKnl45iiSJuNt52advWNUl7VzmewaxHd55yp7RGLtwEVSfgp6bkPkr2iKiKSj0i6V+sIj181bSfSGpQlNGf164X3cTXQaSj3TOh8GH0eVgJIO1C1yh3SOZ2lu5/auL0zV44Knbev5XruI+aUzfWJzRWIEXebZ9zU3lxg2QQb65edPLIIO8v/9mGaxcYFnatnMM9OjLrpPh54a8FPgsgxf0BueSi2kL2gT51pAvsAx0huO7u74r36u/ca2fZNMPol2DwCgb+YMMvtJ6+5yQS/2HQJ25338ATC9oN+syWBFq8lGuNHmTzr94kC12wUemJlxSxFVRUM1n1+47ze3jg7Rp/6ConJYQj6/yVsHXhNNFOWL3x7EWSrTLJlogpC2lqfGtJxx4QCR1Uom2TSse3FeyXbcTRv5Fl677E9q6q4A= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the team identified by the given `teamId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-organization.ParamsDetails.json b/platform-api-docs/docs/update-organization.ParamsDetails.json new file mode 100644 index 000000000..07b3cb1d6 --- /dev/null +++ b/platform-api-docs/docs/update-organization.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-organization.RequestSchema.json b/platform-api-docs/docs/update-organization.RequestSchema.json new file mode 100644 index 000000000..8b96ab159 --- /dev/null +++ b/platform-api-docs/docs/update-organization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Updated organization details.","content":{"application/json":{"schema":{"type":"object","properties":{"fullName":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"website":{"type":"string"},"logoId":{"type":"string","description":"Updated logo image identifier for the organization. See [Create avatar](https://docs.seqera.io/platform-api/create-avatar) to upload images and obtain a logo ID."},"paying":{"type":"boolean","nullable":true,"deprecated":true},"type":{"nullable":true,"allOf":[{"type":"string","enum":["academic","evaluating","pro","basic","internal"],"x-enum-varnames":["academic","evaluating","pro","basic","internal"],"title":"OrgType"}]}},"title":"UpdateOrganizationRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-organization.StatusCodes.json b/platform-api-docs/docs/update-organization.StatusCodes.json new file mode 100644 index 000000000..aa9aa8b95 --- /dev/null +++ b/platform-api-docs/docs/update-organization.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-organization.api.mdx b/platform-api-docs/docs/update-organization.api.mdx index 2feb44948..22dd6433f 100644 --- a/platform-api-docs/docs/update-organization.api.mdx +++ b/platform-api-docs/docs/update-organization.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the organization identified by the given `o sidebar_label: "Update organization" hide_title: true hide_table_of_contents: true -api: eJzNVktv2zgQ/isETy3gR3Y3u0B92iTtAsECTZDHKTDQsTS2mVKkSlJOvIL+e2dIybItI/vAHnqxRc4M+c03L9YywMrL2ZO0jv7nI5mjz5wqg7JGzuRjmUNAL8IaRY4BlPbCLuOSDMCov4A1hcrRBLVUmIvFNopXaoNGfCGt6/zLRI6kLdFF5et8d/DN3hmkUoKDAgM6RlRLQwtSjUeQVDGgEsJaHqPcP0aYqkCnsh6S49sdfquUQ7o6uApH0mdrLEDOahm2Jd+iTMAVOlJdWldASFu/ncummSdz9OHS5lu2OUVSfshIyxbfnVk62wQ2hLLUKosa02fP1vUQil08YxaYD8ekBYWepctK68+Rkp2mD06ZlWxGLVcnBAdQT8i1TXBOCl9w4VU4fbC2K8uhPBadTqFcsL5QBaxwLzSCyB5k00TcI4qnK4dkKGADAdz83TqE0s+m09xmfuLxG2XTRNlpqSFwxMZQqmkWTcbJ5L0IVlSltpCne70AQ1FaUGCMgATo+uOEnSlhy9h7ZxbWagROSkO0w0Jjlzk5lg4zdintkHWyqQeqoPXNMqbyMUVIWcpVBxnkWKiMtzagK/I/yiny9LsAH0Wcm86A5vp8HbPteAOOQ+7/2yFBBUbJhfPAyJp50/S7w9q8S+lPtdAcl1Lc8KU1PmXpz2fnwwq5+VOMxWcrukogo/Ozs6HeJYWqLbV/Uzc9oidJnHiKdfTyzXLqFIe5vUfFJ+esu2v9Y/cj8l9OeNh1N2FsEBR4+4L5j+zDh6EPH6sEEAVqLBj1D4qfhB6zyqmwjdV1ieDQXVQ0GmZPc+7XNEXWludMWcVbeWrM5JSH3LSOA6WRfIjbdMOmcpo0uiZDzWSSaVvlfacZNLb7KBG3bQMSV6wvLm6vJSPoAN4zQ8nbfZg7h/lG2c6j2HiiEtdt/PijG0bPLyGywszf9dPo0ysUpcbD+dD3GXO0PvRgt90PgX5v1/v31VLL73daJ3YdqOE+s7TRvzZ8LU3My98xyPFQGfXppMy5B1nMvcPo7MeE0k/pOKyX9vdeQEA4tOmenyYffp2cxT5vfSggpm5LTWp2B/PnGGfdV8H/+SBquQv4GniK0fOGAEZH6zZh21fZSM7SG4jSak0OsKCuqa/jo9NNw9uUD45rgT5pMqg0hCirc+X5m2K2BO3xDcfe3bUF/F78g+fUSexdMpitZBi64hV9fsXt7hlHk4acQEoXFwEm2VWCMY7DqLcddJxm1FlcZBmW4U3d/TZw+/jAJdU+3wqbs4mDF34Z0m+EaSMrsVLjXi01mFUV+5NMR3IBwmH9HtXr/rQ/JIIiFjUe7Fc0TbPjJfA6TuDmOyitATE= +api: eJzNVk1v2zgQ/SvEnFpAttNusMDqtEnaBYIFmiAfJ8NAx+JYZkqRCkk58Qr678WQsuUvZNvFHnqTODPkm8d5M2whYOkhn4J1pYdZBpJ84VQdlDWQw2MtMZAXYUlCUkClvbCL+GtdiUb9g+wplCQT1EKRFPN1NJdqRUZ8ta68ll/HkIGtyUXna7nd+GZnD8igRocVBXKMqAWDFUEOcQvIQDGgGsMSDlHubiNMU5FTxQDJ8emOnhvlSEIeXEMZ+GJJFULeQljXfIoygUpykMHCugpDWvr9HLpulsLJh0sr1xxziiS5z0jPFp9dWBPIBA7EutaqiB6TJ8/R7TEUO3+iIjAfjkkLijxbF43WXyIlW08fnDIldFnP1QnDHtQTdm0TnJPGF5p7FU5vrG1p+SoPTadLSAr2F6rCknauRiysO6qmsbgnEtMrRxhI4AoDutm7ZQi1zycTaQs/9vRMDsfKTmqNgW9shLWaFDFklELei2BFU2uLMp3rBRop7DygMgIToOtPY06mxjVjH5KZW6sJuShNozXONW0qR1LtqOCU0kqX9THtkStqfbOIpXxIEZmmYtVhgZIqVfDSCnWDIdlrZyGDOfpo4tp0BjXr83XEsaMVOr5y/982CSowShbOAyPrZl03rB5r8y6VP3Tsti+luOBra3yq0o9n58cKuflbjMQXKzZK6DI4Pzs79rtEKXqp/YxuBkRTqMh7LClm+aacNo7Htb1DxWfnrLvr8+P0I/LfTmS46W7C2CBQa/tC8lfO4Y/jHD41CSAJ0lQx6l8Uf5eBp6JxKqyjui4JHbmLJiwhn864X1cUlpbnTN3EU3lq5DDhITdp40DpgDdxq82waZyGHDZNBms1LrRt5NBpjhrbfbSI274BiSv2Fxe318AINgDvmaGU7S7MbcJ8IvTzKDae6MS6jR9/bYbR00uIrDDzd8M0+vyKVa1pfz4MfcYc/O9nsF0ehsCwtu39u26p5Q8rfRLbDtRxn1nYmF9/fT1NzMu/Mcj3oQryvTPXHhax9vZvZ/dOqEKl47Be2D8HQ5cBX20658P4w9nH8Vls9NaHCmPt9tykbrc3gA6BtoMM/s8XUU9eoNfAY0wZBhgzbfuK7Z9lGeTpETTLYGl9YEPbztHTo9Ndx8vPDTkWwyyDFTqVptC0Bak8f0vIF6g9vZHYu7tewe/FD7ynTmLfVINZA8PQDf9BBt9ovX3HdbMugyWhJBcBJttVgjGK02iIPWo5XbaJuCgKqsObvrt94PbxgTXVv98qKznE4Qs/DfElwbSRlSjVuNaCRlM2sUFB2pIViPsCPhDs7rjfJ6Jtk8eD/Uam67a8BP6PI7j7DqUJAVY= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the organization identified by the given `orgId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-pipeline-secret.ParamsDetails.json b/platform-api-docs/docs/update-pipeline-secret.ParamsDetails.json new file mode 100644 index 000000000..4ae64f5f9 --- /dev/null +++ b/platform-api-docs/docs/update-pipeline-secret.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"secretId","in":"path","description":"Secret numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-pipeline-secret.RequestSchema.json b/platform-api-docs/docs/update-pipeline-secret.RequestSchema.json new file mode 100644 index 000000000..7bd428ea5 --- /dev/null +++ b/platform-api-docs/docs/update-pipeline-secret.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Secret update request","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string"}},"title":"UpdatePipelineSecretRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-pipeline-secret.StatusCodes.json b/platform-api-docs/docs/update-pipeline-secret.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-pipeline-secret.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-pipeline-secret.api.mdx b/platform-api-docs/docs/update-pipeline-secret.api.mdx index be28d0716..62536ec0e 100644 --- a/platform-api-docs/docs/update-pipeline-secret.api.mdx +++ b/platform-api-docs/docs/update-pipeline-secret.api.mdx @@ -5,9 +5,9 @@ description: "Updates the pipeline secret identified by the given `secretId`." sidebar_label: "Update secret" hide_title: true hide_table_of_contents: true -api: eJytVdFO2zAU/RXLT5tU2m5jk9anAWISmrRVBbQHVInb5LY1OLGxnZYqyr/P106a0mZFTHtB1D6+Pvf4nJuSO1hYPrrjWmiUIscTi4lBZ/m0x1O0iRHaCZXzEb/VKTi0zC2RNWgW0UykmDsxF5iy2SYgFmKFObuP+1fpfZ/3uNJogKpdpdt647rSdQB6kAYDGTo0RKvkuf/hwU0dDxBERoNb8n2GsQbLiwyNSFpSxiMNPhXCoL/YmQJ73CZLzICPSu42mm4QucNFgM6VycDFpS+nvKp6WxprZR6thgRbJk8Fms0Bld8NsJvNW26fRvJo3blKN3Sms+siyMlqqC+UKF8zd3QAtJYiCdIPHiydKg8pqNkDJuEFDD2UE2hpdwWywB2YdUbkC1KFO+Ek/uUlJzWPioAvxQ8LVqvcxhs+Dk8Pu/r1g52wn4o1XfhDp8PhIe4c0n/puWV0xzO0FhZIjj8uRQM8KsalMcpM6v6o/cD8U0eHTRpYrhwDKdXa8yG4N3thhNuEAJwjGDRnhff76G5KbvDpWCpKkC5iYGiLD/YTPCib0FTkODSrJlOFkf7A0jltR4MBaNFPpCrSvsUnT6kvVEeyaIeNJTjyJ7sgPDsbX3Ei1PC9JnmjVLust2rRjY356fcsgPxK/Od74/yHtQs60LNNWutfPkOmJe6Ycqs/ZXGuwlX1M9SMieJrzZA0IvGTLYLJQ5AED70UalcebyMhQ0jn6lu74YmQyvGeD/2vn/tDWtPKugyCBetBEiNTj899hmXr4/8wdWvxHT67gZbgh5ZnFDora+90TP8eH21Hrn/hpW+AcGU5A4u3RlYVLcfZR5ZKhYWZpDzNQVo80tArk7GT7SNuDoZvY4HgwBUYQfe/kcu7ST0G3rNj345OTvUi5JtdMg3XrXjV1GOXCKmvROTi9kWkcHJDRdrjBzOLPj3xxFmSoHZHsbujYXx7Q7mqPxiZSumIgTV9Cf3fwFQFRUJcw1rJJeSLIkw4HktSCuFliPdCG5rq1MJ7JSBu1CPmVbWVxtFv0qWq/gBXuPGQ +api: eJytVV1PGzEQ/CvWPrXSkQSK+nBPBUQlVKlFfKgPKBKbu01iuDsbe48Qne6/V2vfJYGkQVR9S+zxenY8s9cA48xDegdWWyp0RQeeMkfsYZxATj5z2rI2FaRwa3Nk8ornpHq0imilc6pYTzXlarIMiJl+pkrdx/2L/H4ACRhLDqXaRb6qd9lVug5ASMCiw5KYnNBqoMKSIIW+DiSghYxFnsNbhrGGquqSnM7WpBwk4Oip1o5ySNnVlIDP5lQipA3w0soNumKaBejUuBI5Ln09hrZNVjQWxj16ixmtmTzV5JZbVH73wN1sPnL7OJInz6cmX8qZnV3XQU7VQSGBzFRMFcsBtLbQWZB++ODlVLNNwUweKAsv4OShWJOX3WcsatqAeXa6mokqwJoL+stLXnU8WgG+Fj8seGsqH284Gh1vd/XrhzpQP43qu2gTOB6NtnGnmP9Lz2tGd1CS9zgjcfx+KXrgXjHOnTPuqutP2g/Mv+zosE+DqgwrLAqzoDyU8pTVTvMyBOCU0JE7qXkO6d1Y3FASz40kyNYxMLIFw7cJHjZ9aFpxHLnnPlO1KyCFObP16XCIVg+ywtT5wNMTORxosyNZsqMuC2TxpzoTvDq5vAAh1PO9FnmjVJusV2rJjb355f8kgCDpfnzvnf+w4KCDPNvV2vrnL1jagjZMudJfsjg14aruGTrGQvG9ZkQanZHvwOIhzIKHXgu1KQ+VqIsQ0qn5tt5oExCV4z2Hg8PR0WAki9Z4LjF4sJskMTPd/HxLsVkb+T+M3U59phce2gJ1JYxCa01nnh3jP4F0NXPHCcyNZ8E1zQQ93bqibWU5Dj/xVK49TgoJ1BQLT3saemc07mT7SMut6dt7IFjwGZ2W+z/I5dNVNwc+q30fj52cukWslptkeq4r8dpxm8CcMCcXyMXts0jh4EaKrI9vDS359sQTJ1lGlvdiN2fD5e2NBKv7YpQmlyMOF/IpxEVkaoIiIa9hrYECq1kdRhzEkhJDfJ3iN6kNTe3Uomki4sY8UtW2K2lY/osubfsHqzPxtQ== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the pipeline secret identified by the given `secretId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-pipeline.ParamsDetails.json b/platform-api-docs/docs/update-pipeline.ParamsDetails.json new file mode 100644 index 000000000..0830c53c3 --- /dev/null +++ b/platform-api-docs/docs/update-pipeline.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"pipelineId","in":"path","description":"Pipeline numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-pipeline.RequestSchema.json b/platform-api-docs/docs/update-pipeline.RequestSchema.json new file mode 100644 index 000000000..c67ca9941 --- /dev/null +++ b/platform-api-docs/docs/update-pipeline.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Pipeline update request","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Pipeline name. Must be unique within the workspace."},"description":{"type":"string","description":"Pipeline description."},"icon":{"type":"string","description":"Pipeline icon URL."},"launch":{"type":"object","properties":{"id":{"type":"string","description":"Launch configuration identifier."},"computeEnvId":{"type":"string","description":"Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted."},"runName":{"type":"string","description":"Custom run name for the workflow execution."},"pipeline":{"type":"string","description":"Pipeline repository URL (e.g., `https://github.com/nextflow-io/hello`)."},"workDir":{"type":"string","description":"Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted."},"revision":{"type":"string","description":"Git revision, branch, or tag to use."},"sessionId":{"type":"string","description":"Nextflow session identifier for resuming failed runs."},"configProfiles":{"type":"array","items":{"type":"string"},"description":"Array of Nextflow configuration profile names to apply."},"userSecrets":{"type":"array","items":{"type":"string"},"description":"Array of user secrets to make available to the pipeline."},"workspaceSecrets":{"type":"array","items":{"type":"string"},"description":"Array of workspace secrets to make available to the pipeline."},"configText":{"type":"string","description":"Nextflow configuration as text (overrides config files)."},"towerConfig":{"type":"string","description":"Platform-specific configuration options."},"paramsText":{"type":"string","description":"Pipeline parameters in JSON or YAML format."},"preRunScript":{"type":"string","description":"Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"postRunScript":{"type":"string","description":"Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)."},"mainScript":{"type":"string","description":"Alternative main script filename. Default: `main.nf`."},"entryName":{"type":"string","description":"Workflow entry point name when using Nextflow DSL2."},"schemaName":{"type":"string","description":"Name of the pipeline schema to use."},"resume":{"type":"boolean","description":"Enable resume to restart workflow execution from the last successful process. See [Resume a workflow run](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run)."},"pullLatest":{"type":"boolean","description":"Pull the latest version of the pipeline from the repository."},"stubRun":{"type":"boolean","description":"Execute a stub run for testing (processes return dummy results)."},"optimizationId":{"type":"string","description":"Optimization configuration identifier. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"optimizationTargets":{"type":"string","description":"Comma-separated list of optimization targets. See [Pipeline resource optimization](https://docs.seqera.io/platform-cloud/pipeline-optimization/overview)."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to each pipeline run."},"headJobCpus":{"type":"integer","format":"int32","description":"Number of CPUs allocated for the Nextflow head job."},"headJobMemoryMb":{"type":"integer","format":"int32","description":"Memory allocation for the Nextflow head job in megabytes."},"launchContainer":{"type":"string","description":"Container image to use for the Nextflow launcher."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the launch configuration was created."}},"title":"WorkflowLaunchRequest","description":"Launch configuration for the pipeline."},"labelIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Array of label IDs to assign to the pipeline. If null, empty, or omitted, all existing labels are removed. Label IDs to be preserved must be included in your request."}},"title":"UpdatePipelineRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-pipeline.StatusCodes.json b/platform-api-docs/docs/update-pipeline.StatusCodes.json new file mode 100644 index 000000000..c0b40af3e --- /dev/null +++ b/platform-api-docs/docs/update-pipeline.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pipeline":{"type":"object","properties":{"pipelineId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"repository":{"type":"string"},"userId":{"type":"integer","format":"int64"},"userName":{"type":"string"},"userFirstName":{"type":"string"},"userLastName":{"type":"string"},"orgId":{"type":"integer","format":"int64"},"orgName":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"workspaceName":{"type":"string"},"visibility":{"type":"string"},"deleted":{"type":"boolean"},"lastUpdated":{"type":"string","format":"date-time"},"optimizationId":{"type":"string"},"optimizationTargets":{"type":"string"},"optimizationStatus":{"type":"string","enum":["OPTIMIZED","OPTIMIZABLE","UNAVAILABLE"],"title":"PipelineOptimizationStatus"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"},"resource":{"type":"boolean"},"isDefault":{"type":"boolean"},"isDynamic":{"type":"boolean"},"isInterpolated":{"type":"boolean"},"dateCreated":{"type":"string","format":"date-time"}},"title":"LabelDbDto"}},"computeEnv":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"platform":{"type":"string"},"region":{"type":"string"}},"title":"ComputeEnvDbDto"}},"title":"PipelineDbDto"}},"title":"UpdatePipelineResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-pipeline.api.mdx b/platform-api-docs/docs/update-pipeline.api.mdx index 014f0c527..9677e3540 100644 --- a/platform-api-docs/docs/update-pipeline.api.mdx +++ b/platform-api-docs/docs/update-pipeline.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the pipeline identified by the given `pipel sidebar_label: "Update pipeline" hide_title: true hide_table_of_contents: true -api: eJztWm1v2zgS/iuE9ku3sJ00295ejcPi0iR78F7SBnm5xW02gGlpbLOVRJWk7PoM//ebIfVC2XKsFMXufbgvbUQOZ4bDmWeGQ68Dw2c6GD4EmcggFino4LEXRKBDJTIjZBoMg/ss4gY0M3NgERguYs3k1H6Wq5iIIDViKiBik5WdmokFpGxcUoyi8eD39Pf05cv30sDLl0M2mrJxzCcQjyI9ZkKzcZrH8bjHIMnMqsekYjIRxkCEQ1+ENiKd1QLtSs24AqYgkQuIBmyUhnEeQc12yB7+Zv/ui6j/6qde/XHy0+OYGclwoVKofC3BMR6wSycAaSa4TwUaFAphSa4NjQgnC6XeScazDNKIcRYjE7JNXC1O8tiILK5NpXss16jjUTVw5KiPeIQ2CnqBzEBxsv0oqqx/XRDjdMYVT8CAonNbByl+IFltZyQRdGwZN/Ng+yxLPizNE1AirA9OkWgFn3OhAOUalUMv0OEcEh4M14FZZSRGpAZmoJB0KlXCjRv6y+tgs+lVuiyl+qQzHnrKfM5BrXa0+bUk3KPOc8Q/Ou1Bm3cyWtGaPTvPrUFZQYysQolcU0NL8CBjEVrjH33UtG69q4ScfISQFmaKjsoIDJphufmKShuF7vTEASD5gF0V7pSnAtVhS2HmIrXxUxlxEGy2mHSW4Q1bLiJ81nIiZ/c3l3ZtzPM0nB82g4gOS7i0vBiyn4pZ7py9cfQbOpUkyw1cpItRB45njppBuhBKpgmy8hiy5RwQKBqItRRxzFSeDtg5TDlGqQ3XyuoY8iLhasXCNs7TEpqsqsjlfafDP8PTlglJtcfP0Imrs57GcokoBGFeHVep6zOOTEEmtTASFceDYy9gMBv02HhuTKaHR0cz9K98MsA9HaXwxZDMvpBHc4hjOf7eCiVdzoU6LJOCl0WIFqEVR3BT2LnaDoWrSiASFHBTEYMDbDSCIuT0Dd9m5mVTwrbVYSF0p3j4hzCspO6xieLofDa/YPIj2YjHlqMGrQvYPcTyfWE9VqzxnY1OFfNFnlA6mWK6xLSBR64Ltyafv1bSmsMTxJXihJDCQKJ3FdjGgOCU6CnXVKo0wylzIqyjWQsTtq2sDrhfdQuhAvNNFCB2aAfLz6Y8/gkYX+DG+QQVwBE/8Cons2H2DdWoQ/d5ujiz3aEVn3HsTVtzlIUz7EVZTuiCwDm9Cywjl6DO7HCHgI65oRTX1xmE6FbhlkRpCZ1L2YJAd9tABRR1FYFRyn65/fCeAuLfp1eXzKVWx1rBTZ7eWgaHmZ9GVAO5EbQzNwWegZVBhk+nfZdHSipEWYpDiQQL+YkCpjIxOnCIwQVYi90CsIdrRA6OVRYCnOkThDoW+vFFiW6RDPVAw2csnwaIallpwzCWeXTkBGOVtcD4h+g73Fsf+fVLfv2CnzstGv02W+dTtDLjmG12t8bmfAEW+2IgXPszdppw0X2bMe4lRRdErWlduWNyc1fQFJg+ZGOaH6TTsRWC4KhW3ZLkr1UypDVoBMwiLl1idkkRbRpecn57eeLA25Zp3UQQ1c4VxjHw84EFcZ/dRMoYeLrD7yK16OLoiQP+ZbgyLYmdTRVWACQ45lj66TwkT5jmcekUhQ/cOF68ZoEH90wHCDluqe+0+s791+f9kiF5QuHreO+6pCue6bDXayQu9KcVDBHPJsBtc1b7rEsSd04mn2BgdbGqiyCKK1xjqyZbMIG7qL2oowjRPlcpi/IkWdlTiEvnJpxMxH+q69Qhz/jg0e+vT4swrYsuLXOFiceX1vWsSoP1/cVHlEgWApa7u7jjatbMmPtL4oT3NRDSI7ZUd1OfGVZAltsfvqPyht4h8e+/8+0tBSx3Njp3dQ8WaLOU/gKMh9pBqfYnHnPg0S9ycpblh6X+cLKLJXkyQXxHqWfX95pwXobW3mVxX0EVCWIf5cSXegUJBsbV5Gsku7WlRIst+0RS/k1gxicrjB7vOofliEGYhg7lfkXK8F40gwInd0U6xsUljm7aZwrIHm0Sqg0SXR+dBXbE3uEgYmmSOfR3wNNye1xiDRY6SQNqRgRGmBi8dOLunDfVrb/DjbTcW6Nc/FM8t6EFdc6oVdbaKaM6Y6uX1WySXfoSnmxtkdOsEAbKVknTrs2+VGnXzWaz3UVyiTTDatXdd06Oj3e7Mx/++e0aMS3X5gOUjczw1Km193gO9Wf2dl6sacrs2DpNd6vO2hFxewFUTP4slDZPUlzyJwikmnXWBWn38vH7g924VSv28qTb/UTEwrTbMQJbYLdUHTaktXHu3BWlOlQWXdP2Ft2t4SZvze6Q5gl16j9c342uRr9dnONY8ffpu8sL/Lp/f/qv09Gl/XqsI7WM0Q+7Yko864JmXfp9XxU7Cx7n7TNlGdJ+bEIXl4290yuUKcJ90yPqTmUy5nsd4/npy0dIi7Tnk3Mj7XDd0Py6JupTJiwrsD1WnLXDkqfrWaVcrfC2/+zObOcAh/KUBJDodRvOv8N65Cs673VGeQiwHtBYgFgPf9KIJeGTG79QSqodzX9oyVDlqwxLpbFF1xL1sdRvd6nPc7cdYAg81Mz8X92tbXuGubLA+bAO3gFWC+o0N3P8fKRXlQTMXNJLFDqIfX6iqcB7vlrXaXRDjzZUTRSPU7mKkba8NvBMDOwVob477BRit3aGlf0vdkb07PR6FJAupaq3ZCu3b1/hausksXw/sjFtiXDE/fFzGbgfl8bah87gpn49uvjCqSNTv+rsK4qrYZff6+/6tYRCuR5vvmrU49UTQj1UlzH1WNWc91ZWbfB6zGtk+6KbneeHcupxqyPsT+w2av1Zv3VaC2o0Or39eG1Kb7TRYfTGm/23esJvV/nJseoveWbwWkK+wVxXx71w+r2P4s2zbFC4z+08XzNqTe++C5QXhYfjx61r5nHLBfC45VLm+Z2firCGPnndP/6xf/L27tWb4ZtXw5O/Do5/fPVb84KCcinRpVNpQ6PAgCLCKKQOBR+FsghBF8QEYDy0ANYMbD+c0eIitnl/Kv9eT1Ced50inHs1ePtmcFy2WROeepHmckp129nWcV3D6P9/mPAH/zChAFd66qCej7A1kvWEdZEW/N+R9IKhd7+iCJAUZA/Bej3hGu5VvNnQsPtpAGWLSGjqo6KDT3ms4YmTP/TDgVZNPwGK2fpxQlF7Bja7LLgSpMAzlXlxU+Tr79mBn1e0qlWW3enK16dU1zPh5rHoGxEyoIaO4Mzp0b8jNjWDnQqDfp/hVpyGIWTmSVo/7V/f31HiLH5UkciIlii+JCjFf62uxXOULV5obI0olM5yW48EjiWlWd7M0ltZ2W6q1RroMZbiTn6CdLOpjGPom+yy2fwXT/nuvQ== +api: eJztGmtvI7fxrxDMl8tBLzuXphGKoD7bKZT67gw/GjSOAVG7I4l3XHKPD8mqoP9eDLkPSlpZ68Mh6Yd+skUOZ4bznuGuqWUzQ4cPNOc5CC7B0McOTcEkmueWK0mH9D5PmQVD7BxICpZxYYia+p/lKcJTkJZPOaRksvJbM74AScYlxCgd936Xv8vXr98rC69fD8loSsaCTUCMUjMm3JCxdEKMOwSy3K46RGmiMm4tpB0CT9xYLmc1QX/SEKaBaMjUAtIeGclEuBRqtEPy8Df/f5en3ZOfOvWP058ex8QqohagNU+hphAQ98hVIGAVmQDJNRjQC0hJ5ozFFR5opT1ypwjLc5ApYURwY1E2ojqcOWF5LmpRmQ5xBsi4Xy30A3Sfpem4RztU5aAZyn6UVtK/LoBph+ZMswwsaNTbmkqWAR3SWs60QzmqLWd2Tnd1WeIh0mWgeVIrTiNpDZ8d15DSodUOOtQkc8gYHa6pXeVIhksLM9C0Q6dKZ8yGpb+8oZtNp+JlqfQnk7MkYuazA73a4+bXEvAAOy8h/xi4B2PfqnSFZw7c3HmBkgKYdmiipAVp8QjLc8ETL/z+R4Pn1vtMqMlHSPBgrlFVloPB3XD5CspYzeXsGQWwDHrkXWFOTvLPDsiS2zmX3n8qIfboZgdJaxrRssfCkxcdR3Byf3PlzwrmZDI/LgaeHqdw5XGRRMkpn7lg7Fuq36BWstxZuJSLUQuM5wGagFxwrWQG0kYIyXIOGrYj1pILQbSTPXIBU+aE9e5aSZ3kmmdMr0jShHlahibPqnbyfSvlnztjVYZUvfrJVOlK11OhlgSeIHGVukpeX6AyDbky3Cq9QsWRV9Cb9TpkPLc2N8N+f8bt3E16icr6Ep4s0uxy1Z+DEGr8rSeKvFxwfZwmOi9JuYbEk8NwU8i5ug66q84g5ehwUy4gBGxjlcbIGQu+SczLbQq7UocFN6384R/ckhK6QyaayWTu84tlM6TtTHAyA8YUYfcYyveF9EhxJjY21KoG4zJMJ1PGBaSoclOYNdr8tVZeHBEhpjXDCMktZGafgd0YQM8QHnNNxcq2O+WBhDc0L2GMbSvPgzOgbyHRYL8KA4iOmIDPpzz2CQhbMC7YRACuxI5XGZl3s6/IRu26L+MliO0OnuwL1L4ta2aIhSdLXpXlhCkAgtEHx7JqCfrcL7dwaMEspriuySHhU57sUFQeMJiULwhMuwtUgaKuIgiX5JfbD+/RIf599u6KhNQaUGu4cfLWIziO/CzFGiisEDtntohn4Gmg4OW0G/JICZVrjn6oCJcL9QkdphJxrlUCxoDpkVsA8nCtgTCZklwZ28UQGlCYx1dldEtVYnoGPoNmPa76eSnDRCiX9gPhPksXTCaQfpNr6DKZdkt83QJf0Baufp2rs6kFTZgQDVcjc7YAH/sEYFz7M26aMd7+msKClszyBRA8V94YzTwUNEVMH5Ix7vfkdOyJgLR61S5J/lolQzxDcsWlDelyOQdJnNmykovbq9MQvH2Z1o4EQu21MAFBnA98EI/RTZQSwOQevkvpo0uARwwajGXaNiR2MtUq84QFM5YYl6AlTJ0ojaKwgZuAi9UotJMvNICEJXPoBq6+CX+6rFsiREsobN0JcYUtnm1x12snRME/niAL0D4B7oqzumddkgQ9WTe5cbKNVIMHoV9ZN/FVky+YIDRqr2ov0mCdliR1WbbyWhClcWOczPh/qnbqmGV8iOAP16eFm9ZFl1FOJ0Biam11VQqsGx/uYyJZcFju3+KO6dl2xjxcEmesawAjvYW06k1jZMQGbH/4jcoOvUXiP9zzHSwFPHYyugh1jzF8JvE/YMm8NlCs/RHHHFj6i5qc5+441e9O92OJyyagker59b3BOK8SL++yuK9CFRIiH9UkpvoOMqVX7yZfQjmcLSn62HKIJObfDGZssrJgonbuXEnLuIQW5X4FSnjGZlDEyX2SAXHRxGGnfa4B5dFEobogwnUtz2CP7B3PMJZmeYj+IfA0dI9LZkgSKPVwGEEttwKidBJ6zpuq62/RkZZ32yoX/xTL3eICJ2c4KmuclGGdsTPL2h6SXcUUnh1todGslNPlqGRbrttzqVKum81md4oUEmmupAn9zulgsD+d+fDPrzeIaWibj0BuZYbntNY84zk2nzk4efGiKbNj4zb2Vq25Q+DmAqjY/JlrY5+FuGLPACg9a82L0rODeOL5YDts1YmDOLG7n3DBbbMcU/AFdkPV4V3a2GDObaNUi8qibdregbu1zLrG7A7SZTip/3B9N3o3+u3ygnbK/8/eXl3SDr1/f/avs9GV//VYe2rpox/2yZTxrE00azPv+yLfWTDhmnfKMqRZbdwUzcbB7ZVkGU8ObY9wOpUrwQ4axsvTVxwhfaS9mFxY5ZfrgeaXDVGfE2FZgR2Q4qw5LEW8nlfM1Qzv2s/+zm4OCFEek8CmQ980xfm3LP2SyXudUR5oBsawGXgLf1aIJeCzF7/UWuk9zr9ryFDlqwyRyvqiawkp9dA/7kNfuHAdICAAh5n/q7f1Y8/EaR84H9b0LTAN+szZOR0+POKrSgZ2rvAlKneeKj4rDWn0fLWu0+gGH22wmigep5wWdEjLtoHlvOdbhLp32CvEbv0OKedf5Bzhydn1iCIvJau3KKtw75jh6upIsXw/8j7tgWin+Ofn0nE/Lq2XD+rgpn49unxiOJGpX3UOFcXVcsjv9e/6tQRduV7fftWo16snhHqpLmPqtWo4H52sxuD1WjTIjklvT54fyq3HnYlwvLE/qI1349FpTWhr0BndJxpTRqtbE8ZofXv+Vm/E46o4OVbzpUgM0UgoFliY6oQXznj2Ubx5lgOK8HM3z9eIGtN7bAJlo/AweNxpMwcNDeCgoSmL7C5ORfR0cPqmO/ihe/rj3cn3w+9Phqd/7Q1+OPltu0F5GDxiopNT5V2jiAGFh6FLHXM+dGWegCmAMYCxxAewbceO3RkyxoXP+1P193oD83yYFNEhPemdDE57g3LOmjEZuVpIKlW7s8vkuo6j//8y4Q/+MqGIrvjWgUMf7oskbwrrIi/EH5J06DBqsNAFFHrZA12vJ8zAvRabDS6HbwMwXaTc4CA1pcMpEwae0fyxLwcaOf0Eq72vE4rik/r0smCaIwMvZObVTZGwvyVHvq9oZKusu+Uq5qdkNxLh5rEYHGFoeFgXAOeBj+4doqkR7JUY+IFGOHGWJJDbZ2HjvH99f4eZs/iqIlMpHtFsibGULQOvxXuUr15wbU0FkzPnCxIaUGKeZdtpeict+0s1SmO9DhB36hPIzaYSjsXfKJfN5r9hBe7i sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -44,30 +45,24 @@ Updates the details of the pipeline identified by the given `pipelineId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-trace-begin.ParamsDetails.json b/platform-api-docs/docs/update-trace-begin.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/update-trace-begin.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-trace-begin.RequestSchema.json b/platform-api-docs/docs/update-trace-begin.RequestSchema.json new file mode 100644 index 000000000..fa1be9785 --- /dev/null +++ b/platform-api-docs/docs/update-trace-begin.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Trace begin request","content":{"application/json":{"schema":{"type":"object","properties":{"launchId":{"type":"string","deprecated":true},"workflow":{"required":["commandLine","projectName","runName","sessionId","submit","userName","workDir"],"type":"object","properties":{"requiresAttention":{"type":"boolean"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"ownerId":{"type":"integer","format":"int64","readOnly":true},"repository":{"type":"string"},"id":{"maxLength":16,"type":"string"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"runName":{"maxLength":80,"type":"string"},"sessionId":{"maxLength":36,"type":"string"},"profile":{"maxLength":100,"type":"string"},"workDir":{"type":"string"},"commitId":{"maxLength":40,"type":"string"},"userName":{"maxLength":40,"type":"string"},"scriptId":{"maxLength":40,"type":"string"},"revision":{"maxLength":100,"type":"string"},"commandLine":{"maxLength":8096,"type":"string"},"projectName":{"maxLength":200,"type":"string"},"scriptName":{"maxLength":100,"type":"string"},"launchId":{"maxLength":22,"type":"string"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"maxLength":20,"type":"string"},"defaultBranch":{"maxLength":20,"type":"string"},"version":{"maxLength":20,"type":"string"},"homePage":{"maxLength":200,"type":"string"},"gitmodules":{"maxLength":150,"type":"string"},"description":{"maxLength":1024,"type":"string"},"name":{"maxLength":150,"type":"string"},"mainScript":{"maxLength":100,"type":"string"},"author":{"maxLength":150,"type":"string"},"icon":{"maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"maxLength":20,"type":"string"},"build":{"maxLength":10,"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"maxLength":50,"type":"string"},"cachedCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"ignoredCount":{"type":"integer","format":"int32"},"succeedCount":{"type":"integer","format":"int32"},"cachedCountFmt":{"type":"string"},"succeedCountFmt":{"type":"string"},"failedCountFmt":{"type":"string"},"ignoredCountFmt":{"type":"string"},"cachedPct":{"type":"number","format":"float"},"failedPct":{"type":"number","format":"float"},"succeedPct":{"type":"number","format":"float"},"ignoredPct":{"type":"number","format":"float"},"cachedDuration":{"type":"integer","format":"int64"},"failedDuration":{"type":"integer","format":"int64"},"succeedDuration":{"type":"integer","format":"int64"}},"title":"WfStats"},"fusion":{"type":"object","properties":{"enabled":{"type":"boolean"},"version":{"maxLength":20,"type":"string"}},"title":"WfFusionMeta"},"wave":{"type":"object","properties":{"enabled":{"type":"boolean"}},"title":"WfWaveMeta"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean","readOnly":true},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"},"logFile":{"maxLength":255,"type":"string"},"outFile":{"maxLength":255,"type":"string"},"operationId":{"maxLength":110,"type":"string"}},"title":"Workflow"},"processNames":{"type":"array","items":{"type":"string"}},"towerLaunch":{"type":"boolean"}},"title":"TraceBeginRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-trace-begin.StatusCodes.json b/platform-api-docs/docs/update-trace-begin.StatusCodes.json new file mode 100644 index 000000000..3cd78e3ee --- /dev/null +++ b/platform-api-docs/docs/update-trace-begin.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","KO"],"title":"TraceProcessingStatus"},"workflowId":{"type":"string"},"watchUrl":{"type":"string"}},"title":"TraceBeginResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-trace-begin.api.mdx b/platform-api-docs/docs/update-trace-begin.api.mdx index e5421d4bc..326bd3f31 100644 --- a/platform-api-docs/docs/update-trace-begin.api.mdx +++ b/platform-api-docs/docs/update-trace-begin.api.mdx @@ -5,9 +5,9 @@ description: "Updates the workflow execution trace for the given `workflowId`." sidebar_label: "Signal workflow execution start" hide_title: true hide_table_of_contents: true -api: eJytWW1P4zgQ/itVPt1JBUIXbnf76Xg9oYWCaLmVDiGtm7jFu4mTdRxehPLfb8Z2YidxaXu3X1BxxjPj8bw8M34LJFkWwfg+kIJENHgYBjEtIsFyyTIejIO7PCaSFgP5SAfPmfixSLLnAX2hUYkEA7VrsMiEIliyJ8oH32q6i/jbbjAMspwKgtQXccNwhvuO6ZJxIMiJICmVVKAibwGHf4DQcgEShrrkRD4GXQW/1koVUjC+HLCYcskWjAogFfRnyQQFuVKUdBgU0SNNSTB+C+RrjkL0pqCqhi25RQ7qWcE/SypevZIV4YCXKRUsasvuyWJc0qX6BPZKidRLfxyA9AetKi3kcRa/4p62KGWuwRztNTCEwCbKgCOXSE7yPGGRsvLe9wL3vPUVyObfaYQbc4F3Ihkt8GtCSh494uV0zYInzgUFvrUJq2FzL0hu7XsP2qQp4fEl41SLQGETtCkcruTmV0GLQrsC/C7nKUN9yoIK8x25nzKBjvi+1kZ0cSTRBkwf2WyZZ1lCCQ9A20ISWRa+o1G4NdR7end8dTGbnZ3C2u3dZHIx+Qt+Te9OTs7OTtXq+dHFpfpxcjQ5ObvUv+8mXybXXydKUSYT6rjiVMsE6dkzp6Jl2ZVOgB5A4muevDaWFjTPCiYz8erxWHBNxTclL5eULyEyxvt/DPtUxsgeAzQKYEDuSAb21wYTW5DDrecJxO7mO/CfEzir8qmNNg0DXiYJmaORdRz3TJWQQurM8guZ1l7btvKn0Gflxq3bxB98VwKOvGBJl+9+6GNcx4PPATDimOzJPPDxaUJsA1qdeTbjK+gTK0z0rT2MmyK6Rv28wlJNFmlvGHkFaM095H593Mzn8h55decLtjyHe3OzCRGCYGVgkqaeLFNVproVvjRM4phh5iLJjZPajPNpeTP64glG+Ax2ZAssA2vTOwcWmJX+hvrav6iRzy4xXZAykceCgHk22fC0Oe/HLKU3ZLnZfS6ZTLO4NDZ37/PQr7dTNDv3PzrwbOAeT/FyTgnjU8V7I8cipXzMxEacWdS32+Fhj7Byysziqr58PIK53vWOsMUlzUuW9KqLjxBTKVSMNN80/7fOMal1N4XaGyXtQ2C9KQE/ArPztHsZXgNHBHBQfJKV3A0Wfx3+MMIdCwJRvtUOtuSZ2G5LUUYR3W6LcxJzdk+1t1xX0TjHW0XinmcVjdbmJnK/AqSat5WH6yXSSt2Y3BxkY3qj8cb0WvvTUncmG6H0+gxbbjIn2WpXK0qmKjJQfFm0GayIEcoR1rhAyAHEG2eBlg7nSvQVlUSBEvJE/5caLd5fgVvNmQqRiSsAU6ZC9LxOEdwCMPaBVFUCEI36hHoAnoEXq/AVlqrV2ItLqAl0zdczvjRgZwVWOTdAcAU2WSU+3s4H6QuT024n9F6qgcaqTKnfg5RDF4X/Y5Itz/vY1lfRoDsq5ea07hChXZc8hcn1r7pd1feNmiM+3BLEyeyZikt1JWv82U42bk2jXlVVdxKhLZxnvNCKAPrpN/3XX35dj7++DVbSvly7/aw6yo22GRDbttYZzfic85nI6PFOJCtM6TGUNgVaCggOfMY4JvF/mXy4A4rUpJW1o4V0Zf5x1D/Tiaij+QfPNdaeO+CZHJAE7Ab6VKppjErB5Kuaeh1TIqg4KtGl7x9wIpRSAJE4MgPAo6Zk+CnYUyO3vTd7B9Xe3AzSoMd7qqdoJdo/eJQyL8Z7eyRnu1GSlfFuQX+CPrss682zpurL4CYhEhPC4ATpB0c3FwFqUys7RdtqO7kqN6ZCifX0S8WIIoIV/eO8TjXfn6UyAt7ZrZ19nb0QHCggQ8+gyZ32mImecezWGMcdnFhPx3mJ/a+ei0DsjQ52wo87o8+z/cPx4f549Gk3/Lj/T9DMQt4jsfOP96iaSYIj304M7GIzGbBLzQDALtm+367Z/t4R0fTxds32621+TVveUsY2312u3VXbSrt8nZb5vl5/cFriTp9rt7rtba+BdceTrUbVfnjq09rG0665/aXL1Q2LZpl3juz2hHa1bv0cv4tcPp2WzaOoab7sgtNkrXYyt4XqNknOlbjNUNhpdcJuIxN225Sw34S4EdXpPZxOsNNyOMbpdhpdXRWiD1v9Q9huD8I2+g/74D7sQ/fQA8zDFsZu4KtONL2LcnBwi7SHYp1a64LXXqB1orxBn62AqkGnZ7HGmt1QPe9kFAdZOj7vWsaFi6EFgybj1vBP/9sAPsurwXXOUusNqDXgcxCZmyNaiMvYlfFFpkqNqcGmYmGJWlfMsDQyEGWIldF0r9gulG55BAzBEoWKF9mf9oPbRAX7u58Pd0N1lKyQkLZUxtKZYgpuSRLfs5kuLL2BVQNrfsWzm6nHEpLNXp6Ah6gxsEZlGkvUj37DYNx6bNNw4gFdEDPwffD2NicFBURXVbisn8MQZMSsMJ6/IElB3znQmscyr7I/KNbv9nvcE0lKpFSY5IkIpif4W+ny261Bhb8P3n099CpV9wz81dXGVdbYsXrAFhJaTgxX0E8TnGgtdmbIxjLooVh8kNQ7jiDccvkurQsWb+5meIXmGRGqG24R5BlrP/xVumbKKPoZjTzrN0C+LHW20iwrM8V0u502klOH8loD3EVRzLIflIPL1MaR+D/apar+BeZNY7w= +api: eJytWV1v2zoS/SsGn3YBNVHc5H74aZM0WQRN0yB2tsAGAS4tjW22EqmSVJzA0H+/GJKSKImO7d2+2dRwOBwOZ84ZboimS0UmT0RLmgB5jkgKKpGs0ExwMiGPRUo1qJFewWgt5I9FJtYjeIWkRIGRmTVaCGkEluwF+OivWu4m/euIREQUIClK36SNwhnOu4Al4yQiBZU0Bw0SDdkQTnMgE9JqIRFhaEtB9Yr0DfxWG6W0ZHw5YilwzRYMJImIhJ8lk5CSiZYlREQlK8gpmWyIfitwETuJVFXUWVcVNIF24Z8lyLfgykZwxMscJEu6aw/WYlzD0nxaCJlTbYd+OyVV9WxNBaUvRPqGc7pLGXeN5uivkRMkEUkE18A1itOiyFhivHz8XeGczdAAMf8OCU4sJJ6JZqDwa0ZLnqzwcPpuwR0XEhKqaxdWUXMuKN7694kkIs8pT28ZB7sELnaHPo2ILLn7pUApGwoRUeU8Z2hPqUC676j9E5MYiO9b7ZZW5xp9wOyW3ZS5EBlQTqqIKE11qUJbA17maPf08eLLzWx29YlE5OHx7u7m7t8kItPHy8urq09m9Pr85tb8uDy/u7y6tb8f7z7fff12ZwxlOgMvFKd2zSoiYs1Bdjy7NQgwAmj6lWdvjaclFEIxLeRbIGIjwozenL7eAl/qFZmc/BYNpZyTAw5oDMAL+UGzHJzD5AHiiciLDDTsPwP/XEqwMbXXpIjwMsvoHJ1s7/HAVRlV2maWX6i0jtqul/+IQ15uwror/DF0JIUUC5b19Z7EIcX1fQgFAN44pgdrnob0NFdsD1mbefbTK+GFKXf7dm7GTxF9p/65xVNNFulOGAcXsJYHxMP2+JnP1z0O2s4XbHnNMvCzCZWSYmVgGvJAlqkqV91UKA3TNGWYuWh276U2F3x2vRm8Bi5jFZGccrbAMrAzvXN41ZiV/gMycFDjkF9SWNAy0xeS8mS1z4SX/XWvRA73dLnfeS6ZzkVaOp/753kWttsrmr3zH58GJvBApAQ155TxqdG9V2DRUq+E3EszS4Z+OzsbCFZemVl8qQ8ft+COd3cgHHBI85Jlg+oSEsRUqjTNi33zf2cfd7XtrlAHb0l3E1hvSg0zlsN13j+MoIMTmqwgvRQl9y9LuA5/HOOMBWXZYTPYkgt52BRVJgkcNsXbidt7oNq3WrfJeNvbJuLvZ5uMteY+8b/yMp93jV9kgup21b3F3Ub2lncW7y1vrf9UWmayF0qv93DgJLeTg2Z1bsnU3AxcvlRdBVvuCHCENT4Q8gDx3lmgY8O1WfoLaGpACX2B/8uMju5v9AVqzSClkF9AKVchBlFnBB6gECGQakoAotHQogGA5+DFNnyFpWo79uKaMg47vl7xpQM7W7DKtQOCW7DJtuXTw2IQXpme9pnQe6lGgipzCEeQCWilwh8zsbweYttQRYuIKPX+sn4ToVuXAoWpGpIyByfRcsSHB4I4LdYgb82R7IjntrPx4Ih6VVX9ToT1cCG4soaM43hI+r9+/nUcfzcNNqt9/urzWbOVe+szxpctrfVaM6HgXFOdrB5ltsWVAUdZV6CnqoichpxxQdP/pfPhNyhyl1Z2thbyrfnHM//KJqKe5R8Dx1hH7ogLPaJZJtaQGlUKklIy/Wa6XhdAJcjzEkP66Rk7QjnolcCWWVEaG7H7NSHHpuV2vGnPoDqeu0aaAvlSd9FK9D9ZaV2oyfExLdhRkokyPVLwEyQ9YmLQz5qaL6P7jGpMCKNLlB+d398QtKY2doq+tX7yTW5chSvW3S9zR4wQidyP6zrVfF9r4wQ8s4e293X1SrGhgAoDjSa/2+M6ei6wO20cv3HSRjr2S9p/dV+EjOPx6Yf49w/jP2cnZ5Ozk8n4j6P495P/kqYX8p5I2/94T6rpJHjrtx2DdrDpDLRDTQOgHWp5fzvW8ntviYbHt2MtX+/qa2h5x5iWfPe19kdbKu3r9SjzUz3+7FHiHs9tp/r0dkBg/fZkh6i2H16Gsi3xbMd8fulr9a9FM8x7W/Y5YTtaUz8v7hJfT4+yBQx15Ksd8EjW9iDzKVSfJHlH4pOhuEd14j6Rifs0JR6SEP9G9biHxwR7lMNzTp9p9G01iD7u8Ie4Sw/iLvqPh+A+HkL3OADM4w7GbuCrTTSDg/JwcEd0gGK9WuuD18FF693yBn12LlQNOgODNdbsX9XrXkbxkKUX875nfLgYt2DQZdwa/tm/DeBrdTW4zhvqvAF1GnweIvNzRAdxOb8yvhCm1Lga7CoWlqhdxQxLI0tAOWHjNMsVu4XSL4+QU5YZVLwQ/2o/+CSKnBydxOOj2OxFKJ1TEzsuVUzZktMs9G5mK8ugY9Xgml/x7uYKsoZXfVxklBl8XlpYZsFE/eoXkUnntc3iiWeMQUzBT2SzmVMFjzKrKhy272GIMlKmXOgvaKbgnQ3teC0LGvsD3gYPci80K1HSgJIXKplt4R9kyz8eHCz85+jd58OgUTVp4G++Nb6xzo/VM3JIoCne16eNE7i0VnyYoZpWwQDG4ouknXGeJFDod2V9tHj/OMMjdO+IuUhxiqRrLP50bW0Vxin2HY2u7SMgX5Y2XVmVlWtj+nSnC+XMpoLe2GysxEz8AF5VjXM0/ke/VNXfpnJj4Q== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the workflow execution trace for the given `workflowId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-trace-complete.ParamsDetails.json b/platform-api-docs/docs/update-trace-complete.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/update-trace-complete.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-trace-complete.RequestSchema.json b/platform-api-docs/docs/update-trace-complete.RequestSchema.json new file mode 100644 index 000000000..13e1cc0a5 --- /dev/null +++ b/platform-api-docs/docs/update-trace-complete.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Trace complete request","content":{"application/json":{"schema":{"type":"object","properties":{"workflow":{"required":["commandLine","projectName","runName","sessionId","submit","userName","workDir"],"type":"object","properties":{"requiresAttention":{"type":"boolean"},"status":{"type":"string","enum":["SUBMITTED","RUNNING","SUCCEEDED","FAILED","CANCELLED","UNKNOWN"],"title":"WorkflowStatus"},"ownerId":{"type":"integer","format":"int64","readOnly":true},"repository":{"type":"string"},"id":{"maxLength":16,"type":"string"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"dateCreated":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true,"readOnly":true},"runName":{"maxLength":80,"type":"string"},"sessionId":{"maxLength":36,"type":"string"},"profile":{"maxLength":100,"type":"string"},"workDir":{"type":"string"},"commitId":{"maxLength":40,"type":"string"},"userName":{"maxLength":40,"type":"string"},"scriptId":{"maxLength":40,"type":"string"},"revision":{"maxLength":100,"type":"string"},"commandLine":{"maxLength":8096,"type":"string"},"projectName":{"maxLength":200,"type":"string"},"scriptName":{"maxLength":100,"type":"string"},"launchId":{"maxLength":22,"type":"string"},"configFiles":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":true},"configText":{"type":"string"},"manifest":{"type":"object","properties":{"nextflowVersion":{"maxLength":20,"type":"string"},"defaultBranch":{"maxLength":20,"type":"string"},"version":{"maxLength":20,"type":"string"},"homePage":{"maxLength":200,"type":"string"},"gitmodules":{"maxLength":150,"type":"string"},"description":{"maxLength":1024,"type":"string"},"name":{"maxLength":150,"type":"string"},"mainScript":{"maxLength":100,"type":"string"},"author":{"maxLength":150,"type":"string"},"icon":{"maxLength":255,"type":"string"}},"title":"WfManifest"},"nextflow":{"type":"object","properties":{"version":{"maxLength":20,"type":"string"},"build":{"maxLength":10,"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"title":"WfNextflow"},"stats":{"type":"object","properties":{"computeTimeFmt":{"maxLength":50,"type":"string"},"cachedCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"ignoredCount":{"type":"integer","format":"int32"},"succeedCount":{"type":"integer","format":"int32"},"cachedCountFmt":{"type":"string"},"succeedCountFmt":{"type":"string"},"failedCountFmt":{"type":"string"},"ignoredCountFmt":{"type":"string"},"cachedPct":{"type":"number","format":"float"},"failedPct":{"type":"number","format":"float"},"succeedPct":{"type":"number","format":"float"},"ignoredPct":{"type":"number","format":"float"},"cachedDuration":{"type":"integer","format":"int64"},"failedDuration":{"type":"integer","format":"int64"},"succeedDuration":{"type":"integer","format":"int64"}},"title":"WfStats"},"fusion":{"type":"object","properties":{"enabled":{"type":"boolean"},"version":{"maxLength":20,"type":"string"}},"title":"WfFusionMeta"},"wave":{"type":"object","properties":{"enabled":{"type":"boolean"}},"title":"WfWaveMeta"},"errorMessage":{"type":"string"},"errorReport":{"type":"string"},"deleted":{"type":"boolean","readOnly":true},"projectDir":{"type":"string"},"homeDir":{"type":"string"},"container":{"type":"string"},"containerEngine":{"type":"string"},"scriptFile":{"type":"string"},"launchDir":{"type":"string"},"duration":{"type":"integer","format":"int64"},"exitStatus":{"type":"integer","format":"int32"},"resume":{"type":"boolean"},"success":{"type":"boolean"},"logFile":{"maxLength":255,"type":"string"},"outFile":{"maxLength":255,"type":"string"},"operationId":{"maxLength":110,"type":"string"}},"title":"Workflow"},"metrics":{"type":"array","items":{"required":["process"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true},"process":{"maxLength":255,"type":"string"},"cpu":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"mem":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"vmem":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"time":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"reads":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"writes":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"cpuUsage":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"memUsage":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"},"timeUsage":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"mean":{"type":"number","format":"float"},"min":{"type":"number","format":"float"},"q1":{"type":"number","format":"float"},"q2":{"type":"number","format":"float"},"q3":{"type":"number","format":"float"},"max":{"type":"number","format":"float"},"minLabel":{"type":"string"},"maxLabel":{"type":"string"},"q1Label":{"type":"string"},"q2Label":{"type":"string"},"q3Label":{"type":"string"}},"title":"ResourceData"}},"title":"WorkflowMetrics"}},"progress":{"type":"object","properties":{"pending":{"type":"integer","format":"int32"},"submitted":{"type":"integer","format":"int32"},"running":{"type":"integer","format":"int32"},"succeeded":{"type":"integer","format":"int32"},"cached":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"aborted":{"type":"integer","format":"int32"},"stored":{"type":"integer","format":"int32"},"ignored":{"type":"integer","format":"int32"},"retries":{"type":"integer","format":"int32"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakRunning":{"type":"integer","format":"int32"},"peakCpus":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"processes":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"name":{"type":"string"},"pending":{"type":"integer","format":"int32"},"submitted":{"type":"integer","format":"int32"},"running":{"type":"integer","format":"int32"},"succeeded":{"type":"integer","format":"int32"},"cached":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"aborted":{"type":"integer","format":"int32"},"stored":{"type":"integer","format":"int32"},"ignored":{"type":"integer","format":"int32"},"retries":{"type":"integer","format":"int32"},"terminated":{"type":"boolean"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakRunning":{"type":"integer","format":"int32"},"peakCpus":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"TraceProgressDetail"}}},"title":"TraceProgressData"}},"title":"TraceCompleteRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-trace-complete.StatusCodes.json b/platform-api-docs/docs/update-trace-complete.StatusCodes.json new file mode 100644 index 000000000..bdc346844 --- /dev/null +++ b/platform-api-docs/docs/update-trace-complete.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","KO"],"title":"TraceProcessingStatus"},"workflowId":{"type":"string"}},"title":"TraceCompleteResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-trace-complete.api.mdx b/platform-api-docs/docs/update-trace-complete.api.mdx index 61ccd6862..bee9eb3fc 100644 --- a/platform-api-docs/docs/update-trace-complete.api.mdx +++ b/platform-api-docs/docs/update-trace-complete.api.mdx @@ -5,9 +5,9 @@ description: "Updates the workflow execution trace for the given `workflowId`." sidebar_label: "Signal workflow execution completion" hide_title: true hide_table_of_contents: true -api: eJztW1tP5DoS/iutPO1KDJgGzjnTT8t1hWZgEJcdaRHSMYm78UziBMdpQCj/fV22E9uJuzu9O9KKAy+QdsrlclXZrip/eY0EnpXR5DYSHMckutuIElLGnBaC5iyaRDdFggUpR+KBjJ5y/nOa5k8j8kziCghGqtdomnNFMKNzwkZ/NnSnyZ+b0UaUF4RjoD5NWobX0O8wz4qUCCJpCsxxJh85yPIaMflD0lpGkoSCOAUWD1FXxu+NXKXglM1GNCFM0CklXJJy8lhRTuTQgldkIyrjB5LhaPIaiZcCBtGdorre8MYtCymhHfixIvwlOLIiHLEqI5zG/ti9sSgTZKZeSZVlWOim33bl6HdaVFKKgzx5gT7+UEpjo9iobGRoJac4l0yZgB64KFIaK11v/Sih22tfhvz+B4mhY8HBMoKSEt42uoZnq7NbyT7LMEu+UkZ0H+h9DnqSAlfMPJWkLLWF5XN1n1EYoCoJN++B+xHl4F/LxTBDl/sCJkX1HEyX+zxPCWZRLccQWFRl34obEZGWALmvbg7OTq+vj49k2+XN+fnp+T/l09XN4eHx8ZFqPdk//aoeDvfPD4+/6ueb8y/n376fK0GpSInjXld6TDl6/sQIB29ebViwKk6+sfRFO2ANDUVeUpHzl4AXSndTfDP8/JWwmfT2yfZvG30qo+SAAloBYJ19ElTqXyuMr0He+NnwHvDjUM5VkGRgp42IVWmK70HJem32VJXiUugN4xcybbzW1/IfKKTl1q194p2QSaQjT2na5buNQoyb9RByAFhxVPTG3A3xaZfYAFq9mwzjy8mclmb1rZyMu0V0lfp5gabaXcTvMA4OoCUPkIflSXHF4ofeRMfjoOxsSmcn0m7uboI5x7DbU0GywC5T1+bEKkP7Kk4SCjsXTi+crc04nx7vmjwHFqN8LfVIp7Cvr9yvmWQBu9K/5JnZN9Q4pJeETHGVigOOpXqGdJgP5/2QZ+QCz4bZc0ZFlieV0blrz72w3M5B2LH/eDfQgQU8Jcg5w5RdKd6DHAtX4iHngzjTuK+3vb0eYe0cM9OzxvgwBWPe1Y6whpHuK5r2TpcQIWyl8sTIiqH7vzeP80Z2c1AHV4k/CThvKhkWSmYnWdcYQQXHWAY2yWFeMXexhM/hnTH0mGK5ytfqQWcs5+t1Kas4Jut1cWZi5h447S3XRTTO9BaRuPNZRKOluYjdtzKkuveFl+bFwo46mNxMZDC9kXgwvZb+qNIJx6DIu5nDmp3MTNbq5a2SK7UyYPiq9BksWCOEQVjjBkJOQDx4F/BkOFFDnxGBVVCC5+R/EsPj/V1yazgTznN+JoMpc0L0vE4RXMrAOBSkqiMAotHQoIEAz4QXi+IrOKoWx15MyDOBrHh7zGYm2FkQq5yYQHBBbLJo+GQ9HyTPVFx1M6FlW41MrKqMhD1IOXRZhl+m+eykH9uGTjSZHVViOK1bG/DPpcDB5PpXk67CKU7k+3hp/OZmtNI91ERX5qJ0YIbnZxzaARtVrtRAXFQDknPMmaRfM0TNwHiDts2MDiR83B5INx5ItzNQQPw8eCZf8T1JF0TXz4tfPm4veTde8m5n0TvHXS9JmVc8JkdYb4gZyT6s/u6sPv8w+3s0u0qRPsz+3swOcemA1PfD7n8xuz9xabcPw78/w8tQ/qaT4X6Y/n2YXgZ2H6Z/n6aH6O7D9u/R9oFy1JkpRdW6CjTjfkVtgV8UhCUwlCVcfsUAV/9+NXRp0a9ibB3uqq49mLuuuA8k1pX2gcT4PufDZ1mKnA8mNtcKQxUIRvUiumXU0oWTw2JASVbXcIH8jGQ+GmRZh4Lgn5drmRR6rCERkK8nkS53DrpBX1RqZQl5Hjid5na3t4Q/ltFfaBkJwuUhgMOXPu9wmTmHjYICXpjT5YgI6Q3y/UKC7lnlYS8vDY5Q9fexkqqhLHJmVvYYIfjnwxK/fYl+GQRxNahPjfblm4vOa+YKO5AktiA9Bzy69EzvqENPGPQhaXZDUz7AyX8Dv3SvoDJzFXq36goqW3hn6szgWF+ediTfCRiruW0bsVyMcCq1I+UB8pLEFafiRaFvDwjmhO9XcGl1ewfI1IyIhxzQu0WlZAQU7iTaUujfrVer6XortpjekvB5A+ituIysogchinKytYULuhmneZVsluRRirRJ86gLrb1Sb0YXKRawFEaHQD/avziNQKBG3itQr1aVK3WrLRgxMkBctYEoItmiH06aRfbjSSg9gNkuLQz3+BnDdFTs3sfHuiBVAy42HuyhT128p3VpuFy0vxo4p1xk491P6PdP48/X23uTve3J+I9N9Pv2v6MWwrmMxMI2l1G1AEhnfAt0tI0toNE2tbhF22ThirbNwhKdIVr4oW2zMEOfX4sm9ISxmMEu126rRQC6fB2k323Tfucg+Wofnme7uqi8Hu7OknXwdfbFvE9r8XK2zYXFuVzdZdE2s86UXSibbW0Qa47fxS6f2keaBQQ1mDHb4GDDFjtZ7SC/utguxyQuhgt1EFqoi79CXXQV6mOn3BXVgUw5ALYOUspRThcg1ZVVAZFaSZtfLqoJ+aAl1Mcktd29ph6eCNUuNKhF3eiNpmeo2sJ3PNK6C75xDlUXc9NbaJ1V3oJmvAXVYGUCjQ1EprtUTzo7igOIcXze1YyLckEWw2J23Aa1on+2OBXLq4WjOE3eFylOYaEBktxq8AdyoBzOFDViwxZz3M1EF2uQqcUgXWpBupKCdKEEmToIcssc7kJ+7rW1RQ2nadxv2uk01S3Q4G0IO39T0jbXum9D2vY28m2Iay/R3oa87t3P25DYvbJ4GxJ7lfa3IDJkKm4VuC1QIa/8hJziEvJKR8gWhpAt+yCnqINsyQY5BRnklFuQWyxBfikEdQodyC1jIL9IgbxK321btEP9YPT/NlG3atREBL9i6vUdZIeUTXOVXJrE2+SokJSuSl8hGaZSd4ZYhUka1O6nxm5CTDKo7EzUsP+wL2o3/Nve/Ly3iVQ9KS9Fpm+KjDmupJZwGvps1+SJwKL3eU1b0PgV3/6aNFzIHGOrSGVgCJKqGb+aKsKt+fJ4I5p4n/u2qewdBJ+Qe91Gr6/3uCQ3PK1raNbf5IInJrQ0Me8UpyVZMqcVX+wG5f1JIHP3Pwqe47QCSlWNmGNONQB4LVn+dmlKQn8fLf2EOShUU2dnL640rrBGldJ1pQbl6Q+BupRPExxqKT5dAxvLoFfCgq+idY99uVgLsZTWrRRd3FxD9mi+ZZZ5LXTh+AmyfvlXyZorpWiANlYJaIrZrNJ5imYJyw77NZ1ODUdNKqgN6S6K4jr/SZh0mUY5An6DXur6P2muDfs= +api: eJztW1tv2zoS/isGn3YBNWGc9lz8dNJcFkGbNMhlC2wQ4DDS2GYrkSpJOQ4M/fcFL5IoibblswUWOcmbTQ6Hc+FlZvhphRSZSTS5R0qQGNBDhBKQsaC5opyhCbrLE6JAjtQcRk9cfJ+m/GkES4gLTTAyo0ZTLgzBjC6Ajf6s6M6TP/dQhHgOgmjq86RmeKvHHfMsT0EBilBOBMlAgdCyrBAjGaAJahihCFEtTk7UHHVl/FrJJZWgbDaiCTBFpxQEipCAHwUVkKCJEgVESMZzyAiarJB6zvUkdhAqy6g1r8xJDM3EPwoQz8GZDeGIFRkIGrfn7s1FmYKZ6ZpykRFlm355j8rywYoKUn3kybMe057KWGwUO5ONHC2KUMyZAqb0CJLnKY2Nrfe/ST1s1ZeBP36DWA/MhfaMoiB1b2Vr/bux2T2KeZYRlnymDOwYPfpS2ylComDulwQprYcjJIvHjOoJCgnC9WvuJ1To9bVZDDe1PFJaKWp1cEMeOU+BMFRGSCqiCtn3YoSAFZmW++bu48X57e3pCYrQ9d3l5fnlv1CEbu6Oj09PT0zr2dH5Z/Pj+Ojy+PSz/X13+enyy9dLIyhVKXjL68bOWUaIPzEQejVvd6z2Kkm+sPTZLsBSN+RcUsXFc2AVRogavhlZfgY2U3M0Ofgl6lM5IwcMUAug99k7RTNwBhM7kFfrbPgI/edYAFGQDBwUIVakKXnURrZ7s2eqlEhlD4yfyLRatW0r/4ZDVq6XdZv4MOSSXPApTbt8D3CIcbUfQgtA7ziqenO+D/Gpt9gAWnuaDOMrYEGl231blfGPiK5Rf19jqfoUaQ8YByewkgfIw/KkpGDxvKfoeByUnU3p7Iym4J8mRAiiT3uqIAucMmXpbiwZOldJklB9cpH0yjva3OKz893CMrAZywhlhNGpPte3ntcMlkqfSv8GEXDUOGSXBKakSNVHQVg8HzJgMZz3nGdwRWbD/DmjKuNJ4Wzu+/NDWG7vIuz4f/w+MIAFVkqQc0YouzG8By0sUqg5F4M407hvtw8feoSld81MLyrnaxWce7cvhB2c9FjQtHe7hAj1USoVyfKh539Lj8tKdndRB3dJWwl93xQKbmkGZ1nXGUEDxySeQ3LMC+ZvlvA9fDjWI6aEpruNoDPGxW5DZBHHsNsQTxOne+C2b7iuo/HUW0fi67OOxkpzFfu9rMge28JPU05UM+tgcqfIYHon8WB6K/1JYROOQZF3pcOOg5wmO41q7ZIbszP09IVsM1izR4DpsMYPhLyAePAp0JLhzEx9AYqYoIQs4H8So8X7K1lAxRmE4OICpHQ3RG/VGYJryHkoSDVXgI5GQ5MGAjwXXqyLr/RVtT72YopQBlt6T9nMBTtrYpUzFwiuiU3WTZ/stgZhSdVNNxPadNQIkEUG4RVkFrSU4c6Uz876sW3oRosQL9RwWr820L6XAhdT2U/KzC0OStB4Y/zmZ7S54EbRrbkoHZjhtTMOuwArU261QJwXA5JzIhhlsx1D1Ew7b9CxmdGBhD8OBtKNB9IdDhSQLAdr8pk8Qromul6u7/xxsKFvvKHvcF2ft1yvQfJCxHBC7IGYQfbm9Vfn9cWb21+j202K9Ob21+Z2HZcOSH3f/P438/uToAreHP/6HB/nxV0nw31z/etwfQbZm+tfp+t1dPfm+9fo+0A56sKVokpbBZqJdkVtzbrIgSV6qm3VpuqJQT/9t6uhG4t+BWO7cDd17cHcbcV9ILGttA8kJo9cDNdSKi4GE7tnhaEG1E5tRXSbqFNOkuN8QEnW1nA1+QVkbTTIpgE5kO/XO7lUj9hBIk2+m0S23DnoBX1dqZUlsByoTvW629vCb9vob7SNFIiMMhJ+9HmF28y7bAwU8MrdLiegCE1RuZ6ge1e1sJfXDkdoxrexkva9KOfM7ewxxqgHS/zy6edBELeD+sxsn7746LxKV30CUTZrQHoeeHTjnd4xh1VY26OM0PuQyh9J8lfgl/4TVOaeQrc+QWVr30w9DU7t42lH8sOAs6rXthHjakTSlD9BYlhJiAtB1bNB334EIkAcFfrR6v5BI1MzUHOu0bt5YWTUKNwJ2jfo3/1VY+lyP24wvRLEogL0FiJFEzRXKpeT/X2S07045UWyJ+EHCLJHeQ9ae2N6RlcpUXorjI41/ejo6hxpgSp5b7R5ral8qWtr6RkrIK45QAwRityPs2qTfXtSxg7abdcNDPd0SbQ6KIyP9UGqDlzsVnALferjPZslrR8Xm38VnBON8fj9O/zru/HvtwcfJh8OJuPf9vCvB/9BNYRzE0kD29xEVQMgvfkboGPTWAMam6Yat9g0NXDFpq2BJXpT1PDDpq2BGbb51WjCljANZrDLtdvaIAB9vh7S775qf/CQfB14XjPUR+X1cHcNWQdf13Qs+rQNXq5p82FxPld/W9TNrKOyD2VrWivEmrfuYp9PB2kWENRhxpoGDxu2fpH5yK8utstziY/hwh2EFu7ir3AXXYX72Cl/R3UgUx6ArYOU8ozTBUh1ZTVAJNyCPeE2qgm3QUu4j0nCfcQRDuCJcAsaVKNu7EHTc5QH32mR9sA33qXqY256G62zy2vQTGtDVViZQGMFkelu1bPOieIBYrw171vGR7ngBsPiTtwKtWL/1jiVhlcNR/GaWl+keIWFCkhyb8Ef2INyeCpaxEZTzPEPE1uswa4Wg22pBdtKCraFEuzqINgvc/gbedlrq4saXtO433TYaWqABi9D2MWLkrZ61n0Z0tavkS9D3OYR7WXI67/9vAyJ/SeLlyFxq9L+EkTWmYpfBa4LVLhVfsJecQm3Ske4KQzhpuyDvaIObko22CvIYK/cgv1iCW6XQnCn0IH9MgZuFylwq9J3XxftcD8Y/b8p6leNqojgZ6hePujskLIpN8mlS7xdjqqT0m3pq06GaQzSEZswyYLa26mxnxBDpis7EzPtH02Hj/ZGB3sHeLyHTUGJS5XZpyLnjxs6YyQNfbfrEkXNo/d9TV3R+Bkf/7o8XMFS7ecpoaZ2Z1ReuTJC9elxhCat733rXPZBR586+bpHq9UjkXAn0rLUzfajXL0UEypd0DslqYQNOm35ZDco73d47n0VvCBpoSlNOWJBBLUI4J1k+ce1qwn9c7TxG+agUFWhnT370vjCOlOWDxr0DiTRkfr9yhEcWyne3Wo2DYNeDUt/Fm1HHMUx5GojrV8qurq71emj+5g544keIsiTTvvJk5WVG6NYhDYxGWhK2KywiYplWbrvrvwqcLuIY5QKWmO1shS3/DuwsqyNo/R/bZey/C/Ryw4g sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the workflow execution trace for the given `workflowId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-trace-heartbeat.ParamsDetails.json b/platform-api-docs/docs/update-trace-heartbeat.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/update-trace-heartbeat.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-trace-heartbeat.RequestSchema.json b/platform-api-docs/docs/update-trace-heartbeat.RequestSchema.json new file mode 100644 index 000000000..d6b15499d --- /dev/null +++ b/platform-api-docs/docs/update-trace-heartbeat.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Trace heartbeat request","content":{"application/json":{"schema":{"type":"object","properties":{"progress":{"type":"object","properties":{"pending":{"type":"integer","format":"int32"},"submitted":{"type":"integer","format":"int32"},"running":{"type":"integer","format":"int32"},"succeeded":{"type":"integer","format":"int32"},"cached":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"aborted":{"type":"integer","format":"int32"},"stored":{"type":"integer","format":"int32"},"ignored":{"type":"integer","format":"int32"},"retries":{"type":"integer","format":"int32"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakRunning":{"type":"integer","format":"int32"},"peakCpus":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"processes":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"name":{"type":"string"},"pending":{"type":"integer","format":"int32"},"submitted":{"type":"integer","format":"int32"},"running":{"type":"integer","format":"int32"},"succeeded":{"type":"integer","format":"int32"},"cached":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"aborted":{"type":"integer","format":"int32"},"stored":{"type":"integer","format":"int32"},"ignored":{"type":"integer","format":"int32"},"retries":{"type":"integer","format":"int32"},"terminated":{"type":"boolean"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakRunning":{"type":"integer","format":"int32"},"peakCpus":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"TraceProgressDetail"}}},"title":"TraceProgressData"}},"title":"TraceHeartbeatRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-trace-heartbeat.StatusCodes.json b/platform-api-docs/docs/update-trace-heartbeat.StatusCodes.json new file mode 100644 index 000000000..ffd427a48 --- /dev/null +++ b/platform-api-docs/docs/update-trace-heartbeat.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"TraceHeartbeatResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-trace-heartbeat.api.mdx b/platform-api-docs/docs/update-trace-heartbeat.api.mdx index e5c5f1fbc..9750174f3 100644 --- a/platform-api-docs/docs/update-trace-heartbeat.api.mdx +++ b/platform-api-docs/docs/update-trace-heartbeat.api.mdx @@ -5,9 +5,9 @@ description: "Update the workflow execution trace heartbeat for the given `workf sidebar_label: "Signal workflow execution heartbeat" hide_title: true hide_table_of_contents: true -api: eJztV1Fv4zYM/iuGnjYgS7S724DlaW13w4phWNGm2ENR4BibSdTakivJbQMj//1I2Y7tJNc6h2IDtr0UjfVJ/ESRH8lSeFg6Mb0R3kKM4nYkEnSxVblXRoupuM4T8Bj5FUZPxt4vUvMU4TPGBa9HYVO0QrB+juCjhbEBulSPqKNPzY7z5FPkTeTUUkNKAEK2ZygXGb00Si/HYiRMjhb4+3mytT5jK781RgiUg4UMPVpmXgpNPwjcWiOIYvI5+JXYvdFfzTWct2Q0UglqrxYKLUEtPhTKItn2tsCRcPEKMxDTUvh1zkaqTWKzGfXsupwotoYfCrTrg5YDMNJFhlbFfdt7tpT2uAxL5NeMbh4+/fiBrN9WVNH5U5OseU/f1GznYWowHRUbOlV73gJ5nqo4eHty53hfuU/CzO8wDk63/DZeoeNV+rW06NwAJOqEXfbavd6/ExtyQjHPlPf8AoPwttD6mNPjGDEZfHoM5I6h4AWodDAY5sYOv6Xzxg4GU5YdgbZIEY1uIDo1kJzlxetwjtIK/gdmxq4HbsgR7i+PelLecQQjhh/HyJqY4rznIbAWOL2Vx2xABiid4PPA61Sasic3o//T6N+URlS6MqWhz3xuTIqg/4tpxi5RPsWmcl3U1eUX9BQNtP5FAHjY377tFS7rshcO6Nf28MHlRtep/U7K/TL65+9vVzEzogvLQ8n9Av2KIPMn0IdDFE8h+Zrq3jrjZsuMmoo3uMJHa43dY/7+gHObVi/SxkeQUk9GfBjuqDe0yq9Dd3dK3kB7UlArN7255c6HWr+V4fYwL6pukJfEJDSjk7JtAzeTVadpdGgfm46xsCntWHmfu+lkArkax6kpkrHDB+I0Vmavd7sKK9FFCp6DNzpjfHRycS6YUUP4iv1b+apLe+sutth0eiHlA4i+VP/82qTF3ZMPjuB3u2z7vI/PkOUp7vZf29Ige8IvO7Iue6ItW0mWreDKjpzKVixlRwplR+hkV6ZkX4TkjsTIroDIvjzIXo292ZZL2RTDJshG/9xFu3pdDQZvc/XNLb+y0gsTgqTOoDrWOLheC0MOakW+q8Gc/hCH9O+HeDewSQFUGrR3YX5uF4gI50dl5/vxTz+MZVBy43wGQT3q57iqxrgD42A33Xq8y1aY/vaJsk49j89+kqegQoEN3ilr6WiG35GY9mbI9jqU4ivyA0PLcg4Or2262fDnatLjsE2Ug3mIrwWkDl/wwCtz4EHC97jeGzUfIS0YGSToEaxi+0dy+eayLgTfRi8OxgdJNe2wXnfZdMnWvqQ4D+5M6CzmVwHOKhbfzfiY9oC9wsWzdrXjhDI79y9iu/Xh4nrG2lpPyJlJeIuFJx706W/gaoJTgo6Gb6VIQS+LUOZEdSTnKPSFfEe4w6UOeoPCJSBm5h41hUzjHM+/2S+bzWdiG/du +api: eJztV1Fv4zYM/iuGnnaAl/h6hz34aW13w4phWNGm2EMR4BibsdXakivRTQPD/32gbMd2krXOodiAbW+J9Un8RJEfyUoQJFaE94IMRCiWvojRRkYWJLUSobgrYiD0KEVvo83jOtMbD18wKnndc5u8FMHQCoG8tTYOmshnVN7XbsdV/NUj7VmZKMg8SoEGZ0jraZVoqZKZ8IUu0AB/v4p31hds5ZfOiPBFAQZyJDTMvBIKchSh6K0JX0gmXwClYv9Gf3TXsGSkSjwZoyK5lmiELww+ldJgLEIyJfrCRinmIMJK0LZgI80mUdf+yK4tIMLe8FOJZnvUsgN6qszRyGhs+8CWVISJW1prkwM1n374LOp62VBFSxc63vKesanF3sO0YOGLSCtCRbwFiiKTkfP2/MHyvuqQhF49YOScbvhtSKLl1cLoxKC1E5CoYnbZW/f6dCZqX9hylUsifoFJeFMqdcrpUYQYTz49giidDF6DzCaDYaXN9Fta0mYyWCbqBLRBMu1LTUBnGuLLonwbzlHawH/DXJvtxA0FwuPNSU/KO05gxPDTGBkdobUjD4ExwOktCfMJGSBVjC8Tr9NoyoHc+P+n0b8pjQhNLhWMma+0zhDUfzHN2CWSMuwq13VbXX5CApmJ+q8BQHC4fdcr3LRlzx0wru3ugy20alP7LAgOy+jvv75fxczRWkiOJfcr9BuCzL/2xedjFC8g/pbq3jvjfsds6b/HFb4Yo80B809HnNu1ep7S5EGW6Q3G7iiLUWkkbV13d4Fg0JyXlIrwfsmdT46Uam4Pi7LpBnlJzF0zOq/6NrCep4Om0aJ57jrG0mQiFClRYcP5HAo5izJdxjOLT2hgJvVB73brVrzrDIiD17tkvHd+fSWYUUf4lv3b+GpIe+cutth1ei7lHUj47Y+fu7R42JBzBL/bTd/nfXmBvMhwv//alYZgJPzBQNaDkWgHvSQHveAGAzkNerEMBlIYDIQuGMpUMBahYE9igqGABGN5CEY19n5XLoOuGHZB5v9zFx3qdTMYvM/V6yW/slRr7YKkzaA21ji43gpDDmoZoW3BnP4QufQfh/gwsDFnTQ2d2R/7hdoXnB+NnY+zj8HZLHBSri3l4OSjfY/bZo47Mg8O821EvOqV6W8fKdvcI3yheZGBdBXWuadqtaObfn0RjobI/jpLX6TaEkOragUW70xW1/y5GfU4bmNpYeUCbA2ZxVc88MYgeJTwI24PZs1nyEpGOg16BiPZ/olcvrtpK8EH79XJ+Ciprh9W2yGbIdnWl/Wydu6M0Th+DeCyYfH9go/pDzioXDxsNzvOowgLehU7LBDXdwsW13ZEznXMWwxseNKHTcNVO6c4IXXfKpGBSkpX50RzJCcpjJV8T7ndpY56o6oaxEI/oqrrnXOI/7Nf6vpPqZ73kw== sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Update the workflow execution trace heartbeat for the given `workflowId` to sign id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-trace-progress.ParamsDetails.json b/platform-api-docs/docs/update-trace-progress.ParamsDetails.json new file mode 100644 index 000000000..f61328b8e --- /dev/null +++ b/platform-api-docs/docs/update-trace-progress.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workflowId","in":"path","description":"Workflow string identifier","required":true,"schema":{"type":"string"}},{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-trace-progress.RequestSchema.json b/platform-api-docs/docs/update-trace-progress.RequestSchema.json new file mode 100644 index 000000000..ba02ff072 --- /dev/null +++ b/platform-api-docs/docs/update-trace-progress.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Trace progress request","content":{"application/json":{"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"required":["status","taskId"],"type":"object","properties":{"hash":{"type":"string"},"name":{"type":"string"},"process":{"type":"string"},"tag":{"type":"string"},"submit":{"type":"string","format":"date-time"},"start":{"type":"string","format":"date-time"},"complete":{"type":"string","format":"date-time"},"module":{"type":"array","items":{"type":"string"}},"container":{"type":"string"},"attempt":{"type":"integer","format":"int32"},"script":{"type":"string"},"scratch":{"type":"string"},"workdir":{"type":"string"},"queue":{"type":"string"},"cpus":{"type":"integer","format":"int32"},"memory":{"type":"integer","format":"int64"},"disk":{"type":"integer","format":"int64"},"time":{"type":"integer","format":"int64"},"env":{"type":"string"},"executor":{"type":"string"},"machineType":{"type":"string"},"cloudZone":{"type":"string"},"priceModel":{"type":"string","enum":["standard","spot"],"x-enum-varnames":["standard","spot"],"title":"CloudPriceModel"},"cost":{"type":"number"},"errorAction":{"type":"string"},"exitStatus":{"type":"integer","format":"int32"},"duration":{"type":"integer","format":"int64"},"realtime":{"type":"integer","format":"int64"},"nativeId":{"type":"string"},"pcpu":{"type":"number","format":"double"},"pmem":{"type":"number","format":"double"},"rss":{"type":"integer","format":"int64"},"vmem":{"type":"integer","format":"int64"},"peakRss":{"type":"integer","format":"int64"},"peakVmem":{"type":"integer","format":"int64"},"rchar":{"type":"integer","format":"int64"},"wchar":{"type":"integer","format":"int64"},"syscr":{"type":"integer","format":"int64"},"syscw":{"type":"integer","format":"int64"},"readBytes":{"type":"integer","format":"int64"},"writeBytes":{"type":"integer","format":"int64"},"volCtxt":{"type":"integer","format":"int64"},"invCtxt":{"type":"integer","format":"int64"},"exit":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64","nullable":true},"taskId":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["NEW","SUBMITTED","RUNNING","CACHED","COMPLETED","FAILED","ABORTED"],"title":"TaskStatus"},"dateCreated":{"type":"string","format":"date-time","nullable":true},"lastUpdated":{"type":"string","format":"date-time","nullable":true}},"title":"Task"}},"progress":{"type":"object","properties":{"pending":{"type":"integer","format":"int32"},"submitted":{"type":"integer","format":"int32"},"running":{"type":"integer","format":"int32"},"succeeded":{"type":"integer","format":"int32"},"cached":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"aborted":{"type":"integer","format":"int32"},"stored":{"type":"integer","format":"int32"},"ignored":{"type":"integer","format":"int32"},"retries":{"type":"integer","format":"int32"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakRunning":{"type":"integer","format":"int32"},"peakCpus":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"},"processes":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"name":{"type":"string"},"pending":{"type":"integer","format":"int32"},"submitted":{"type":"integer","format":"int32"},"running":{"type":"integer","format":"int32"},"succeeded":{"type":"integer","format":"int32"},"cached":{"type":"integer","format":"int32"},"failed":{"type":"integer","format":"int32"},"aborted":{"type":"integer","format":"int32"},"stored":{"type":"integer","format":"int32"},"ignored":{"type":"integer","format":"int32"},"retries":{"type":"integer","format":"int32"},"terminated":{"type":"boolean"},"loadCpus":{"type":"integer","format":"int64"},"loadMemory":{"type":"integer","format":"int64"},"peakRunning":{"type":"integer","format":"int32"},"peakCpus":{"type":"integer","format":"int64"},"peakMemory":{"type":"integer","format":"int64"}},"title":"TraceProgressDetail"}}},"title":"TraceProgressData"},"containers":{"type":"array","items":{"required":["targetImage"],"type":"object","properties":{"requestId":{"type":"string"},"sourceImage":{"type":"string"},"targetImage":{"type":"string"},"buildId":{"type":"string"},"scanId":{"type":"string"},"mirrorId":{"type":"string"},"cached":{"type":"boolean"},"freeze":{"type":"boolean"},"requestTime":{"type":"string","format":"date-time"}},"title":"ContainerData"}}},"title":"TraceProgressRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-trace-progress.StatusCodes.json b/platform-api-docs/docs/update-trace-progress.StatusCodes.json new file mode 100644 index 000000000..66f194d48 --- /dev/null +++ b/platform-api-docs/docs/update-trace-progress.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK","KO"],"title":"TraceProcessingStatus"},"workflowId":{"type":"string"}},"title":"TraceProgressResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-trace-progress.api.mdx b/platform-api-docs/docs/update-trace-progress.api.mdx index b3169d1ff..948aa27b7 100644 --- a/platform-api-docs/docs/update-trace-progress.api.mdx +++ b/platform-api-docs/docs/update-trace-progress.api.mdx @@ -5,9 +5,9 @@ description: "Store the execution metadata for one or more tasks in the given `w sidebar_label: "Store workflow task execution metadata" hide_title: true hide_table_of_contents: true -api: eJztWW1v2zYQ/iuCPm1AXti0XVd/WuKmW9DmBYmzAg0ClJZom40sqiTlxDP833dHSiJl045cFBiw7UtikUfyeLw7PvdwEWs6VnHvLtaSJiy+34tTphLJC81FHvfiGy0ki/SEReyJJSW2RlOmaUo1jUZCRiJnEfybGjGqHlTEcyM/5jOWR18ehXwYZeLxLP1yEO/FomCS4ixnKcx+W8A8bIBLX0kxlkwpkCmopLAGk6jYIs7hA2TdRCDCUbeC6km8qvCnSixSWvJ8HPGU5ZqPOJMgKtm3kksGS2tZsr1YJRM2pXFvEet5gYvYQfFyuddaVxWgoVv4W8nkPLiyEYzycsokT9prr63Fc83GpgvsOKXaNv3yCla/t6oypU9EOscx7aWMxaKiMllUycJMiYBJc40jaFFkPDG2PvyqcNhiXQcx/MoSHAhzwclozpTpxYP0xKiUFDfMNZuadmfIO7AZ1SWeG44CI4Hy22efUDUJ2HyvsnigA8Yn6BuhPnDgYLsqh1Ou17s8c6Pz7WsOi6K8pnIH8URMiwyctPuIqUjLjG2z6poTmvOkPAcvCW2RahhZ6Gd96uWR2aBxoLCtEgjKJHwo6P8pDysAbleGTywpStVRrymD5DHvFBgQclw9dBQ1du8myvJZcBc254nw5qc0mcDRDEx7yASZKNPPkB83uDRP2LlIWRbyIAYppIqtPKUSM48qhMbYetrHzv0ZlRguaoOU5hp9Le6jElduLeNTyvcCmGwIZsHdSinkcWJzTNAaXN/YYO92smlpc33HU5CMZjscWg5zzzArB80LDri+ST80RTnMTFwW4IAdRaV6futWuVl70m2iBaMP150nRuk/u08ukwmVHWUfd5BVc8gZO8g+dveB9GSuWVdzPErInrsMmImsr5+ez5lWmuezHaQxQDqGBk+7zAlOXmYZRe8ziGXZXLIdLb8arWsJ5uL0E3zd3J6cnw0Gp+/g9/XtxcXZxe/wq3/c/8M09S/Prz6e2u73x2cfzY/jk8trbPKSzQB0qxIERj9cfn04T80CIRq8JAPbzajSFiV+9yTLtoLmXq2h0/NQqGB5imt1vGMN6Ggru01elnm+y+xJwljaefYEbqjOwiPKs87CdChk910qLCK6CvNxvoO0ZOAKHYLfSmeCpv0uyMSGD4qf74JOTCrf6UhxxA4aofhuGlnkzLai+e0RwPOUPXXczmYE/38Y/XvCCErzKc9XcvJQiIzR/L8YZv4N43MZ7xgUb4C5NwtQTWO/zOtcdEOxOmb6bErH7PmCu+IHNkBlJUqZMDtVuMB2S4X6hyXP0k1zJzTf0DXlWG5s6FwLOc+7RpKxv1i4r9rpgIfSULgw986mXx+DPZeNx3Zd8S1Gos0pmQYowvIq5R4Rsk7fXH74cVTN8xDPrPbhsgXUqt3g1QDCDrN5JFuQj9hgDrthtAfIvApt+YSm30NT+S4Pxa7q5O614NYdnKL3rWn+MnBYNWMZ5UJHNAPrgD4orlhSQvkxNyzlCaOSyeNST+DzHhm8KdMTgSxnURodka3sxYeGaD1cOEsvDwvHfSomZzXxWcoMBky0LlTv8JAW/MBQCgeKfQOVDrhYoyBvTE90lVGNrh6Z6j86vjqLUaFa3xs0rzWVr3VjLVyxJixNfBkhaLE/3tdB9PVRGzvgsV07uvL0iSI15vGIdzXn55yzIleb74bhc02G2HOfNZ8HIXX0ap+82T96O3jxuvf6Re/o1wPy5sXnuOHwtok43m6bVM3V3dXr37e4OKdVQ8ERR7B5Ote8mmtq6DTXVLForsGSZ8RRY6QmvkhNa5GKtPLCveGqXFuLovLmd8yUfwKOkPIZJUsXkRV6yF/XsULE53yIz+gQn6/xFjU0DalJGFJRLKQmUIhHjxCf/CANtUEa4oI0tARpSAfSohRImzAgHh1AvGKf1KU8sYU6cWU3cUV1VTu3ytxtPtUqZTcLYqT65WmDnEkLFxMP9ZIWpiXu+iQOjxIPbRKHJYmHFImHA4mP4kgbo5EVBEZ8fEXa6Im0SpC7ppoggRTwT23Uh7P2XejHbH15vwLt7lpQzEsTPgLzE6AHvFxzg7f8PGNhlhf5Dbrywr4ylt1jDaPsVws4bXNOQ4qNhMnu1VVa3Tp4zTx3IeH1BmlGVcLGOInBAe3Lzr/iAArwzIDtkfjNdSCXB1a167w4ePv6gBjoDulqSg2MqBzMPmHW9615pAw8Zq6qvnAg5Yc/glb3rGZP+rDIwDtQcWOARQUT6vfYvbjXevdsEgMkiYlJzHfxYjGkit3KbLnEZvs4ib4GVwbSYHDiI5optmWDzzxdBvV9YLDKyuvojGbmJjNJbEYltzTcTrr8dF1hvp+jrW+5QaXq0imf+9r4ylamNI48gZsBr3PQzwr0rRb75sJ0E6xhVHwetiOOIRsVequsDwWvbgcYwdWjLqAMHCLpIzTiX6OrMEaxhRs1vHlG83Fps4CdElEXbYO2FZBmNhW0BriLkRiIB5aDy9TG0fiNdlku/wZc+Lra +api: eJztWW1v2zYQ/isCP22AkjBpu27+tMRNt6DLCxJnBWoE6EW62GwkUiUpO57h/z6Q1AsV045cFBiw7ZtNnsi7493xuYdLomGiyGBMtIQEyV1MUlSJZIVmgpMBudFCYqSnGOETJqUZjXLUkIKG6EHISHCMhIxyKwbqUUWMW/kJmyGPPs+FfHzIxPws/bxPYiIKlGBWOUvJgNwWKWgcma2vpJhIVIrEpAAJOWqURrEl4ZAjGZB2IRITZnQrQE/Jc4U/VmKR0pLxScRS5Jo9MJQkJhK/lkxiSgZalhgTlUwxBzJYEr0ozCbuI7JaxZ19VQEJtht/LVEugjtbwYiXOUqWdPde24txjRM79SBkDtoN/fSarFZ3TlVU+kSkC/NNdyvrsaioXBZVsiQmieAauTZfQFFkLLG+PviizGfLdR3E/RdMzIeFNCejGSo7aw7SEwMpwRjMNOZ2vHXkmCgNujTnZr46S00MbV99Cmoa8HlceTwwUUiRmNgIzWmYBMdVeZ8zvT7ludsE355mOVp5DXIH8UTkRYY6oO+mL3KRlhlu8+paENrzBMZRBk0ErTEv9Isx9erIGmgDKOyrRIJOwodi4j9lYQW+lliGTywpStVTrxxzIRe9EiMmKVOPPUWt3/uJIp8FrXA1T4SNzyGZMo4jOx5yQSbK9JPgm0KaJXguUsxCEYS8zKvc4ilIU3lUIbTJrac9M7k3A2nSRW2Q0kybWCNDo8RVu5eNKeVHAS/ze5TWWimFPE5cjQl6g+kbl+z9TjYtXa3veQoSIdvh0DhoNjNVOejepCjXjfRTU5T3mc3LIse8p6hUL5vulJt1F90mWiA8Xvde2Ej/2X9xmUxB9pSd7yCrFirZRXbePwbSk4XGvu6YS6Zxlw9mIhvqp5drppNmfLaDtEmQnqnB0j5rxoSXWQYm+ixiWTWXbE/PP8/WtQJzcfqRxOTm9uT8bDQ6fUdicn17cXF28RuJyfB4+LsdGl6eX/1x6qbfH5/9YX8cn1xemyGv2IxAPVYFwmQ/aBxKBI2BFA1ekgFzM1DaocRvXmTVVdDeqzV0ehkKFchTs1fPO9aCjq6y2+RlyfkuqycJYtp79QSSaW/hB2BZb2G4F7K/lco0EX2F2YTvIC1RS9Yj+Z10JiAd9kEmLn2M+Pku6MSW8p2O1Hyxg0ZGfDeNHHLGrWh+ewYwnuJTT3M2I/j/0+jfk0YaZc74s5p8L0SGwP+LaebfMD6X8Q41sIysNguABuK3eb2bbg1ygvoshwm+3HBX/MAGqKxEKRN0S4Ub7Har0Px9ybJ009oJ8A1TOTPtxobJtZTzoutBIv6F4bnK0hELlaFwY+6dzbA+BncuG4/tuuJbrESXU7IDqhC8KrlHlK7TN5cfvh9V8zLEs7t9uOwAtcoaczUwPmkxm0eyBfmIDe5wBht/rGLyOmTyCaTfQlP5IZ+jUr3CvRbcasGpib41zV8FDqtmLCMudARZJuaY2qUUJqVkemFZyhMEifK41FMyGN8ZBi9HPRWG5SxKq6NhKwfkwBKtB8vW06uDouU+FcpZTXyWMiMDMtW6UIODAyjYvqUU9hV+RQn7TKxRkDd2JrrKQJtQj2z3Hx1fnRGjUK3vjXGvc5WvdeMts2NNWNr8skIkrn68r5Poy1xbP5hju27pytMnMNSYxyOOa86vDc6KXG3+NwxfO2SJvfZvzeeRI3r0eo++3Tv6ZXT4ZvDmcHD08z59e/iJNBzeNpGWt9smVXN143r/uw4X12rVUHC0Jdg8nWterR1q6LR2qGLR2gFHntGWGqM18UVrWotWpJWX7g1X1Y51KCpv/ZaZ8k+gJaR8RsnRRfQZPeTv27JC1Od8qM/oUJ+v8Ta1NA2tSRhaUSy0JlCoR49Qn/ygDbVBG+KCNrQEbUgH2qEUaJcwoB4dQL1mn9atPHWNOm3bbto21VXv3Glzt8VUp5XdLGgy1W9PG+RMO7iYeqiXdjAtba9P2uJR6qFN2mJJ6iFF6uFA6qM42sVo9BkCoz6+ol30RDstyLjpJmigBPxThvpw1r0LfR/TV3fPoN24A8W8MuEjML8AesCrHW7wll9nHMzyMr9BV17aV85yNtYwyv3rAKdtwWlJsQdhq3t1lVa3jrlmXrqQzPXGElSVsHVOYnFA97LzrzjMDYge2G1/bScMl4dSuX0O9w/p0T612F0onYPFEVWEuTfM+sK1r5SB18znui9blPLdX0Gri1bjkz4oMmAWu1oPLCucUD/IxmTQefhsKsNdTKa2Mo/JcnkPCm9ltlqZYfc6aYItZcrwYCkZPECmcIuBL7xdBvV9xMXa8+gMMnuV2So2A8kcD7eTLj9cV6Dvx2jrY25Qqbp34gtfG1/ZypU2kqcIqbnPx8tKYOi02LM3ZrvAGkg178Pui+MkwUJvlfWx4NXtyKRw9aqbi9R8ImFuHqdh7nQV1imucwNLnGfAJ6UrA25JA7ugi9qeoTRrVNAby6WTGIlH5KtV4xxt/hu/rFZ/A29Iuv8= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Store the execution metadata for one or more tasks in the given `workflowId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-user.ParamsDetails.json b/platform-api-docs/docs/update-user.ParamsDetails.json new file mode 100644 index 000000000..576981676 --- /dev/null +++ b/platform-api-docs/docs/update-user.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"userId","in":"path","description":"User numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-user.RequestSchema.json b/platform-api-docs/docs/update-user.RequestSchema.json new file mode 100644 index 000000000..33011f5bb --- /dev/null +++ b/platform-api-docs/docs/update-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"User update request","content":{"application/json":{"schema":{"required":["email","userName"],"type":"object","description":"Request object for creating or updating a user.","properties":{"userName":{"maxLength":40,"type":"string","description":"Unique username. Maximum 40 characters."},"email":{"maxLength":255,"type":"string","format":"email","description":"User email address in valid email format. Maximum 255 characters."},"firstName":{"maxLength":100,"type":"string","description":"User first name. Maximum 100 characters."},"lastName":{"maxLength":100,"type":"string","description":"User last name. Maximum 100 characters."},"organization":{"maxLength":100,"type":"string","description":"User organization name. Maximum 100 characters."},"description":{"maxLength":1000,"type":"string","description":"User description or bio. Maximum 1000 characters."},"avatar":{"type":"string","description":"User avatar URL."},"avatarId":{"type":"string","description":"User avatar identifier."},"notification":{"type":"boolean","description":"If true, the user has notifications enabled."}},"title":"UpsertUserRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-user.StatusCodes.json b/platform-api-docs/docs/update-user.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-user.api.mdx b/platform-api-docs/docs/update-user.api.mdx index 2e623286f..05ed8613d 100644 --- a/platform-api-docs/docs/update-user.api.mdx +++ b/platform-api-docs/docs/update-user.api.mdx @@ -5,9 +5,9 @@ description: "Update an user entity" sidebar_label: "Update an user entity" hide_title: true hide_table_of_contents: true -api: eJylVktv2zgQ/isET1vAld2us0B9alK0QLDdNsjjFPgwlmibqUSqJJXHCvrvnSGpl+U0u+3FkIcz883zI2vuYGf56pZXVhjL1zOuS2HASa3OM77iN2UGTtzgIZ/xEgwUwpHi6rbmCv+gClmi7oxLhf9KcHv8zoRNjSzJD3lBFaaqQhiZMpkJ5eRWepdGfK+kEQjlTCVm3KZ7UQBf1dw9leRdKid2XnWrTQEuiP5a8qZZB3Nh3ZnOnsjmCGrlE2BREd2kGj0qR+pQlrlMfbLzO0s29SCAPrRbjiKZozHl+oXSRuwYoN7cidRNUr4MgCwcMwyepUYgltoxHcOib2DkM6HqGiq9k8ISeoeE3wU8fhZqh4VdLRcdsHUGHUxrrSQie6/UoIT9A4+yqAq2XLB0jx1MqYEJb2YxqzHA25OTKUJX+rYORwrtjxhkmRHWMqnYPeQyi+LgoI8FUQ6D2Upj3ZGM3yxeTpnwvT0bp4y2hzA5/BYKmb8Mos0OlPwXguUvAQ1dvAw4cnCI998AByIa0I3UI8QJJNyDAzPY1J85D8rs5vLzwJYI5v9Y98ThnShNf9KuyNHRRutcgJp4Ot8yTzHM7cN2sD1YNnRimVCwyUWG7tG/ky4XngJR2VEgcafxtDlkLi+wJToJ6/t2sZwS0te/2Wv2RbOWgtBouVhM9c4g+13CKnAJYXeUp8Y80ypOOjEswUdjNGYf8qP0feR/HsmwvTyosAzyXD9gPKRuRVoZ6Z78zXEmwAhzWtGA3q6JyA+6HkgbVGgUtR0tZxis22u6lkrtS+MvmxWf+8trXoebqOGEZu7ba6oyyHF871xpV/M5lDJJc11liRXfMdhE6smoXPkTdpGDI+JiH0ifnV6ccwq1zeSKCh+KOMynqyMh8nij+cH0SigJH59aTr17cL5C1NDL/j77+AhFmYvxXdCvSeRuf/ZeBN0k1QUfMWmv3/NeLxvT1HMr2InbjT+U+IdCJxuvZdwNqbbalyYOVKwwlfSl4lMrZSpsVKZtQBbyZRk1dtjOtjgE+74/wEBoKgLOm+TdSbIgGQ1TAX6Z4pPmufk7oNnYaCce3bzMAd8/6M1HVcfRbN9VM76KzyQcoD0NLx7V9QasuDF505AYO29oPfDzHowkJvLzm0nrWYmvtpBbMYmi4wf+x2VkgFfs+RfX0aCjEBRliRd3Rf/w85t46l94zRo19wIy9EOBhcMPAf71NbnojSdU1cxai9M0FaX7qe56sOsXX6+uaWviG6/QGdkYeKDnI/76QLUvh19GL6tx4NWu8szGg0/aMRiv6MFK+qyOlgJb5TWu9TehmqarjKP/VJim+QFjTeJs +api: eJylVk1v4zYQ/SvEnFpAazup04NOmyy2QNDtbuAkJ8OHsTS2mZVIhaScuIL+ezEUZUmWs2m7N2k4n29mHlmBw62FeAmlJWNhFYEuyKCTWt2mEMNjkaKjR0sGIijQYE6OFeNlBQpzgthb3qYQgVQQQ4FuBxGkZBMjC/bDXiwZocqcjEyETEk5uZHepaHnUhpKIXampAhssqMcIa7AHQr2LpWjrVfdaJOja0S/z6GuV405WXej0wPbnIla+gJEUIQIEq0cKcfqWBSZTHyx0yfLNlUvgS61JVCOMoPI1/qVy15FbYJ6/USJG5W8aAKK5lhstBGJIXRSbYUOafE3CvY5YXQNQ+8kWY5+jBRXkOPrF1Jbt4N4PjsGts5ItR1jreRzSd4rN2gi/sJXmZe5mM9EskODCTdwAnUUqhoGuLy6Gkc4Qt/icAZofyQwTQ1ZK6QSe8xkGsSNgy6Xy6ur02Q20lh3puKL2fslc3xvL4YlX8xGNWf4U1HY/P0g2mxRyb+xsfxfgfou3g84cHAa798F7Il4QNdSDyKOQuIeHZrepv7IeaMsHhdferZMMP/FuiMO70Rp/kmOIAdHa60zQjXydLsRnmKE2zXbIXZoRd+JFaRwnVE6gbqOwEmXkadAS8ZxImGnoebjIXN5gS20ss36Xs7mY0L69qf4IL5q0VJQHcF8Nhvr3WD6s4SVk7W4PctTQ55pFUed6EPw2RhtFqE+Lt9n/tuZCtvLg4EVmGX6hVLvylJSGukO/ua4ITRkrkse0OWKifyk6w1po2oaxW13B4ggJ7fTfC0V2kPjL5sYpv7ymlbNTVQDRzP79poqTQYx7JwrbDydYiEnSabLdGLpmQxOpB6Nyr0/EXcZOiYu8Yn1xfXdLXCqbSX3DHwDYr+eI44cEcKN5gfTK0EUPv5oOfXpxXmEuKGL7j77/Ip5kdHwLujWJHC3P/tIje4k0TkMmLTT73ivkw1p6q0VPIrbjT+V+IfCUTZcy7AbUm20hyYMVECYIX0PfG6lTMgGZd4GTPw2DBvbb2cLDof92B3UEfBUNHEuJhezy8mMhTxNOfptCm+atwbwhGdDpx29ummRoVTszadVhdlsH1YRxOGdtIpgx9MbL6Gq1mjp0WR1zeLnkgzvxyqCPRrJVOQHOJXW0xLEG8wsjbI4EgT8sggU8Kt4+8l1NukgRMVV7jEr+Q8i+E6H7olXr+oIdoQpGZ9Yc/ipCf/hgV10xiOuqqPW4jpJqHA/1F31lv3u2/0Dr0145OU6ZRuDL/x+xJcmUe3h8NvoZRVkqLalpzZofPKS4XBHT3bSV3UWiqpqNB70d1J1fUTG8T8DU9f/ANQ14pE= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Update an user entity id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-workspace-participant-role.ParamsDetails.json b/platform-api-docs/docs/update-workspace-participant-role.ParamsDetails.json new file mode 100644 index 000000000..8ffab50e3 --- /dev/null +++ b/platform-api-docs/docs/update-workspace-participant-role.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"participantId","in":"path","description":"Participant numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-workspace-participant-role.RequestSchema.json b/platform-api-docs/docs/update-workspace-participant-role.RequestSchema.json new file mode 100644 index 000000000..204109f09 --- /dev/null +++ b/platform-api-docs/docs/update-workspace-participant-role.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Updated role for the workspace participant. Accepts `owner`, `admin`, `maintain`, `launch`, `connect`, `view`.","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"description":"Workspace participant role to assign.","type":"string"}},"title":"UpdateParticipantRoleRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-workspace-participant-role.StatusCodes.json b/platform-api-docs/docs/update-workspace-participant-role.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/update-workspace-participant-role.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/update-workspace-participant-role.api.mdx b/platform-api-docs/docs/update-workspace-participant-role.api.mdx index 2ec7b319c..aa5d15fe9 100644 --- a/platform-api-docs/docs/update-workspace-participant-role.api.mdx +++ b/platform-api-docs/docs/update-workspace-participant-role.api.mdx @@ -5,9 +5,9 @@ description: "Updates the role of the participant identified by the given `parti sidebar_label: "Update workspace participant role" hide_title: true hide_table_of_contents: true -api: eJzVVk1v2zgQ/SsET1vAtdJuusD61KRogaDANnAT9BAEMC2NZSYSyZJUXFfQf98ZUl/+QNIG7aEXgyJnyDdv3sy45l7kjs9u+Ebbe2dECo7fTngGLrXSeKkVn/FrkwkPjvk1MKsLYHoV1kZYL1NphPJMZqC8XEnI2HIbTnP5AIotRkYX2YJJNTrsH52yszQF4x1b6I0Cu5iwhchKqWhRCqm8iOtCVCpd0yrVSkHqafkgYbOY8gnXBqwg0BdZD/tL98blAGSOQaA5QhMleLDEQM0VfqCbtjm6T7ik0I3wa77PxyebCyW/h5eYqkqwMh0IsITEwtdKWkAY3lYw4S5dQyn4rOZ+a+gVDAlysGi60rYUPm79c8qbZtJD6fl5AlAf429Fs5PJR/GMqP4NiG6jOzh/rrMt+RyTaxalit5BcD2VY9X+ItnhnsfgCIkwppBpUEZy5whOfRibXt7hFSRAS4r1EosOTwnvYTRfjgGPsXnNhHMyVwSivdt5K1VOeeNeerqw5WNP/vPIIBo2+9kIG85o5SKu1yenh7A+fWQv2X+adbGj0+nJyaHducBEtG/9BFMDohtegnMiB+pLjxPYGQ5MH2HjvbXaztv4KPyA/O8jEXbNhCntmSgKvUE8ZO4graz029A1zkFYsGcVlsHs5pbEiS1lrakBmSpgpAqZ8QT7ikvq0F2aZGi3ST2q8iYZJRmPdkquSWzsWw7sQ9e0Klvg5WvvjZsliTBymha6yqYOviL8qdQHxfk5nLDLQngqLfaO7NnZ5QUn8F1snykVkdZxhD2z9CJv65a+l8EId+LiQ1e0dxsfOKMUz4eqff9NlCbKPcq+TxX1lZUOL7UZawETwqdiIWYkktoak9xEGuS2y9OYHVScLEJ7Wem3wwECIZLjO6+m/76ZntCe0c6XIqi1bYuxvI43GNZmbAd1PZTBnzNa27R7+OYTU6ALkRFIrVuF39DkdGg66ybo6D8F7u4Os7HO6XR/uATiUI9r5JvuruulcHBti6ahbRSSpfrD5YOwUixJKVgOmXS0xupbicLBI8z/NW9bzAv2A/P8aPjtplBbTjCKir5weQ/b/n8Ezc9ngXpqpj8D0TgDz8b19Gx/BrLd7De36LAGkWFDoaRGm3cRzcsrumm442COUGTRIwr/Udtxu768vqL+1f6nKHVGLlZsSI34G+DqQE4c17RX80KovApTh8crqduJ3Wa51xxDUEcJQZUHiyt9DwqV3vHj6Zt4aZr/Aa1PFMI= +api: eJzVVk1v20YQ/SuLObUAIyqp0QNPtYMUMAo0hmIjB0GARuSIWpvcXe8uragE/3sxuxRFWYLdGskht+V+vnnz5g1b8Fg6yOaw1fbBGczJwSKBglxupfFSK8jgzhToyQm/IWF1RUKvw9ig9TKXBpUXsiDl5VpSIVa7sFrKJ1JiOdp0XSyFVKPF4dGJuMxzMt6Jpd4qsstELLGopeJBjVJ5jOMKG5VveJRrpSj3PHyStF1OIAFtyCKDvi4G2F/3b9wcgMx0RZCAQYs1ebLMQAsKa4IMtC2vC0hAcugG/Qae8/HZlqjkP+EloZqarMwPBFhGYumxkZYKyLxtKAGXb6hGyFrwO8OvSOWpJAsJrLWt0cep3y+g65IBysDPK4CGGH8omqNMvohnRPUPQLSIx8n5K13s+Mw5uRZRqmttg+AGKseq/U6yy7XypDwjQWMqmQdlpPeO4bSnsenVPeWeBWhZsV6S41XGexrN13PAY2xeC3ROlopB9Hc7b6UqOW/gpecLez6eyX8WGYSOdx5nI0w4o5WLuD5ML05hff5LvBN/a7GPvUvgYjo93XeFheiz9X+YOiCaQ03OYUnsSy8TuN94YPoMG5+s1XbWx8fhB+S/nYlwbyZCaS+wqvSWinCVo7yx0u+Ca1wRWrKXjd9ANl+wOGvyG80GZJqAkSskg1Tb0qVtcJcuPdht2o6qvEtHSXZpe1RyXWqjbzmyT3vTamwFGWy8Ny5LUzRykle6KSaOHsniROqT4vwSVsRNhZ5LS3zk/eLy5hoY/D62L5yKSOs4woFZfhH6uuXvVdgEST/4c1+091sfOOMUzw5V++kb1ibKPcp+SBX7ylqHl/qM9YAZ4WuxMDMyJ9dvZrlhHuR2zNOYHapRVsFe1vqPw0KXAJMc33k/eT/9MJnypNHO1xjk2vtirK/zDiP6lB3Bbg918PP01j7vnr751FQoFZMRWG17ic+5dTpIINu30NFPRQLZcTcbC51Xn3eXQNwigY12nu9u2xU6urNV1/H0Y0OWC3CRwBNaiSuWyryFQjoeF5CtsXL0AvO/zHqP+VX8h4Z+Nvx+EtUOGEbV8Bck8EC74UeCG+ibQL3W1N+AaJyBN+N6vbm/Adlx9rtFl8CGsCAbkhr3fIxo3t3yTYc7ThoJRxZPROG/uHfs1zd3t2xg/U9FrQs+YnHLasRthKsDObFf81wLFaqyCW0H4pVsd3jsls/cMQR1lpC2jTtu9QOprhv48fzNvHTdv9o5FOc= sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the role of the participant identified by the given `participantId` in t id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/update-workspace.ParamsDetails.json b/platform-api-docs/docs/update-workspace.ParamsDetails.json new file mode 100644 index 000000000..92b9288dd --- /dev/null +++ b/platform-api-docs/docs/update-workspace.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"workspaceId","in":"path","description":"Workspace numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}}]} diff --git a/platform-api-docs/docs/update-workspace.RequestSchema.json b/platform-api-docs/docs/update-workspace.RequestSchema.json new file mode 100644 index 000000000..553455eaa --- /dev/null +++ b/platform-api-docs/docs/update-workspace.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Updated workspace details.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"description":{"type":"string"},"visibility":{"type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"}},"title":"UpdateWorkspaceRequest"}}},"required":true}} diff --git a/platform-api-docs/docs/update-workspace.StatusCodes.json b/platform-api-docs/docs/update-workspace.StatusCodes.json new file mode 100644 index 000000000..7e4206de5 --- /dev/null +++ b/platform-api-docs/docs/update-workspace.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"description":"Workspace details including ID, name, full name, description, visibility, and timestamps.","required":["fullName","name","visibility"],"type":"object","properties":{"id":{"type":"integer","format":"int64","nullable":true,"description":"Workspace numeric identifier."},"name":{"maxLength":40,"pattern":"^[a-zA-Z\\d](?:[a-zA-Z\\d]|[-_](?=[a-zA-Z\\d])){1,38}$","type":"string","description":"Unique workspace name within the organization. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters."},"fullName":{"maxLength":100,"type":"string","description":"Full display name for the workspace. Maximum 100 characters."},"description":{"maxLength":1000,"type":"string","description":"Optional description of the workspace. Maximum 1000 characters."},"visibility":{"description":"Workspace visibility setting. Accepts `PRIVATE` (only participants can access) or `SHARED` (all organization members can view).","type":"string","enum":["PRIVATE","SHARED"],"title":"Visibility"},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the workspace was last updated."}},"title":"Workspace"}},"title":"DescribeWorkspaceResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate name","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/update-workspace.api.mdx b/platform-api-docs/docs/update-workspace.api.mdx index adb9966a1..3e74fd635 100644 --- a/platform-api-docs/docs/update-workspace.api.mdx +++ b/platform-api-docs/docs/update-workspace.api.mdx @@ -5,9 +5,9 @@ description: "Updates the details of the workspace identified by the given `work sidebar_label: "Update workspace" hide_title: true hide_table_of_contents: true -api: eJzNV21v2zYQ/isEsQ8JIL+kzYbVwLA5L8WCvSTISwvMzRZaom0mEqmSVBxX03/fHSVLtOQkTdEC+2BDJI+8u+fuHh5zatnc0NGELpW+MykLuaHXAY24CbVIrVCSjuhVGjHLDbELTiJumYgNUTM3rLcREXFpxUzwiExXbm0u7rkkN7XISXTTpwFVKdcMTz6J6rPfr2VgPWWaJdxyjXblVMIA5JSeg3xABRqUMrugbStP9ZxJ8ckdTWSWcC3CxiqNqjX/mAnNQa/VGQ+oCRc8YXSUU7tKUYuQls+5BtGZ0gmz5dQP+7QogtoUz6EnDaqd+gbWXJfbubEHKlrhnm0hi7z4VIFDxaGCg6XFXSxNYxE6zAa3BrfmXTvU9JaHFkOjMXhWQJKM1nDUUsZqIee0AGuzOP7zscUNO7es3wsjpiIWdtVdDigHKDFdz85P3o0vj2Hm4tfx+fERJq0VNkbhd80JELZ6upVp5yV8IFK0Q+EmTKqkKR19NRx2ET797eshWUepq+Z9O4BEyDDOIoCDnBwFBIMQEES8+vS2B6QBMyBMRsSKBHxmSWo2E3DSxCwo47oRCAT3SQdE9DlpC0eDFjbFcJQp/5KCKYI64xL28DuXc6i50f4QGcMCXeAJf09Y79O499eHD9H1zs8jb/TvpPcPTP3kTe3u5nvB6x+L72jQybNWNUkByeIVExpClsIuhHRUpzzu6ZM/MmPJlJNXvf0hCRfAZyHSWUAAem1dIDj8cD9hcbpga3d9WZQKmSSYYgzULFbpgksgXk0yGYFIqCBJQY1dcqDZZmu/XYIeWnvD4XO+vsVUioRJY7Yq/YQobnI9eMgeRJIlBM5ra27V96byZ7Wfug8W+2ncuWs29HcM2CSQxzKskSKGWwu29Mk4DHlqDbmp2OWG7CgZrwjcSFaEImUSFjEmDASN2cVY3JT8A6IMcPPzgCQ8mYJRbse94Mvd/pZEeymhAWDAYoeaI71vY8i65lCuhwXfAflyzQJkCSnVuseXDCwuj3dwxszY6jb5VupQBclKHf0Nzm76An/2yB0/9bm8ZGskc5Db38bXBywi1ZX5EuL2ORLcMGzOn6fDtWD3fvO8ONZa6Y7lr7fcNOuGiUgF7BHHagn2OOk3XemjrHSnJKn/q6uwaHiYaVel0OUdcKa5HmfIE5NrbG+gBVwo7BDTzGnFDmtEB1BhZpC7brAYNE3rIPe6soLi6fp+3UJmOoatC2tTMxoMWCr6YayyqG/4R0C2L1QnZS/cCjmLmcUEJ4coT8ZnJxRNW1t+gdCVMPj210igRlr1dTieOiGYKT/erkvndmkdXBiS86arO36Amol502p5VVfT+2NEWk/7dFizTIF960w5W6sYVS6jj8+hgdgKAL0SdjdU6BJsE2kfX8gxEbtOYKZ+aRaQryFMpZ69/pvv+0OcS5WxCZOe6yUFNcTRNjJv8vwrv1eqYFr+YAdwKUK/DwY6R/MqKyf4OjEgOlq/UrzXFMz6DwZInwU4h5vyfMoMv9JxUeA0xF1jMcDnPdOibJMge+Euxm8ohRmLTbtp8v3eOa8qeJd8xmNoq1/VJJMrTB0WZziCzzu+qh9h+BT6IqOeexB9gUU+tMU1iC84g+bIAVdKHJaW9C7xnOaEDhWiV+WOsg14Utbnp7OrSyzp6hmWqAi3aLbEBhv+nbHKAeOYws3lcK3KeeaIk5ZHIgGwTf5o8YVzaisckElO4lLdcVkUNToWx4hLUfwH8I+E1g== +api: eJzNV21v3DYM/isCsQ8JoNxd2mLYDhi6tEmxYOsapGkL7HpbeDbvrNaWHEnO5er5vw+UfbbvpU1btMC+2RIpkg/JR1QJHhcOxhNYGvve5RiRg6mEmFxkVe6V0TCGV3mMnpzwCYmYPKrUCTMPv62aUDFpr+aKYjFbhb2FuiUtrluR8/h6ABJMThb55PO4PfvNWgYk5GgxI0+W/SpBY0YwBmMX5zFIUOxQjj6BbS9f2AVq9SEcLXSRkVVR55Vl05ZuCmUphrG3BUlwUUIZwrgEv8rZitKeFmRBwtzYDH299OMjqCrZutIL6JMOtUF9B2+mtTo5/8TEK9bZl7K4l58mcWw4MtqT9qyFeZ6qKGA2fOdYtdz1w8zeUeQ5NZaT5xU53q3haKWct0ovoJIwL9L0z49tbvi5Z/9WOTVTqfKr3W0JpIuMy/Xi8vz1ydUZSHj528nl2SkXrVc+ZeHX3QlV1S1vVdplDR9ULLOZirDgcqNdHeiD0WgX4Re/fzsk2yztmnmznUChdJQWsdILcX4qBSdBCka8+eypS9GBKQXqWHiVkfOY5W6zACddzmSd141EMLifDEDFn1O2EnSRpjjjdNQl/yUNU8m24jK8+4P0wicwfjRixvCeLJ/w9wSPPpwc/fX2bTw9eDzu/f07OfpnevD4l97S4WF5LB/+VP0AcqfOtrpJq5uiT3bsiFgqnygdqM70uGcgnhfOixmJB0ePRiJK0GLEdCaF82h9SATpOOgLTPME1+H2ZVkqQi24xFBpkazyhLQTxopCx2RdZCw5MSO/JNI91cF2C/bQOh6N7ov1GZdSrFye4qqOc27sJtcPxHO8U1mRiePRaNvyVn9vGr/X+ovwgWm/jHfumg37Ow5sEsjHKqyTEo68V3oxECdRRLl34rphl2txYHS6EjlaryKVo/Yu5ASjiJw75Fxc1/xzLQ4wTTfqQGSUzcjWGreKloeDPYX2pYQmgVnsqSWm930M2fYcyx1xw++AfLVmAbFMSG/d40t0IqqPD3Cm6Hxzm3wvc2xCFLWNwQZnd3NBf/U0HD/rc3nN1kzmlYRH+/j6CcaiuTK/hLj7HJmRc7ig++lwLbh7v/WiOLPW2B3PH+65adYDk9DGC0xTs6QYgvTPu9KnRR1OTVL/11ArCY6iwoYunZTwhNCSPSmYJyZTHm8y8onhCTEvglWesMYwNHbhhmWYBqthN7QOy95UVgGfbm/XI2RhUxhD4n3uxsMh5moQpaaIB45uyOJAmZ2SfRl2xEWKngtcPGV5cXJxDuza2vOXDF0NQ9//Fgm2CM1cx/+zIASy+Xi2bp13Sx/g4pRcdlPd2R1meUrdqNXrupbeP0ak7XKfDluWqXhunZvga5OjJmSO8T40GFsVkWuEww0VhQLbRLqPL2Wo0jAJzM2v3QbzNVlX2zkeHI8eDEa8mBvnM9S92GsO6phj28uyK/Rv/GBpsunpzg/zFJVmB0OkZVOWE36eOJAwXj9Tes8pCeP+i2EqITHOs1JZztDRK5tWFS/fFGS5G6YSbtGqek6alBArx98xjOeYuu2pqR/3wWXTwofiM15De+NqFlGvuHYwLfgPJLynVfsK47fQVzl134voKzzqQ1tNKwkJYUw2AFdLPK09Obric7oTdriQo6o16jngk7J9grp4dcU93bzDMhOzisUlT9i4rJ01AZhAFWGthBT1ogjMCfWRzAC4SSBbhBGC2gtHWdYSV+Y96apq0fH8z7hU1X/MlYT7 sidebar_class_name: "put api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Updates the details of the workspace identified by the given `workspaceId`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/upload-dataset-v-2.ParamsDetails.json b/platform-api-docs/docs/upload-dataset-v-2.ParamsDetails.json new file mode 100644 index 000000000..63aa0b456 --- /dev/null +++ b/platform-api-docs/docs/upload-dataset-v-2.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier.","schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier.","required":true,"schema":{"type":"string"}},{"name":"header","in":"query","description":"Indicates whether the uploaded file contains a header row. Default: `true`.","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/upload-dataset-v-2.RequestSchema.json b/platform-api-docs/docs/upload-dataset-v-2.RequestSchema.json new file mode 100644 index 000000000..aee5fc006 --- /dev/null +++ b/platform-api-docs/docs/upload-dataset-v-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Dataset file request","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"title":"MultiRequestFileSchema"}}},"required":true}} diff --git a/platform-api-docs/docs/upload-dataset-v-2.StatusCodes.json b/platform-api-docs/docs/upload-dataset-v-2.StatusCodes.json new file mode 100644 index 000000000..63934b005 --- /dev/null +++ b/platform-api-docs/docs/upload-dataset-v-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetName":{"type":"string"},"datasetDescription":{"type":"string"},"hasHeader":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"createdBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"lastUpdated":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"url":{"type":"string"}},"title":"DatasetVersionDto"}},"title":"UploadDatasetVersionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/upload-dataset-v-2.api.mdx b/platform-api-docs/docs/upload-dataset-v-2.api.mdx index ba40fa803..a28699e8a 100644 --- a/platform-api-docs/docs/upload-dataset-v-2.api.mdx +++ b/platform-api-docs/docs/upload-dataset-v-2.api.mdx @@ -5,9 +5,9 @@ description: "Uploads CSV or TSV content to create a new version of the dataset sidebar_label: "Upload new dataset version" hide_title: true hide_table_of_contents: true -api: eJzNVktv4zYQ/isET13AsbOPFqhPm8cu1ijaDfLYHgIDoaWxxUQiFZKyaxj6750hKVuOFMcFetiTLXKG883MN48Nd2Jh+fiep8IJC87y6YCnYBMjSye14mN+V+ZapJZd3Pxg2rBb/Em0cqAcc5olBoQDJpiCFVuCsajE9Jy5DFh8k8kUheVcQspma3+zkEtQ7CEKTNKHIfsikoxV3haTCp8tUMl66eZZVRUzMEM+4LoEIwjfJN0ivAyP/fiA96UwogCHeujbhiv8QLmVNk+2FAmg1oBLcu65ArPmL13+uxEkk2BksnPBm7dJBoXg4w1365JelhiPBRi8mmtTCBeOfvvE63qwNb/1tjFeCpd1bEc3mHVGqsULwwaeK2kAnXamgh4gQWvPbAYi9dAOODxRqUwwj5atMsCQGx/3kA3M2lzm4JMupLKY6/AkM3o1ZJcwF1XuxuyBID30hmemdQ5CIaxp8AGsO9fpmkT6vfcWoyS+GAlH8gUak5hfN6JQn1BQ6bhjU88eISHd0hBbnARLt/RwN16tvM2kEhghjCB30pEw/5NMXgcwX1H/JtiqSWY/I/7AllrZYO3D6WnXx+9/7HskyjKn6OPt6NGSyPHuxNJ4W3BHvi5ZBs3tX54xr99ftv3oEcuE/RbY1pP7QQ/Y1+sGI+Q7S3ruWbIL8z0XS0RDOhghmROxqaIqC8bjR4odDoVMj0SwfbLP12C87ybi6yvKLaXu8OmJmmuSz4V1d2VKzh5kJkmcOIl4UIl4/Cq2AlIpbv1pz227DR4ZCNPnacudpveGBF86ve/sXn8OMtexTKiKUPRTX6Gc4yjo7QGHK6bNlQKsFYsjSNEIHnTzizHadJB/7CnxZj4xpR0Tea5XiIfELSSVkW7t59I5CAPmrMIxML6fUnPEoZVpmmml9k77ETHmo2Y8jzbbQq5HoT9TwwWzbGadzxXPnCvteDQSpRwmua7SoYVnxDSUutP8b/wNu8qFo9SzC5JnZ1cTTogawL7phVi1YW/DRRab3u/r3gvhSfjztSHV48r5QEhiP6nH2EYUZPYtgOSuTHBYBWE/mBJPjH3n2y7HcvVmP+8u2l2Jvx/+/uvwlM4o+oXwvIpTNHDYbznNWtMovoC72TH1p9ydYr4c/ONGZY4TvVXhgW6tbXDAx+21JTIOaZERP1Fys5nh7Z3J65qOw3pBPEylFbOcqnAucgsHgvTWttUL+AnWnY1uKfKKJDltP8fb/3+XnwNot5vYDuiUPowkpP8xar9cxzb3jh1cGXvxxEOh1m00Dc5dxuspTfU40hFeuL8IIE78hNnp921mlImgdJYkULqWeKeJ7/W/q+83t9Q84pZY6JR06GH/7mD3lzonDt39bvSi+3jwvU4jf73ErX4ChRxuYuDom/yv638BafiMwQ== +api: eJzNVktv4zYQ/isETy2g2Nl00YNOzWMXNYp2g7x6MAxkLI4jJhKpkKO4hqH/vhhSsuVYcVJgD3uTyCHn+4bfPNaS4MHLdCoVEHgkL2eJVOgzpyvS1shU3laFBeXF+fWdsE7cXN+JzBpCQ4KsyBwCoQBhcCle0HltjbALQTmK9k6hFRrSC41KzFdh50G/oBH3rcFE3Y/EF8hyUQdfQpvMYYmGfLDurjV1OUc3kom0FTpgfBO1QXgRL7s7kYmswEGJhI65raWBEmUql9Y9+QoynCiZSM3knmt0K/ma8r+dIbtEp7MtheDeZzmWINO1pFXFN2tD+IBOJnJhXQkUl37/LJsm2bjfsO2cV0D5nu+WhvDktHl45djhc60dKpmSq3EASDy14zZHUAHaAcITo3QGhF4sc6QcXYh7fA1UYqELDI8O2ngBIl4pnF2OxAUuoC4oFfcM6X4wPHNrCwQjm2YWOaCnM6tWbDLMPnhsLWUiW8GxfVkXpCtwNOZQH3FQeXnPp50/YsZnK8dqIY2ed/ni/Xj13m2uDbgVR1CSJjaWf7PLqwjmqy7wOvpq2Gb3RcKCr6zx0dvJ8fE+x29/7TKCqio4+tqa8aNnk4/TaVPjfcOt+PbFknS7/wTFvL1/0ecxYJaD/zOqbeDtkwGwb+dNImNlUWdBJdswTyW8AAGfwRJ0wcLmjKo9uoB/lrwTCq0+iGBz5RDX6Hxop8U3lJQbSd16dBOzsGxfgKfbSjHZg8pkiyPSJfIh1vGb2EpUGm7C6sBuvwx+MBBuiGmPTld74wNfkN0lu1Ofo81VmyacRU0iPw8lyhmo4RpwOGP6WinRe3j4gCg6w4M0vzhn3R7y3wZSvOtPwlgSUBR2iSpc5TGrnaZV6EtnCA7daU25TKczLo4lUm65p1U2kA4tIpXjrj2P15tEbsaxPnPBRffS9brwVjInqnw6HkOlR1lhazXy+IwORtruFf/rsCMuCyB+enHO9uL0ciIZUQc4FL0Yqz7sTbjYY1f7Q94HI5m0H187UT0uKQRCs/r5eBvbFgW7fQ8g09UZ+tY4NKYsCGOXfJ9ym67B7R/bjX5Vkp9Gn45PRse8yOEvIQirbaNRxGHM6eaa7uQrvOutVH/K4al9MML/aFwVoE0vxaPeeuNgItP+3NJKbpbInAWaTuV6PQePt65oGl6O8wULUWkP84LTcAGFxwNBem/cGgT8hKu9ke4FipotJY8/H/f/Y6efA2g3o9gW6Ix/nGak/zNqv1y1de5XcXBmHMTTLoJZ9dF0OLcv3sy4rbc9fbpu988jiKPQYrbnh0Yzfol46DTLsKKe+V4V3ymAl9+ub7h6tGNiaRWf4YvDvcn2k0tnImG3HL0qPwH8IOn1Olrc2Cc0TbOJAfE/82+a7yXEjOY= sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Uploads CSV or TSV content to create a new version of the dataset identified by id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/upload-dataset.ParamsDetails.json b/platform-api-docs/docs/upload-dataset.ParamsDetails.json new file mode 100644 index 000000000..f26b9c98f --- /dev/null +++ b/platform-api-docs/docs/upload-dataset.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"path","description":"Workspace numeric identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"datasetId","in":"path","description":"Dataset string identifier","required":true,"schema":{"type":"string"}},{"name":"header","in":"query","description":"Uploaded file has header","schema":{"type":"boolean"}}]} diff --git a/platform-api-docs/docs/upload-dataset.RequestSchema.json b/platform-api-docs/docs/upload-dataset.RequestSchema.json new file mode 100644 index 000000000..aee5fc006 --- /dev/null +++ b/platform-api-docs/docs/upload-dataset.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"description":"Dataset file request","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"title":"MultiRequestFileSchema"}}},"required":true}} diff --git a/platform-api-docs/docs/upload-dataset.StatusCodes.json b/platform-api-docs/docs/upload-dataset.StatusCodes.json new file mode 100644 index 000000000..63934b005 --- /dev/null +++ b/platform-api-docs/docs/upload-dataset.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetName":{"type":"string"},"datasetDescription":{"type":"string"},"hasHeader":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"createdBy":{"required":["avatar","email","id","userName"],"type":"object","properties":{"id":{"type":"integer","format":"int64"},"userName":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}},"title":"UserInfo"},"lastUpdated":{"type":"string","format":"date-time"},"fileName":{"type":"string"},"mediaType":{"type":"string"},"workspaceId":{"type":"integer","format":"int64"},"url":{"type":"string"}},"title":"DatasetVersionDto"}},"title":"UploadDatasetVersionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/upload-dataset.api.mdx b/platform-api-docs/docs/upload-dataset.api.mdx index 1ae05dc9b..484488f34 100644 --- a/platform-api-docs/docs/upload-dataset.api.mdx +++ b/platform-api-docs/docs/upload-dataset.api.mdx @@ -5,9 +5,9 @@ description: "**This endpoint is deprecated. See [Upload new dataset version](ht sidebar_label: "(Deprecated) Upload new dataset version" hide_title: true hide_table_of_contents: true -api: eJztVktvGzcQ/isET7Yhad00LVCd4keDGkUbw5LTgyIg1HJk0V4t1yRXjiDov3eG5D5krWUn55y0Ir/hfPOeDXfizvLhhEvhhAVn+bTHJdjUqMIpnfMhPzkZL5RlkMtCq9wx/JZQGEiFAzlgIwA2uS0yLSTL4YnFh9gKjMUHpkcL5wo7TBKpUzuw8AhGDJROiky4uTbLvihUUnr5fpTtr/rvjhleMrcAlpbGAOqtCAxOTr7kX/Kg0nrIxegzQ/QYf1KdO0I7zVIDSJEJTyvSYXruJSqWSiJYzRVINlv7mzu1gpx9jYAr+XXAe1wXyJr8cSXRI0H1ZUDgbSGMWIJDDejJDc/xD6KetHmwhUgBZXpckSsL4Rb8uX//q3AsL5dgVNqQMgg28FgqA6jXmRJ63KYLWAo+3HC3LkgPugTuPJTcKVw4+v093257NZnanINUoknMOqPyu+/kEYR2tC5ASC/sVT6WYNZ7OoMz0f9zlQFbCMtqqT0VM60zEDnqmAZCYN25lmuCdFviH41IfDFmB+GXZeYURs4lPgvJQXS8p1PP7iH1UTaUBU6BpVt6eN/4VgxmKhdoLrqDO+UIzP8hlTeBzEeUHwVdW8Lsutcf2ELnNmh7d3q6b+Onv3ctEkWRqdSnaXJvCfJ2c2J5vA5sEmk/8r3q9l8f/pfvL9t2dMAwC/4KSdAR+14H2ZdrAD3k24A891nSuHnCxQrZkAx6SGWUpVQdpQXj+WOKHXaFkm9kUD/ZZWtQ3nUT+XVVWJ1St/j0VT7XhM+EdbeFJGMPZiYh+k4hHxSiPH6R2xKkEmN/2nHbbnBvdITpsrRlTizbzyHAl07vGtvuuxFzE8uEqgih77sK5RxHU2cPOFwx7VxZgrXi7g1JUQEPmvmnMdrsMf+1o8SrucNy7ZjIMv2EfAjejOC6IQNOSuXWfgadgzBgzkps8sPJlNolDqiFpulVaBuGFt3xpI6iTTatiG6TaiNINnXNb+Ogpt4MZlUNPB9WXs15nOeDNNOlbIb9XtMf+Rt2HXcAdkF4dnZ9xYlqZYnvj8GtbXtqz5LGakz4FuFBeBI+Plb5d//kvM8UFQqJxzBEFqT2NYJkrkIfRTDlkEh9Du0a3zY5VrZX+6G5aDcw/svgj98Gp3RGYVkKn4Jxeh5d1jE+Zi9vWM+5b5oM/7m78bpeHXxzRFzlrU4UimDStDKLAsPdza3ejPGmvUbFUsB8XVBF4SubzQxvb0223dJx2HeoQKSyYpZRqc5FZuFAwA5sQ512PMC6vWetRFYSyJfRShhFar+TwtFN7HvH7JXVtJNRPBT5us2nYtp2LS2KP0Tr0Jr6A5yaoG6ntHzEzQOdFu4vAoe+H4SNfNcCSSYFobM0hcK14HuzZqcpX38ajalxxWV2qSXJ0MP+3V7zSe0cd4PdTvis83nynUZjinrEWD9Ajmla+cDRf7J/u/0f4CfiSg== +api: eJztVk1v4zYQ/SvEnJJAsbPpogefmo8uGhTtBnGSHrwGdiyOYyYSqZCUU8PQfy+GomQ5VpzsnnuzxUfOe/O9Bo8PDkYTkOjRkXcwTUCSS60qvDIaRnB0dLtQTpCWhVHaC+WEpMJSip7kQIyJxOSuyAxKoelFxIfEkqxTRk8PFt4XbjQcSpO6gaNnsjhQZlhk6OfG5sdYqGEZ7h/Hu8fL49NDMTdW+AWJtLSWtG8JDI6OvulvujbpAuRifC+MFbfje5Ea7RntjUgtoSeBgVakI8w83GhYKknaq7kiKWarcPKglqTF9wi4kt8HkIApyCL740rCCGrTlzUCEijQYk6eLHtyDRpzghG8GPvkCkzpSkICil1ZoF/Aa//+0+CELnOyKt2QspCApedSWZIw8rakBFy6oBxhtAa/KtiO0p4eApTdib7+9OtnqKqkJdPK2UslShLOW6UffpBHfWnL6oJQhsvB5HNJdrVjs3YmSTFXGYkFOtHe2jExMyYj1FBV05oQOX9u5Ioh/UrCoxEJCcTsYHxeZl4VaP0wZCE7iD/v2DSzR0pDlC1ngVfk+JQf3hXficFMabQrdgd45RkMf7HJm5rMF5XRuLZVMWbbveGDK4x2tbXTk5NdjV//3FaERZGpNKTp8NEx5ONyYnm8D9wk0m7kk+b07xD+t88vuzp6YAt0f9RJ0BP7pIfs2zWQQN0G5HnIko2bJ4BL9Mh3KEeVcZZydZSObOA/Td5xhZIfZNA+2ae1Nt53Evn1VVibUneO7JWeG8Zn6PxdIVns3sxkxLFXOfElzuM3ueUkFd6Grz2n3Qb3QUfYPqUdObFs7+sAX3qzLbbbdyPmJpYJV1GVwOe+QjlH2d8D9ldMN1dycg4fPpAUDXCvzN+tNXaH+S89Jd7MHaGNF5hl5oVkeGozgtuGTGlplV+FGXROaMmelX4Bo8mU22VOfmF4ehXG1UOLz2DYRtEN152IVsNmIxiu25qv4qDm3kx22Qy8EFZo5jwWapBmppSbYb/T9MfhRFzHHUBcMF6cXV8BU22UhP5Yu7Wrp/UsW2zGRGgRAQRJ/PGlyb/HFx98prhQ+HoMQ2TBZt8jyHJVSi6COYcwDTm0Lb4rOVZ2MPvb5qDbwODT4NPJ6eCEP3Jccgw5GMfnwWUb5EPx9or1mvx6k+L/L2/QFqynfz0TV7rTiuoqmGx6mYMERturW7saJzDq7lGxFqYJLLikRhNYr2fo6M5mVcWf64WHK0Qqh7OMa3WOmaM9AduzDvXqeKJVd9FaYlYyKNTREq1isz9I4eAmNr5D8c5u2ssofkS96vJpmHZdy5viT9Hat6f+BKdNUKspbx9x9Zis4/lFzeE4TMLN/b4NkiXVl87SlArfge8Mm62ufP11fMudK26zuZF8hx8O7yabn9zPE8DtVviq9QXyvaLX6xpxa55IV1XrA8//WX9V/QfYVuJv sidebar_class_name: "post api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + :::caution deprecated @@ -48,30 +49,24 @@ Uploads the CSV or TSV content to create a new version of the dataset identified id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/user-info.RequestSchema.json b/platform-api-docs/docs/user-info.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/user-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/user-info.StatusCodes.json b/platform-api-docs/docs/user-info.StatusCodes.json new file mode 100644 index 000000000..7d047a2d4 --- /dev/null +++ b/platform-api-docs/docs/user-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"description":"User details including ID, username, email, first name, last name, avatar, and organization membership.","type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User numeric identifier."},"userName":{"type":"string","description":"Unique username."},"email":{"type":"string","description":"User email address."},"firstName":{"type":"string","description":"User first name."},"lastName":{"type":"string","description":"User last name."},"organization":{"type":"string","description":"User organization name."},"description":{"type":"string","description":"User description or bio."},"avatar":{"type":"string","description":"User avatar URL."},"avatarId":{"type":"string","description":"User avatar identifier."},"notification":{"type":"boolean","description":"If true, the user has notifications enabled."},"termsOfUseConsent":{"type":"boolean","description":"If true, the user has accepted the terms of use."},"marketingConsent":{"type":"boolean","description":"If true, the user has consented to marketing communications."},"lastAccess":{"type":"string","format":"date-time","description":"Timestamp of the user's last access."},"dateCreated":{"type":"string","format":"date-time","description":"Timestamp when the user was created."},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the user was last updated."},"deleted":{"type":"boolean","description":"If true, the user has been deleted."}},"title":"UserResponseDto"},"needConsent":{"type":"boolean"},"defaultWorkspaceId":{"type":"integer","format":"int64"}},"title":"DescribeUserResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/user-info.api.mdx b/platform-api-docs/docs/user-info.api.mdx index b66728a97..1d2daf663 100644 --- a/platform-api-docs/docs/user-info.api.mdx +++ b/platform-api-docs/docs/user-info.api.mdx @@ -5,9 +5,9 @@ description: "Describe current user" sidebar_label: "Describe current user" hide_title: true hide_table_of_contents: true -api: eJy1Vktz00gQ/itTc9mLscNjqdqcCAlQLraAgqQ4UDm0NW1rEmlGzIySzbry3+nukRX5AdhQXGyp1f19Xz9GraVOsIj6+ItuI4aoL0faNxggWe+mRh/rCzJP3dzrkQ4YG+8ikvtSPzk64j+DsQi2YXdyfv+W3ArvErrET6FpKlsI2OQqsstSx6LEGvgq3TVIQX52hUWiwCYwdbKZgPVsM7AcZTCBraKyrqhaY91CTc9GigMc1DhShG+rkZrbEJPKpgr6S7iBBIH+nVE+LMDZ/0WhqrGeUQ1K24xJzY/VWTPIwFLCC1I70nMfakjZ9PwZGXaod22NwRbKGqqSnVsMY30/knzfkcABbkyBkttGcfZri32+Ei0p7xHKAsRXgTHU0CjRUqk9yRnhobISzsU9ILrvhQQPW7AnwFrXeqA1x71wBibCVDPrBSgPyJ4Y2VldfPx3EDs1h0VvjILzfFNslmTmfYXgtpCmc5VCS5OdyjwVqoSohiBRoYNZhUbgE4Y6vp+TgFM+zvmo/hIHFAU2CY1YBVb5OT8WnhrCNSbK/XdpihzPPF71qGSu69atUuwn8YRExbirAf3pNJDwUbI0sZsCzskYE9QNJ7IS8VfMMwuCnIeNEE4D0u/OVh/EdFuie0j4lhPOyH1KF435Q0ySV5vhu1NU4TrVYb2aIVF0IATI42ZThd3Af+xWyFnyMuiI5vvDIWrm0Fbpsw/XsYECp3u9doesZ6J5hkN2cmCXZ7tW2EswKiC9X2M6ZJdxiA1cty+aqh1hgbxLf7xEVo5bbR0m8CoEv6386Y7lu9rbfPQVVJW/JT3sHrFog013JG6pXyIEDCdtKun28v5ys62rgimKCZS7tJak15hKz18EC5RMgAH0hJ8+svkDgS5v+COCadpA60iXKTXxeDKBxo6LyrdmHPEryRxbvzVPn+SJ+lBB4n6qU/ZXJx+mmkWucvjEJc/lG2bSV5AZWYq48TCJE1nyxevVpFzdJqmNSOfwrtydCqb9mUBO19IboXPmWYFCZmU9+WHK3Z4W2hcPD0gIVy7zPB7/8/f4iG2Nj6kGGTUn+/W73dm9/BL+lyZNBVYOk6hadp3LH3y5c1TekpjYuFzOIOJFqO7v2UznIPDY0OUNBMs7RKaGAhAMf6BRq6+RXPSJ7ALNjlXL5FsHhtvYT9GbV+fkC+vN22iWoHePwN0NsEmmeJz7a3QkddSJSHxPRHRKvgF/acOz +api: eJy1Vk1z2zYQ/SuYvfSCSE6a6UGnOnba0bTTZBJretDosAJXImwSoIGlXZfD/55ZkKIpS2mkZHoSCOy+tx8PWjTAuI0wW0IdKURYafAVBWTr3TyDGSwihbnbeNAQKFbeRYowa+DNxYX8ZBRNsJWYwww+/AEajHdMjuUUq6qwJoFNb6OYNBBNTiXKip8qghn49S0ZBg1VEGq2HYHEc8gg4aiMGG0RlXWmqDPrtmp+rZU4OCxJKyrRFlptbIisuq0ChyU+IGPQCl2mfNiis/+mCFVJ5ZpCzG01Af2N6Gw2ysA6pi0F0LDxoUTutn55C/pY9K4uKVijbEaO7cZSmECrU75/YUkj3MjBuu0hirP3NQ35Ju+U8gmuEkCyVZhlgWJM3qlSJ5ILwnNlk7sU9wzvoRfJedyCEwH2ujYA7RmehDPaUj6otfUJqBPIiRidsVp8+nPkO8/O834hBeflw7wsydr7gtAdIM03ikNNWnHeqULlGNUYJCpyuC4oS/BMoYwfNotIV3Kdu6v6XRxoDFVMWdpNsMpv5DjxlBjuiK3b/iiN6fyFx6sBVRlflrXbpTgo8dIYivFYA4bbmSHTK7YlHQRwY0uKjGUlieyC+Cl2msWE3IkNma4CIdPRVp/F9JiTe074URLukIeUFlX2PzGlvOoOvr9FBe1TnderNZFTPcgEWpGb5YJ6wX/qR8g1+yR0ouzr4kjRbLAu+G8f7mKFhuYn/e2OWa9TzGsas0PbisnbYyPsHWYq0H1Nkc+ZZeJig9RtCSXFiFuSWfrfQ2RneNDWcQLvQ/CHkf98ZPju5rZcfYVF4R8pS1CRTB0sP8Fs2cA7wkDhsuYcZstVu3rZ1l3BlKlDIMeptaChJM69vAi2lDJBAYCpnL6y3QMhUniQR4TQ1KGAGeTMVZxNp1jZiSl8nU0i3VPAifUHevqcTtTHAln6qa7EXl1+nIMEucvhs5S8K984k6GCwiihJDMRUzIC3S9+2ynl9pFTbVLo4t6Xu49CaL8VoKRrDcXeWLSCJmllP/lxyv2cTrS/Ph+0GqRyHc/ryeuLN5ML2ax85BKT1lwasF9tz/Hpx/QPT6sCbbpNKaymb1334utat9KQ+8iy2TRrjLQIRdvK9n1NQXSz0vCAwcoQSbLRkBNm8kJbNnBHTzCDyzQMQAyLWsgPboz0cZDR7+9vQAPud+9FtxJ6f4TuaYTdNJ3Fjb8j17ag+yBYvqFdtW37BQSfw9g= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -41,23 +42,17 @@ Describe current user - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-action-name.ParamsDetails.json b/platform-api-docs/docs/validate-action-name.ParamsDetails.json new file mode 100644 index 000000000..707168ceb --- /dev/null +++ b/platform-api-docs/docs/validate-action-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"Action name to validate","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-action-name.RequestSchema.json b/platform-api-docs/docs/validate-action-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-action-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-action-name.StatusCodes.json b/platform-api-docs/docs/validate-action-name.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/validate-action-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-action-name.api.mdx b/platform-api-docs/docs/validate-action-name.api.mdx index 951a0e90b..b239862f8 100644 --- a/platform-api-docs/docs/validate-action-name.api.mdx +++ b/platform-api-docs/docs/validate-action-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms the validity of the given action name. Append `?name= - + @@ -42,30 +43,24 @@ Confirms the validity of the given action name. Append `?name= id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-compute-env-name.ParamsDetails.json b/platform-api-docs/docs/validate-compute-env-name.ParamsDetails.json new file mode 100644 index 000000000..f41c07e11 --- /dev/null +++ b/platform-api-docs/docs/validate-compute-env-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, validates compute environment name in a user context.","schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"Compute environment name to validate for uniqueness and format.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-compute-env-name.RequestSchema.json b/platform-api-docs/docs/validate-compute-env-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-compute-env-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-compute-env-name.StatusCodes.json b/platform-api-docs/docs/validate-compute-env-name.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/validate-compute-env-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-compute-env-name.api.mdx b/platform-api-docs/docs/validate-compute-env-name.api.mdx index c3b04f036..493e95daa 100644 --- a/platform-api-docs/docs/validate-compute-env-name.api.mdx +++ b/platform-api-docs/docs/validate-compute-env-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms the validity of the given compute environment name in a u sidebar_label: "Validate compute environment name" hide_title: true hide_table_of_contents: true -api: eJzNVW1v0zAQ/iuWP3dpgYG0ibeuDDQhwcQGfEDT5iaX1ltie/alo4r637lzkq1vGyAE4lNr32Pf8/ieu9QS1STI/W8ytaWrEHbAzII868kMQuq1Q22N3Jcja3LtyyBwCmKmCp1pnAubx/VEz8CI9gJBF2hvTQkGhVElCG2EElUATxCD8B0TMXQOTCYuXjHgxfO5rfx5Cue8enmRyJ60Drzi3EcZZf/CCRXCqElxaGYfCEkwpzz9QfAsoZZ8nuA31l8Fp1Kgwz2pmf91BX4u11V97YDCVCV4nQqdEW2da/CJOMqFLTUiZL1GMjEIvyOT8oV0CqWS+7XEuWNumkIT8BTKrS8VNlvPduVi0bsVYBp1DzAf3ccC7S1XQRlEZTTdYCAEoejFm6RbmQX02kyIBxXfQ3DWBAgcfzzY5Z9VAh/fix3xwTZaDcpFT+4OBpu4A5UJD0QhICXt0ARTzhU6jTXuXwbG1kuc+Ij2kLEzSyKvJsCmbKna8SWkfJ/zbBTUDdEOuEUTHdVY8Nah99Z/avVRZBGZP9misLOgMBaFKgp7Q3wiem8T/aZq5FBJCuBy/K9qKRggrTz1b+yZA1Ae/LDCKS3PuPjUUFPLbTeBmFVxSPaXB0S/8xgbCfysa8DKFwSdIrqw3+8rp5O0sFWWBLimx0y03TDySYyI40Ihe1OMGC+Gx0eSqXRMT/ipGtnLfG+Vc8bO07weRxDtNH/edq12eYPxebTJbTzePlPLgtP+jCDL1SkNggbMNVZprPGq+GXJVGZdxE7P7eu7ABHhl2vyPEr2niYD3nM2YKmiRdp50M2/e4fPOuv6znv/fHS3JWF03xWKhhhpim9Tt15a+9jQK3RuopJPST1D6nqsAnz2xWLB280YZI9lOqhxwc2SqyLAA8r//njfqvUK5hsfIUpQMVLylP91BX8+5h9g2BrnjtoZL7xmbnEWUDFAZdRH/OzNmWGagsOlUxuDbWWCvDs8Jaxabda15oy3tyFl5kt3kwUi4tRegSEbdMSR15SIhtkPaHkNig== +api: eJzNVdtuEzEQ/RVrnk0SSoXEilspBVVIgLg+VBFMd2cTt7u2a8+mRCv/O5q9tGlTCgiBeEpsH3vOmTkz2wLjIkJ2BLmrfcN0h+wqwlxDQTEPxrNxFjLYd7Y0oY6Kl6RWWJnC8Fq5slsvzIqsGh5QZFcmOFuTZWWxJmWsQtVECip3lukbT9Se92QL9fWJAB49XLsmfMnpi6wef52ABucpoMQ+LCCDTxIQmfb7EAd29RprAg0eA9bEFERCC3IfMjh34TR6zOmwAA1G+J81FNZwXdXnEahsU1MwuTIFWTaloTBRh6VytWGmQveSkSn+jkzQEPMl1QhZC7z2ws1YpgUF0FC6UCP3W/d3ISV9IcD26m5hvv8jFuwuuKrSBdVYc9aQpRgV2kL1QW9kFjkYu4CU5hoCRe9spCjnO7Nd+blK4M0rdUe9dr1Wy5A07M5m27hnWKhAZw1FBg0jOmsBva9M3tV4ehIF225wkismUCHOrClGXJCYcqDqjk8ol/d8EKOw6YmOwBs0aWDDlWwdhODCu0EfpJQ65vduUDhaUFnHCqvKnVPR63ywjX7e9HJIUUVSjv9VbdIQKW+C4XXXM88IA4W9hpeQHc2l+DXx0knbLaiLinIE080BMR09JkaisBobsAkVZLBk9jGbTtGbSV65pphEOqOAE+O2jPy+O1FvK2TxptoXvNp7ewhCZWT6XlLVy97ke6FcIo6elvVxBwI9/HkxttrJOXfpMbZ03fUhTQMLCfszgiLX5BQHsNQY867GV8VvSqYaTdV1eumeXh4kDZK5Ps7dyd3ZzmQmm95FrrHzyDAQxgH4w+lznXZ7ab5/PruHmgh66is0VjR1yWkHM1372mi4sNNcw9JFFkjbHmOkj6FKSbb7OSgmK0zE40q6pcQq0i3K//58v1HrKa23vkIrrBpBgoz5X1fw53P+FoaDcS6pzWURjHDrhoGGJWFBoUt7f2cvz8nzxq2tyXZlhLw8+AAa8Gq3XuvO7vXhCO164+227REf3CnZlGAkzrKGNE8pfQfOMg2v sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms the validity of the given compute environment name in a user context. A id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-credentials-name.ParamsDetails.json b/platform-api-docs/docs/validate-credentials-name.ParamsDetails.json new file mode 100644 index 000000000..e1fc62c13 --- /dev/null +++ b/platform-api-docs/docs/validate-credentials-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"Credentials name to validate","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-credentials-name.RequestSchema.json b/platform-api-docs/docs/validate-credentials-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-credentials-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-credentials-name.StatusCodes.json b/platform-api-docs/docs/validate-credentials-name.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/validate-credentials-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-credentials-name.api.mdx b/platform-api-docs/docs/validate-credentials-name.api.mdx index cb9c0b059..231402a15 100644 --- a/platform-api-docs/docs/validate-credentials-name.api.mdx +++ b/platform-api-docs/docs/validate-credentials-name.api.mdx @@ -5,9 +5,9 @@ description: "Validates the given credentials name. Append `?name= - + @@ -42,30 +43,24 @@ Validates the given credentials name. Append `?name=`. id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-data-studio-name.ParamsDetails.json b/platform-api-docs/docs/validate-data-studio-name.ParamsDetails.json new file mode 100644 index 000000000..970489de9 --- /dev/null +++ b/platform-api-docs/docs/validate-data-studio-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. When omitted, the name is validated in the user context.","schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"Studio name to validate for availability.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-data-studio-name.RequestSchema.json b/platform-api-docs/docs/validate-data-studio-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-data-studio-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-data-studio-name.StatusCodes.json b/platform-api-docs/docs/validate-data-studio-name.StatusCodes.json new file mode 100644 index 000000000..d41e3359b --- /dev/null +++ b/platform-api-docs/docs/validate-data-studio-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"Ok - No content, if the name is valid and available."},"400":{"description":"Bad request, if the name is not valid."},"403":{"description":"Operation not allowed."},"409":{"description":"Conflict, name duplicated in the given context."}}} diff --git a/platform-api-docs/docs/validate-data-studio-name.api.mdx b/platform-api-docs/docs/validate-data-studio-name.api.mdx index d9575df2b..c781a5282 100644 --- a/platform-api-docs/docs/validate-data-studio-name.api.mdx +++ b/platform-api-docs/docs/validate-data-studio-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms the availability of the given name for a Studio in the us sidebar_label: "Validate Studio name" hide_title: true hide_table_of_contents: true -api: eJzNVE1v2zAM/SuCzpnTbd2ABhi2rvtAL12BduthKFDWphMtiuRKdLog8H8fKduJ2wTddhiwky2RIt8jH7nWBNOoJ991pLowPurrkS4w5sFUZLzTE33iXWnCIiqaoYIlGAu3xhpaKV+mu6lZolMOFqhKHxSoixRKGZfMdcSgcu8If1KmjqsKXaFu3t77MI8V5HhavLlR5NUSrCmAMD1K0TgAqI3fJoYeaV9hAMF3WjDCb93LD0DQ5j7j5+xWQeAfwiAM11qCsvsgM/sY4XhXY1jpx8yvNqldvcBgcmUKdGRKgyFTVzNm7ReGCIvRAHTcMCn2loDTxHyGC9CTtaZVJZAMm6YY2MQVXAC1V68PddOMNrhdS+oJwF3hE45hRVNbBp3biyFSMG7KGVkBAWPlXcQo9hcHh/J5mOrLXD1TZ75l5WikTLlbAwXc6i6xxUw3I314cLAb7D0UKiBziruBnKc2WPf85R4svRqSM1jr77F3P9p1F0Fbk3OqlKOoKz4N29UKetMv7oGOmNeBK5d09B4hYDiuacbHa6kXi2zmRYpTpKQ7MelxN1PjvhFSdgzLXo91sOw1I6riZDyGymS59XWRRbxjQpnxuw1OFnVugUQo6kT81fH5qRYUPcgLaW3buyHUTaclY68AOd8mJ75pfz71EvxxT4m8caVPzw1Z3KKQtL8DKHRNjrFzlppCThLsIfkhZZalsWkCSv9ua2AgUrk2z/Ps6FV2IHeVj7QAJyG7OenXgRqMw2Oga90J9z9dcF2n5DiuLPDMM9VUsnWnru3G5rr0+mIRzLgeYl2vbyHi12CbRq7bhSGqK0yUaWS1lmAjPlGYf7b/9rKb42pnOXOkWjy1rME/B/43e/AJLJ1wtiCu5RCMoEiTPxj8zx8v2RUeDtqjwUrl70zgVoPQ3Kzkcenn6LhhPQKSM+dtmuYXYi6mVg== +api: eJzNVE1v2zAM/SsCz1qSdcWAGRi27hO9dAXarYchQFmbTrTKkivR6QLD/32gbKduU3TbYcBOtkSKfI98ZAuMqwjZd4jcFMZHWGooKObB1Gy8gwzee1eaUEXFa1K4QWPxyljDW+XLdLcyG3LKYUWq9EGhOkuhlHHJ3EQKKveO6SfP1FFdkyvU5ZtbH65jjTkdF68vFXu1QWsKZEqPUjTjFKqd3y4GaPA1BRR8xwVk8G14+QEZ+9wnWBFoqDFgRUxBGLYgQSGDSWbQYITjTUNhCw+ZX+xSu6aiYHJlCnJsSkNhpi7W5JSvDDMVegI67pgUj5YANMR8TRVC1gJva4FkHNOKAmgofaiQ+6uXh9B1eofb9aSeADwUPuGYVjS1ZdK5RzFEDsatoOuWGgLF2rtIUewHi0P53E/15Vo9Uye+Z+VYK1Pu10ChK8bElmbQaThcLPaDvcNCBbppKO4Hcp77YMPzF49gGdWQnNFaf0uj+6t9dxG0NTnrPkfR1Nbk03b1gt71q+s0RMqbYHibdPSOMFA4angN2fel1KsiXnuR4oo46U5MMB9maj42QspOYTPqsQkWMlgz1zGbz7E2s9z6pphFuqGAM+P3G5ws6tQii1DUe/FXR6fHIChGkGfS2r53U6i7TkvGUQFyvkpOoIefT6MEf9xyIm9c6dNzw5buUEja3wEUuianODhLTTFnCXaf/JQyVWhsmoDSv70zdBqkcn2e57Pni4PZQi5rH7lCJzGHQRn3gZrMw0OkLQzK/U833NAqOc5ri8YJ1VSzdpDX3crWsBPYUsPaRxZr215hpK/Bdp1c9xtDZFeYKONYQFaijfREYf7ZAnyU3TVt97bzBm0jniB78M+B/80ifALLIJw7EEs5BCMo0uhPJv/zx3PQgPcn7cFkpfIPJnTbSei27T3O/TW5roMRAcsZumXXdb8AcKymew== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms the availability of the given name for a Studio in the user context. Ap id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-organization-name.ParamsDetails.json b/platform-api-docs/docs/validate-organization-name.ParamsDetails.json new file mode 100644 index 000000000..4b93a4a60 --- /dev/null +++ b/platform-api-docs/docs/validate-organization-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"query","description":"The organization name to validate for availability and format compliance.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-organization-name.RequestSchema.json b/platform-api-docs/docs/validate-organization-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-organization-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-organization-name.StatusCodes.json b/platform-api-docs/docs/validate-organization-name.StatusCodes.json new file mode 100644 index 000000000..c9484338d --- /dev/null +++ b/platform-api-docs/docs/validate-organization-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicated element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-organization-name.api.mdx b/platform-api-docs/docs/validate-organization-name.api.mdx index 00db1e77d..36a929e56 100644 --- a/platform-api-docs/docs/validate-organization-name.api.mdx +++ b/platform-api-docs/docs/validate-organization-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms that the given organization name is valid and available f sidebar_label: "Validate organization name" hide_title: true hide_table_of_contents: true -api: eJzNVE1T2zAQ/SsanamTtvRApl+B0g7TGWAK7aXDwMbeJAJZEpIccD35792V7eIQpr30wCGxrX3afW/1tI2MsAhy8lNaT8+LHVlgyL1yUVkjJ/LAmrnyZRBxCZH+UCzUCo0gNBj1CxgmDJQoVBAr0KoQYOi3AqVhplHMrRdVwExMnUOKXH1g9Lu3ta38JWW55M/3VyJaERzmal6nKiklraWUEDGTO9I69KngUUHMfnSRkwGTY9pFQAeeXiJ6FtZIzkUbTBtULOu2Ql/Lx2LPqfC2sAGLpKbTprSKdRJLiyU1J7el0wpMnsiGfIklyEkjY+24fIhemYVcr6nHHoOzJmDg+KvxLj82qZx8FS/EsaWkJqKJcr0jd8fjbdw+FMIjyQmRivZogoEjMnmSMboOjG0GnHiL8ljwwZcYAiyQz76jamfXmHM+57nnUbVEe+ATmmiripqXDr23/lunjyLrxPz1Ewr70xTGRgFa2zvik9B72+hPVSsHC4EaSxb5TOVSMGBeeXJHct8+gkc/reKSPi/49MmaS8sWXmCqChySI76Ao95p7CD0q97CldcEWcbowmQ0AqeyXNuqyALeUhczZbe8fJYi4lRDZH+KA8aL6emRZAo9wzNuUSt3yPOPYq7Ym5m/ZwlEK+3L5+R8Wr++i6ktysxt2t61p2PBZf9FkOWqHEMH5rOFPJ3tpvihZDpexTEu+/EhQES4c22dl9nem2zMa86GWEKyRjcS+hmyfesf020ezPasZmJ3ThHv48hpoOFGQlPDms5Y3WSnlvTWovNfUis41DQzCPjd6/Wal9uxyIYrVGCq5NI56IB/6cb/HJpPqrnB+mF6U9KKIcnFK/CKWaaLRaIQCjIn02/3TPMcXRzs2poSG9fxy+E5YWHzBjxyfMrehcDUg9zUyoQ4tzdoqJ098cjfVIgmw28NN5Tz +api: eJzNVE1P3DAQ/SvWnNPdhXJp1C+gtKoqFVRoL2gFQzK7MTi2sSfbbqP892qcBBYWtZceOCX2PHvem3meFhiXEfJzcGEZYZ5BSbEI2rN2FnI4dHahQx0VV8iKK1JLvSKrXFii1b9RYMpiTUpHtUKjS4W2VLhCbfDKkFq4oJpIE7XvPdlSXb4T9JvXa9eECxeWF7J8e6nYqeip0It1ypKuZNdfiUwTyMB5Cinh5xJy+DFEjjeYfMWaIAOPAWtiCiKsBbkL8v6TgRZZtw2FNTwWe1bRE8I2WCQ1gzZtNK+T2IULNbIqXO2NRlsksrGoqEbIW+C1l/SRg7ZL6Lp5BoGidzZSlPjubE8+D6kcf1Ev1FenCmeZLEOXwd5sto07wFIFum0oMmQwovMW0HujiyRjeh0F225wkiM6UCmNrylGXJL0fqDqrq6pkPt8kJqz7omOwCc0ZcCajWwdheDCt0EfdF2XmL98QuHYTWUdKzTG/aSy1/lqG/2h6eVQqchQLSKfqdwug0hFEzSvk/sOCAOF/YYryM/n0v2auHJi4SWlrCghmMoDnI5OEwdRWI0WboKBHCpmH/PpFL2eFMY15STSLQWcaLfl5dMUUScGWfypDgWv9k8+g1AYGZ5KiXq5mzzvFEvG0cyyvkogyIafj8n5kMP1T05l0Xbh0vGhPAMLSfsvgiJXFxQHsPQWi9Tbh+I3JVONWmKS9v19oMtAKtfn2ZnszHYnM9n0LnKNyRvDTBiHyPazf8y3vXfbsxqKQ6OYfvHUG9RWhKaKtYOzhtGewZ235hlULrKE2vYKI30Pputku5+L4rhSR6FaQr5AE+kv1fifU/NJNTe0vh/fKzSNQJKNVxi0sEwvK4OKsKSQ6Pdn9ouCPG+c2hoTD97jp6MzyAAfPoFHlk+3DyG0642727ZHnLkbsl0HI3GWNXTzruv+AB72lRg= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms that the given organization name is valid and available for use. Append id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-pipeline-name.ParamsDetails.json b/platform-api-docs/docs/validate-pipeline-name.ParamsDetails.json new file mode 100644 index 000000000..552d2dbbd --- /dev/null +++ b/platform-api-docs/docs/validate-pipeline-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier. If omitted, validates pipeline name in a user context.","schema":{"type":"integer","format":"int64"}},{"name":"orgId","in":"query","description":"Organization numeric identifier. Used for organization-level validation.","schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"Pipeline name to validate for uniqueness and format.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-pipeline-name.RequestSchema.json b/platform-api-docs/docs/validate-pipeline-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-pipeline-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-pipeline-name.StatusCodes.json b/platform-api-docs/docs/validate-pipeline-name.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/validate-pipeline-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-pipeline-name.api.mdx b/platform-api-docs/docs/validate-pipeline-name.api.mdx index 9b1110ea4..ace070f66 100644 --- a/platform-api-docs/docs/validate-pipeline-name.api.mdx +++ b/platform-api-docs/docs/validate-pipeline-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms the validity of the given pipeline `name` in a user conte sidebar_label: "Validate pipeline name" hide_title: true hide_table_of_contents: true -api: eJzVVdtuEzEQ/RXLz2kSoCC14paWgiIkiGgLD6hqnN1J4tZru7Y3Jazy78x4d5PNRSmqQIKnxJ4zO2fGx8cFD2Li+fF3bqUFJTV4ftXiKfjESRuk0fyYnxo9li7zLEyBzYSSqQxzZsZxPZEz0KzOZkMtMhgyqZlguQfHEqMD/Aht1rMWdMqGbwjx6uXc5O66TrumvdfDBujeuFtvRQL9dMiCKcuKALEmocsSS9iyDm9xY8EJ4t5Pkf3XKnNQ1fqEyQiywuGfAI66Lzh9EsGNsoiR1P1dDm7ON2fybVlY5xk4mTCZgg5yLMG1WX/MTCZDgLS1ZO5XQ1rxXxsRFvHJFDLBjwse5pYISQxNwGFobFwmQrn14pAvFq0la+MmD/H97CZCy59xLDspX3pIGdZgpoE8UDADVbeAG4/nqMux76E4WBtP88yJVq4lpqE+PRM6MsVKO+n44KSeYHEUsgNvjfaoaow/7R7Sz8ZgPrID9smUh6ADX7T4Ybe7jTsRKXOAFHzAojUaYcJaJZM4nc6NJ2zR4EQp0kFKVyxD8mICdMEqqmZ0Awl9zzoSbZAl0Rq4oydMlUHR1plzxn2p+sPIIjJ/tqPD+jowbQITSpl75BPRR9vod3nZDjBQkFGP/2i3GPSQ5A69KN7gExAOXC8PU1xe0eHj9Z4asoAJxKqCQryzdLpOLTBSEbhZ7QW5U4ibhmD9cacjrGwnyuRp28MdTrItzZZ0z2OEDZQIJEx2SnjWG/Q58ahpntOcyp6bZJdtU8Va0LQeRRDulH/e15fr5j7E2Ug9NjG9mlHFgso+RJDalQl6UgmmAxZJPOD15pst4xlLFe/22LxdBZAITa6s86R99LzdpT1rfMhE1EflALURr/vgJtVipbb/7uGpzpGWHasEeh0OIg60qNTXfGdxbrX+UCRTnBfFi2IkPFw6tVjQdmmVpMpUejFSdLfGQnnYM7a/9Dbt7O4W5lvPJn41JyQn+/992n/widpDtX4rH0nykY/UHkLVJVjxuaKFk0QoOhlqA0SKRkAqKHN6SQI2NLK2bHnN/z6cXSBWrLvNhrvEr1choeeNb6MiI+LC3IJGVdbEA62xEFrxLyxDlOw= +api: eJzVVdtuGzcQ/RVinhlJSY0CFXpzboVRIDWa20MgROPdWYk2l6RJrlx1wX8vhrsrrSzBKYwWSJ4kkoc75xzOpYWIqwDzT+CUI60MBVhIKCkUXrmorIE5vLCmUr4OIq5JbFCrUsWtsFVer9SGjBhui6XBmpZCGYGiCeRFYU2kv+JEnDtHphTLXxjx049b2/jPw7XPvPfzcgS6s/4mOCzoolyKaLuwGCnHZHQXYgfbxQEJ1pFH5n5Rwhw+9Dcv+1hvsCaQ4NBjTZE8q2+BPwlzGIUFCYrV3zbkt3Dfk4+7wKapyatCqJJMVJUiPxEXlbC1ipFKuWMe9ibt+R9YBBJCsaYaYd5C3DompEykFXmQUFlfY+y2vj+DlOSOtfWrL/H9w6/QqL+zLScpvw9Uisp6YUfIJ5o2pAcJyprHczSd7Q9QvDywZ/zmTKsx6rYhQyEINJlpjactC9Ers4KUFhI8BWdNoMDnz2Zn/HPPmN/FE/HGdo9gIiQJZ7PZMe45lsLTbUMhgoQBPW8BndOqyO5MrwNj2xEnvqI8lVxiNYWAK+IC66naq2sq+HvOc9JG1REdgCc0SYgqat565b31f/b6IKWUmX93QuFQDsLYKFBre0dlp/OHY/TLppNDgjTVrPErVZskBCoar+I2V/BzQk/+vIlrmH9a8OPXFNeWW8CKclTkI5juOt10SDDOIvKboRc0XsMc1jG6MJ9O0alJoW1TTgLdkseJskep+zafiEuNkRNTvGC8OL+8AOYx0HzLPnWax2R3sjnikNC8vsogkP2f10NxXd/F7I0ylc3Xe496Fhz2SwRZrioo9GB+YCzyAx+KH0umGpXOtV3ZX/cHSQI718V5Onk6ezaZ8aazIdaYE6RvAUMnPmyE97m2+3T75iZP/5C8nDqNyrAR2dG2T7/xoJWwS8CFhLUNkc/b9goDvfc6Jd7ueiWnZakCXmkurgp1oAds+5+G00l1N7Q9mpsb1A0jgfv/v6f9H86oB6gOw/KRJB85pR4g1BfBns+CF14xodzKJKwJS/I5C7o750VBLo5uHfXlgwb426t3IAEP28299pK/3h+h2Y6+3bYd4p29IZMSDMQjryEtUkr/APJLlRE= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms the validity of the given pipeline `name` in a user context. Append `?n id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-pipeline-secret-name.ParamsDetails.json b/platform-api-docs/docs/validate-pipeline-secret-name.ParamsDetails.json new file mode 100644 index 000000000..2f12cebc1 --- /dev/null +++ b/platform-api-docs/docs/validate-pipeline-secret-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"workspaceId","in":"query","description":"Workspace numeric identifier","schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"Secret name to validate","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-pipeline-secret-name.RequestSchema.json b/platform-api-docs/docs/validate-pipeline-secret-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-pipeline-secret-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-pipeline-secret-name.StatusCodes.json b/platform-api-docs/docs/validate-pipeline-secret-name.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/validate-pipeline-secret-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx b/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx index d012dab04..3da1a53ed 100644 --- a/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx +++ b/platform-api-docs/docs/validate-pipeline-secret-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms the validity of the given pipeline secret name in a user sidebar_label: "Validate secret name" hide_title: true hide_table_of_contents: true -api: eJzVVdtuEzEQ/RXLz2kSoCA14paWgiqkUtECD6hqnd3ZxK3Xdm1vS7TKvzNj7yabCy2P8JTYPp5z5nhmtuZBTD0f/eRWWlBSw56HzEHw/LLHc/CZkzZIo/mIHxldSFd6FmbA7oWSuQxzZoq4nsp70KwNwlIQpkUJTGomWOXBsczoAL9Cn42tBZ2z63cEePN6bip3la5c0c7b6w7kwbhbb0UGJ/k1CyYxiwCRdkWwhC1ZeI8bC06Q/JMcE/je3DxrVJ5HxlMMgVArHP4J4MiNmlNgvNIhR4wkG+4qcHO+ac6PJb2uSnAyYzIHHWQhwSHYZzMoBR/VPMwtBZaocRqPCuNKEdLWq32+WPSW7DpJe4T2vONzx5tdjD44qacYHx/WgbdGe/B0/ny4Tz/rgb98Znvs1CQzdeCLHt8fDrdxhyJnDlCcD0jaohEmrFUyi+YPbjxh644muiId5FR5JXgvpkAF10g1kxvIKJ519IJBJqEtcEdOeFUGRVvHzhn3tckPTxZR+YsdGba1wbQJTChlHlBPRB9soz9UKR1goKCkHP/RbPEQO6ly2JuxkA9BOHDjKsxweUmPj1U+M9QPU4isgo74YHMADLrFBO6+7YzKKYTPQrB+NBgIK/uZMlXe93CHhval2VGkdMLOlAhU7OyI8Gx8dsJJTqv2nOxKqXc1L7MnxrauaT2JINxJfz62bXTzEKJFUhcmXm+salQQ7VMCKV2ZgW/A9M4ii++8nnw3ZXxqqWIXF+b96gCFkHOJ51n/4GV/SHvW+FCKWCZNr7fDqTs6N4XWq5L7H6dx85C0HFglcKyhE9HRuqnCHZ8h9K+tQyyWGfpGsLqeCA/fnFosaDsNR6rOXHoxUdRqhVAeHjHwiYm9U+wtzLc+CiivIiSnwf339H+e3I8wN0WxorykhZPEGdsbHQKRYwLkRbozzjKwoXNra1atDYVPxxeIFeu9t9FrMXpzJPS8ExvfJSIuzC1ofJtWeKA1EuF8+g0Bq++D +api: eJzVVV1PGzEQ/CvWPpskUFSpp34FSitUqUWFtg8oAudukxh8trF9odHJ/71a3124hBT62D4ltsc7s+PdvRqCmHvILsFKi0pq3POYOwweJhwK9LmTNkijIYNjo2fSlZ6FBbKlULKQYcXMLK3ncomadUFYE4RpUSKTmglWeXQsNzrgrzBgY2tRF+z6HQHevF6Zyl01V65o5+11D3Jv3K23IsfT4poF0zCLgIn2gWANW7MAB2PRCZJ/WkAGP9qbZ63K88T4RZQIHKxwosSAjtyogQJDBj1y4CDJhrsK3Qq2zfm5ptdViU7mTBaog5xJdMDB5wssBWQ1hJWlwFIHnKejmXGlCM3Wy0OIka/ZdSPtCdrzns89b3Yx+uCknkOMEw4OvTXao6fzg9Eh/WwG/vqZ7bEvpjFTB4gcDkejx7gjUTCHdxX6ABw6dFaDsFbJPJk/vPGErXua6Ip0WFDllei9mCMVXCvVTG8wp3jW0QsG2QjtgDty4hBkULR14pxx39r8IMaYlL/YkWFXG0ybwIRS5h6LJs9Xj9EfqiYdZKiwpBz/0WwjB4955WRYpUI+QuHQjauwgOxyQo9fYlgY6oc5JlZBRzDcHgDDfjGhW3adUTkFGSxCsD4bDoWVg1yZqhh4vEMnBtLsKFI6YWdKBCp2dkx4Nj47BZLTqT0nu5rU+5rX2RNjV9e0niYQ8PbPx66Nbu5DskjqmUnXW6taFUT7nEBKV+boWzC9s8jTO28m308ZSyFV6uKZef9wEDmQcw3P/mB/dDAY0aY1PpQi1Unb7N106s/ObaX1Q839j+O4fUlaDq0SUpMTydK6LcMd3yEO60KccFgYHwhW11Ph8btTMdJ2Mx2pPAvpxVRRr82E8viEgc+M7J1ib3H16KuwFKoiJNDk/nv6P4/uJ5jbonignNDCSeJM/c1hgaJAl7xo7ozzHG3o3Xo0rDamwqeTC+AgNptvq9lS9PZI6FUvdl03iAtzizpG6IQHWkOcxBh/A1WP76g= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms the validity of the given pipeline secret name in a user context. Appen id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-team-name.ParamsDetails.json b/platform-api-docs/docs/validate-team-name.ParamsDetails.json new file mode 100644 index 000000000..05bc5cc87 --- /dev/null +++ b/platform-api-docs/docs/validate-team-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"The team name to validate for availability and format compliance within the organization.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-team-name.RequestSchema.json b/platform-api-docs/docs/validate-team-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-team-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-team-name.StatusCodes.json b/platform-api-docs/docs/validate-team-name.StatusCodes.json new file mode 100644 index 000000000..81a0ce8f8 --- /dev/null +++ b/platform-api-docs/docs/validate-team-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"}}} diff --git a/platform-api-docs/docs/validate-team-name.api.mdx b/platform-api-docs/docs/validate-team-name.api.mdx index 4b854a71f..a5ee04fbf 100644 --- a/platform-api-docs/docs/validate-team-name.api.mdx +++ b/platform-api-docs/docs/validate-team-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms that the given team name is valid and available for use w sidebar_label: "Validate organization team name" hide_title: true hide_table_of_contents: true -api: eJzNVdtuEzEQ/RXLTyCFbICCRMQtrQqqkErVBl6iqJ1uJonbXdu1vSlhtf/OjHe3uXJ7QOIhya597Dlz5syklAFmXvZHMiDkXo47coI+dcoGZbTsyyOjp8rlXoQ5BPpCMVML1ILhQkOOQnmxgExNBGj6LEBlcJ2hmBonCo/iXoW50vGkcTPQ6jvw1V0xsBbpxNU7vuXN66Up3CXfesnvb69EMMJbTNV0GQ/HWLQWY0HAruxIY9HF204mRPVrszOkS04JTQALjh4COk6xlHwHAYkHHehIxQlaCHO5nfXnNaZCFzk6lQo1QR3UVKHj2A7vCuWQAgdXYEf6dI45yH4pw9JyFKUDztARlKTIIdRLLw9kVXUeqOiaZ2RyV6Bb7lAZUu4rsdcEiAo3eqtMhWUsQB1LpCa3mQKd/rwAcg9nH5zSM2I45gS9Ndqj5/1nvQP+2VLpk3giTg0Fo1R1kFVHHvR6u7hDmAiWC32goC2aYGCJZBrpJDeeseUap5XCI5mj9zBD9mdD1VzfYMr3Wcc2CKom2gL35ERHVch46dg5486b/Ginisyf78mwNZjQJgjIMnNPfBjuMS0ciR59dYjg0A0KclJ/NGbxyHRzw6acYeTIJuvLhArgkzL6r0pixyVtObkc6BatVQuX0YF5CNb3kwSs6qaZKSZdj3dEqavMjlEu4o44yyCwCcQR48Xg7EQyoZbvBctbS7XO+kEtjtg6g9+vI4hW6ocPrZVv7kPUQempiccbaRsWHPZ3BDldlaJvwOwLSKMvNpNfT5msobLYSVPzfrVBRFi5Os7T7qsX3R6vWeNDDtFWTb+1M2KjFVb9tc25XLn1/56ETfUCfguJzYDmCaUfZSwb84147HmC9tvxV098Uq51INlkTooxtiyvweMXl1UVL9ejiX05UZ6TImtPIfP4C73+5eDam+4tLlcTlYIVDInmX4BTzPovM3h03kygx+IP/hD2cmoWQS/XObVc60pUYwLOESbUZ0yw3hukKdqwdmpnWG7MmY/HQ8LCZjNvNW+8fS8jKndEDM0taip5SzDwOxOsqh+/8NTM +api: eJzNVVFv2zYQ/ivEPXUAZ7ttsAdh65oW7RAMaIs260tgtBfpLDGVSIY8OXUF/vfhKCl2Em/dHgbsySZ5vPu+j9+dBmCsIxQXwIRdhLWGimIZjGfjLBTw0tmNCV1U3CArbkjVZktWSbiy2JEyUW2xNZVCWyncomnxsiW1cUH1kdSN4cbYfNOFGq35hpJ6oU69J1upz79Kll9+3rk+fJKsn2T97LNip6Kn0mx2+XKuxW6shUwL0OA8hZztrIICPk4n54TdG+wINHgM2BFTEIoDSA4owIX6rAINRgh65Abus357gFTZvqNgSmUqsmw2hoLUDnTdm0AVFBx60hDLhjqEYgDeealiLFNNATRsXOiQx62fTiAlfQvFjjgzkuuewu4BlPOGDsQ+ECArPOltWsO7/ABjLVW6zrcGbfnXDwBHMEcOxtaQ0loIRu9spCjnT1Yn8nNPpd/Vj+qNU6WzTJYhaThZrR7GvcBKiVwUGTTM0cUA6H1rygxneRUldjjAtFf4AjqKEWsSf05Q3eUVlZLPB7EBmxHoHHiEkwY23MrWqxBceD/xg5RSRv70CMPZYMo6Vti27oaqnCpS2QfDu+yrF4SBwmnPDRQXaxGvI26cmLKmjFFMVsDShTouh+y/tMwdt5yfU56Dwna2ah9aKKBh9rFYLtGbRdm6vlpEuqaAC+MeGOVDPlHvWmQxgXop8er03RkIoBnvB5F3lOoQ9a1aUnF2hqwvcxDo6c/r2cpXN5x1MHbj8vVJ2gmFlP0eQKFrSopTsPgCy+yLu+QPKVOHps2dtHHP9wdJgyg31nm8eLx6sljJpneRO8y+mhpuHhJ3emHfYPdBD3u7/r9H4fR8TF956Vs0VuhnHYfJfRcy9yJoKOb5N458DbcWXGtoXGSJHYZLjPRHaFOS7XE2iTErE4VUBcUG20h/o9d/ObmO0v1Cu/1I3WLbS0h2/xaDEdT/ksGj99MI+kH9gy/CUUzTJtrdIaYZ6/gSaZ00NIQVhQxwPDstS/J8cOvBtLwzaH57dQ4a8G433+venP0oomEYI87dF7Ip3QJkWQvAlP4E6QzU8Q== sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms that the given team name is valid and available for use within the orga id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-user-name.ParamsDetails.json b/platform-api-docs/docs/validate-user-name.ParamsDetails.json new file mode 100644 index 000000000..a9ce51752 --- /dev/null +++ b/platform-api-docs/docs/validate-user-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"name","in":"query","description":"User name to validate","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-user-name.RequestSchema.json b/platform-api-docs/docs/validate-user-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-user-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-user-name.StatusCodes.json b/platform-api-docs/docs/validate-user-name.StatusCodes.json new file mode 100644 index 000000000..c9484338d --- /dev/null +++ b/platform-api-docs/docs/validate-user-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicated element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-user-name.api.mdx b/platform-api-docs/docs/validate-user-name.api.mdx index c95e1f4f3..2b09a02d1 100644 --- a/platform-api-docs/docs/validate-user-name.api.mdx +++ b/platform-api-docs/docs/validate-user-name.api.mdx @@ -5,9 +5,9 @@ description: "Check that the user name is valid" sidebar_label: "Check that the user name is valid" hide_title: true hide_table_of_contents: true -api: eJzNVMFu2zAM/RVB5yzJtu5Qn5Z23VAM6Iq13aXogbGZWIliqRKdLjDy7yNlO02WDNtxF9sSn8jHx2c1mmAedfao64gh6qeBdh4DkHHVdaEz/QOsKYDwgcM3sEI90B4Cf5DAs8dGV7Kbta+BNhV/P9cYNrwoMObBeEnGu5JCCUyRU+suL6NiXuIKdNZo2nhJFSmYaq63W2YTMHpXRYwSfzc+k9dh2m9f1Rt141TuKsKK9Hagz8bjY9wFFCogU4vERXs0w8B7a/LU8mgRBdvscZIjJmAhGq0wRpijqNRRddMF5pLPB9GNTEu0B57oiY8asrJ1FYIL37v+OLJNzN+f6LCfiKocKbDWvTCfhD4/Rn+q23awUGhxJU3+p+1yMGJeB0Ob5KQLhIBhUlPJyyeZ/mFnlyXmS0UlED9Q1Ts/mdj6iYmxMUsnxp1j4gmSTI+Su0f7psOw7h1cB8uYksjHbDQCb4a5dXUxjPjMwg+NO7LyXYqoWws0c2GlLgWvJrfXWlj3Td2Jqq1C+63tRJKKvf9lPU0g3mk/PnNm4JHpxQslJU01c+l4p2jHQsr+jaC0a3KMHVjsAHmyw2Hz+y2zI4zEpOzH1wATEeXaOm+H5x+GY9nzLtIKkpu6G+FfxnXAeicM4U8aeQt8mXDmxLDpRtlfVEyiHyYrXnJxiTXNFCI+BLvdynZ7D8mICxNhasXWM7ARjwrv/o8/3lInqS1x83r1MbgWSPLAGoKRisnJTBCh4NEKlfbMJM/R096po99Ssuzc/OXqnrFw6J/f/JKydyGoNnu5WZaEuHdLrFianjjJmgvxr/gLKcQRPQ== +api: eJzNVMFu2zAM/RWBZy1Ju17m09quG4oBXbG2uxQ5MDYbq5EtR6LTBYb+faBsp8nSYTvuZFt8It8jn9kB4zJA9ghtIB9grsE15JGNq68LyOAHWlMg00Mgf4MVgYYGPVbEAs8eO6jlNOsfGkwNGaxb8lvQUFDIvWkkGWQgKZTAFDu1GfKChpCXVCFkHfC2kVSBvamXEONcg6fQuDpQkPjp7Eweh2m/fVXv1I1TuauZaoao4Ww2O8ZdYKE8rVsKDBpGdNYBNo01eZI8fQ6C7fY4yRXjqZAeVRQCLkm6NFB1i2fKJV/jpW9seqIj8A1NGtiwlaMr753/PuiDGGNi/v4NheNEVO1YobXuhYpe54dj9Ke2l0OFIkuViPxP5UYNgfLWG94mJ10QevLnLZeQPc5l+ofKLkvKV4pLZMUlqXbnJxN6P4GGirh0YtwlJZ4oyWCa3D3dNx35zejg1lvIoGRuQjadYmMmuXVtMQm0Jo8T446sfJci6tYiPzlfqUvBq/PbaxDWo6g76WrfoX1puyZJxdH/8r1IINDDy2fnK2TI4PmFUydN/eTS9aGjAwsp+zeCItfkFAaw2AHzZIdD8fuSqUIjMSn78TUQNUjn+jonk5PZ6WQmh40LXGGy07AS/mVeB7R3nWH6ydPGoqklc6LYDbMcN5WG3TTnGkoXWGJdt8BAD97GKMf9IpIZFybgwoqvn9AGOiq8+0H+uKbepLai7evu26BtBZJMsEFvpGKysoaSsCCfqPR3zvOcGt67dfRfSpadnb9c3YMGPDTQb4ZJ2YcQ1tu93F3XI+7diuoYYSTO8g1xHmP8BeMkEWI= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Check that the user name is valid id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-workflow-constraints.ParamsDetails.json b/platform-api-docs/docs/validate-workflow-constraints.ParamsDetails.json new file mode 100644 index 000000000..19d711388 --- /dev/null +++ b/platform-api-docs/docs/validate-workflow-constraints.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"runName","in":"query","description":"Workflow run name to validate","schema":{"type":"string"}},{"name":"sessionId","in":"query","description":"Workflow session ID to validate","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-workflow-constraints.RequestSchema.json b/platform-api-docs/docs/validate-workflow-constraints.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-workflow-constraints.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-workflow-constraints.StatusCodes.json b/platform-api-docs/docs/validate-workflow-constraints.StatusCodes.json new file mode 100644 index 000000000..fbddaed6a --- /dev/null +++ b/platform-api-docs/docs/validate-workflow-constraints.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request. Invalid run name format","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicated element. Existing run name and session ID combination","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-workflow-constraints.api.mdx b/platform-api-docs/docs/validate-workflow-constraints.api.mdx index cbd775cad..a70f10b35 100644 --- a/platform-api-docs/docs/validate-workflow-constraints.api.mdx +++ b/platform-api-docs/docs/validate-workflow-constraints.api.mdx @@ -5,9 +5,9 @@ description: "Check that the given run name of a workflow has a valid format. Wh sidebar_label: "Validate run name" hide_title: true hide_table_of_contents: true -api: eJzVVU1v2zAM/SuCzpnTbd2hOa1fG4IBXbFu62HogbGZWI1tuRLdNDDy30fKduw0XVvstF3aSKRIvsdHutYEC68nv/TKuuU8syuvb0Y6QR87U5KxhZ7o0xTjpaIUiP+gWph7LJSrClVAjsrOFajutUrB8/EeMpOouXU5UKSuU/aXlx6955BqeqaMb+JMVNxHL6yy7Of6cKZ9uPaEucIH48mrlaE0XMc2n5kCpEwpY8aPFWaYY0E+0iNtS3TBOk0Yxk8pCgiv2+CntvDkwLAz+5bgGA2hEzZqLdD4DaO8kF8jbYSJuwrdWj/mpwvYc0K2oYCzsbdniDnoSa1pXUpUTmuKhd5sRttELTVc6OtSDah8bTLuq0NfMmr0Yn93cCj/dhN8/aLeqAvL1BbENOrNSB8eHOz7nUCiHHKRnhs8LZqGb/E3nedqujD8HsoyM3Fox/jWS5B6UKzEMg4TkWLO2GCBIsQWg53dYizxSic9JdMg6ByfYlaToUyuzp2z7lsLnC2bAOn9E9A7tbAOSUHGNHM9wfto3/usauBg0kkuUueiT87fEwFFMmzVQLD/Kjls9BhXztA6DMIJgkN3XFHKxxsREU9JamWgFhiygpj0uJvZ8VCM6O67iapcxm4pUekn4zGUJoozWyWRxzvmPTJ2T+xXwaIuMyARlDoVf3V8OdVSRlflldDUQB7WukUtGbu5kPMsOPFN8+NTI9WJvl1RoMYUcxuetxS1VUjalwoUuCZG3zpLfyEO/d0FP4TMLTZik7QfewMXIsw1ed5GRx+iA7krraccgjzaxdFtta3mHldZ9zr7fzd520vCBxqXGe9sISOQWrcC7L9g7L6VIOskZcrEXNcz8PjDZZuNXDf7VYSZGA+zTKZrDpnHZ+h7adE/WeUS1zsfEvavxEvL9v+L3H/c/M9kH35d+vw3cnBGCgizzVwhJDwbwkrz8DiOsaTBq71FtbMRPp9/Z1/YHcBHAxeityYo1oPY3KHg8d0useAuddWTnDkRL6ffSOsEsA== +api: eJzVVUtv2zAM/isCz56Tdr3Mp/W1IRjQDVu3HoocGJuJ1dqSK9FNA8P/faBsJ07btcVO28mW+P74kWqAceUhuYa1dbfLwq49zCPIyKdOV6ytgQROc0pvFefIinNSK31PRrnaKIMlKbtUqAZrlaNXqO6x0JlaWlcix+oqJxMsPXmvrVGzM6V95ydR6c67scpyTm7nTveGG89UKnrQnr1aa87DdWrLhTYoaUoaC8u5ooJKMuxjiMBW5IJ0lkECvyQpZLrqnZ9a49mhNuwhggodlsTkBI0GpDRIwNXmQv4i0ILEXU1uA4/xGRzuMGHbQYAspj7NqURIGuBNJV49O21W0LbRNlAPzSx7Y6gRlG8NNo/Aka+s8eRFfjg9ks9+gK9f1Dt1YVVqDZNhaCM4mk6f6p1gphzd1eQ5VjPTNXxbf9d5iGBwkzSAVVXoNLRjcuPFSTNKVnxpR5lQsSTvcUVCxL4Gu7ihVPxVTnrKuqtgUHwOWWDNhVydO2fd975waNs2lPT+mdIHtihjWWFR2DVlHQAfnmqf1V05lA2Ui9W58FOb1Q4INNm4VSPC/qvgtBF4SmuneRMG4YTQkTuuOYfkei4kKolzKwO1ohAVRQSTYWYnYzKSux8mqnYFJJAzVz6ZTLDScVrYOos93ZHDWNsnZP8RJOpbgSyEUqeir46/zUDSGLL8ITB1JY9z3VYtEYe5kPMiKEHU/3zqqJrAzZoDNNosbTDvIeqzkLCvJSjl6pR8ryz9xTT0d7/4cclUohaZhP24E7QRCHJdnIP4YHoYT+Wysp5LDPzoN8ew1rake5xmsyPa/7vK+2YyPfCkKlAbASOg2vQM3D1hEMGWg/MIcutZxE2zQE8/XdG2ct0tWGFmpj0uChmvJRaeXoDvtU3/bJa3tNl7Se6xqEULZP3/Rew/rv4Xoo+fl138uRyclgTCcEeQE2bkAiqd4XGaUsUjqyebam8lfD6/hAhwfwIfTVzw3ovQbEa+m6bTuLS3ZNoWhuxZztDO27b9DbIRBNU= sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Check that the given run name of a workflow has a valid format. When the session id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/docs/validate-workspace-name.ParamsDetails.json b/platform-api-docs/docs/validate-workspace-name.ParamsDetails.json new file mode 100644 index 000000000..eb0b49cf6 --- /dev/null +++ b/platform-api-docs/docs/validate-workspace-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"orgId","in":"path","description":"Organization numeric identifier.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"name","in":"query","description":"The workspace name to validate for availability and format compliance within the organization.","schema":{"type":"string"}}]} diff --git a/platform-api-docs/docs/validate-workspace-name.RequestSchema.json b/platform-api-docs/docs/validate-workspace-name.RequestSchema.json new file mode 100644 index 000000000..188a349c4 --- /dev/null +++ b/platform-api-docs/docs/validate-workspace-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/platform-api-docs/docs/validate-workspace-name.StatusCodes.json b/platform-api-docs/docs/validate-workspace-name.StatusCodes.json new file mode 100644 index 000000000..29cf40dba --- /dev/null +++ b/platform-api-docs/docs/validate-workspace-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"204":{"description":"OK - No content"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}},"403":{"description":"Operation not allowed"},"409":{"description":"Duplicate element","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}},"title":"ErrorResponse"}}}}}} diff --git a/platform-api-docs/docs/validate-workspace-name.api.mdx b/platform-api-docs/docs/validate-workspace-name.api.mdx index 583010ca8..45b0b303d 100644 --- a/platform-api-docs/docs/validate-workspace-name.api.mdx +++ b/platform-api-docs/docs/validate-workspace-name.api.mdx @@ -5,9 +5,9 @@ description: "Confirms that the given workspace name is valid and available for sidebar_label: "Validate workspace name" hide_title: true hide_table_of_contents: true -api: eJzVVW1v0zAQ/iuWP4FUmgIDaRVv2xhoQhrTNuBDVW1ucm28JbZnOy0lyn/nzknarC1vH5DgQ9vUfu7uuedeUnIvZo4PR3yh7a0zIgbHxz2egIutNF5qxYf8SKuptLljPhUev4DN5BwUW9kwJXJg0rG5yGTChMLPXMhMTDJgU21Z4YAtpE+lCubazoSS3wT577MDYwAtrl+Tl5cvlrqwVyvXV3T46pp5zZyBWE6XwUMIiGchoPDQ5z2uDdjg8iRB0p+bmy+tp1M0QZQRFh88WEq75OQI0cgIrXpcUr5G+JRvivCxw5mpIgcrYyYTUF5OJVgiYOGukBYwurcF9LiLU8gFH5bcLw1FkcrDDCxCUZRc+Pro+R6vqt6Kiqp5BiZ3BdjlFpVLFGBD+44UQfBGfplJvwz1qAOyWOcmk0LFP64H30HceSvVDGmOKUtntHLYKHj/ZLBHPxtSfWCP2KnGYJiv8rzq8b3BYBt3KBJGmoHzGLRFI0wYJBkHOtGNI2zZ4bSWecRzcE7MgHq2oaonNxCTP2OpIbysibbAHTmhqfQZHR1bq+15kx/eVIH50x0Ztq3GlPZMZJleIJ+A3t9Gvy3qdIBBBjnl+I9mi5cO4sJi04ThOARhwR4UOA7D0ZiKj5OTahqvGYSoNClDHmEDuagMQ1RF61UStT1JPQV23g5dYTO0Sr03bhhFwsh+nOki6Tu4Q137Um+1/EW4YWeZ8NTJ7Ijw7ODshBOrlvQFqVYr0KW+EoEitu1N/ycBhCf1w7t2KG8WPigl1VQH80axhgWF/RVBSleiBA2Yyi3iUO77yXdTxorLLOyEqX6zvkAipFwd53F//1l/QGdGO5+L0C3N5mhX3sZy2ORarpvvf1ntTf08fPWRyQTuRhQgCFk2PTiiFe4QOmxXeeeNhgK2jYjdkqJwZFCWE+Hgk82qio7rXUvtmUhH6WGbT0Xm4Cfy/fVNvDPxW1iu3xMYrCBIGIS5sJKo/2EaD86bJfOQ/cZrbien5lCoZZdTy7WuSTVGYAoiwZkjgvXdQRyD8R2rrX14b/G8P75ErLg/2BuDHLzvZIQ1D4hLfQsK694S9PSfCFbVd8ZYKtQ= +api: eJzVVduO2zYQ/RVinlqAtZ10UaBCb5s0LRYF0iDZtg8LI5mVxhZ3JZJLjrx1Bf57MZRke2339lCgfbI1HM6cc+bCHhjXEYobeHThPnosKcJSQ0WxDMazcRYKeOnsyoQ2Kq6RFdek1mZDVu3uKIstKRPVBhtTKbSVwg2aBm8bUisXVBdJPRqujc3XXVijNb+hxJ+pS+/JVurD1xLlyy+2rgvvd6Hfi/GrD4qdip5Ks9rmCDkhuyEhMs1Ag/MUcsirCgr4eTz5ZYr0GlsCDR4DtsQUhHYPEggKcGF9VYEGI3w9cg3HIvx4gFnZrqVgSmUqsmxWhoIACPTQmUAVFBw60hDLmlqEogfeesliLNOaAmhYudAiD6bPLiAlvYNiB5wZyUNHYXsC5bqmY+0PpMiCj/KbxvA212NIqErX+sagLf+4HnAGeORg7BpSWgrL6J2NFOX8+eJCfo6k+kF9ol47VTrLZBmShovF4tTvBVZKNKPIoGHyLnpA7xtTZjjzuyi+/QGmvcw30FKMuCbp2RGqu72jUuL5IA3BZgA6OZ7hpIENN2J6FYILb0d+kFLKyD89w3BqNWUdK2wa90jVwPPzU+9vu4EOKWqoFY7/UbZJQ6SyC4a3eTheEAYKlx3XUNwspfgtce1kvNaUs8qkFDB3YR3nfR6iNN+vkvnUk9JTFDbT0HWhgQJqZh+L+Ry9mZWN66pZpAcKODPupOXf5RP1pkGWTlYvxV9dvrkCQTWBfieqDQocQt+JIBmn9pbv2+wEevzz3TSUd4+clTJ25fL1UbERhaT9K4BC15QUR2cpN5a53E/JH1KmFk2Td8LKfbM/SBpEuSHPs9mzxfPZQozeRW4xt8u4Oqadd7QdjsH2++77v+z2sYBMv/LcN2isCJCV7McmvJEdHkFDMe3ygydNw64TlxpqF1ku9P0tRvopNCmJeVi20p+ViUKvgmKFTaQ/ke9fX8Vnid/Tdv9QbLDpxCVPwgaDEej/kMZHb8ct87H6G+/cWUyjEe32ENOEdahJWiYNNWFFIQMczi7Lkjwf3DpZiE82z/evrkEDPp3so0nO0c8i6vvB49rdk01pB5DlWwCm9DtBpSr5 sidebar_class_name: "get api-method" -info_path: platform-api-docs/docs/seqera-api +info_path: platform-api//seqera-api custom_edit_url: null --- @@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes"; import OperationTabs from "@theme/OperationTabs"; import TabItem from "@theme/TabItem"; import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; - + @@ -42,30 +43,24 @@ Confirms that the given workspace name is valid and available for use within the id={"request"} as={"h2"} className={"openapi-tabs__heading"} - children={"Request"} > + Request - + - + - - - - \ No newline at end of file + diff --git a/platform-api-docs/scripts/consolidate-overlays.py b/platform-api-docs/scripts/consolidate-overlays.py new file mode 100644 index 000000000..e3696faaf --- /dev/null +++ b/platform-api-docs/scripts/consolidate-overlays.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python3 +""" +Consolidate multiple overlay files into a single comprehensive overlay. +""" + +import yaml +import sys +from pathlib import Path + +def consolidate_overlays(overlay_files, output_file): + """Consolidate multiple overlay files into one.""" + + # Define the order of overlay application (critical for correct behavior) + overlay_order = [ + # First: Structural fixes that remove/replace large sections + "remove-google-lifesciences-overlay-1.102.0.yaml", + "fix-duplicate-enums-overlay-1.102.0.yaml", + "fix-duplicate-required-fields-overlay-1.102.0.yaml", + + # Second: Add missing global tags + "add-identities-tag-1.102.0.yaml", + + # Third: Feature overlays (operations, parameters, schemas) + "compute-envs-operations-overlay-1.102.0.yaml", + "compute-envs-parameters-overlay-1.102.0.yaml", + "compute-envs-schemas-overlay-1.102.0.yaml", + "data-links-operations-overlay-1.102.0.yaml", + "data-links-parameters-overlay-1.102.0.yaml", + "workflows-operations-overlay-1.102.0.yaml", + "workflows-parameters-overlay-1.102.0.yaml", + "global-schemas-overlay-1.102.0.yaml", + + # Last: Manual field descriptions + "manual-field-descriptions-overlay-1.102.0.yaml", + ] + + all_actions = [] + + # Process overlays in the specified order + for overlay_name in overlay_order: + overlay_path = Path("specs") / overlay_name + + if not overlay_path.exists(): + print(f"Warning: {overlay_name} not found, skipping...") + continue + + print(f"Processing: {overlay_name}") + + with open(overlay_path, 'r') as f: + overlay_data = yaml.safe_load(f) + + if 'actions' in overlay_data and overlay_data['actions']: + all_actions.extend(overlay_data['actions']) + print(f" Added {len(overlay_data['actions'])} actions") + + # Create consolidated overlay + consolidated = { + 'overlay': '1.0.0', + 'info': { + 'title': 'Consolidated overlay for Seqera Platform API v1.102.0', + 'version': '1.102.0' + }, + 'actions': all_actions + } + + # Write consolidated overlay + output_path = Path("specs") / output_file + with open(output_path, 'w') as f: + yaml.dump(consolidated, f, default_flow_style=False, sort_keys=False, width=1000) + + print(f"\nConsolidated overlay written to: {output_path}") + print(f"Total actions: {len(all_actions)}") + + return str(output_path) + +if __name__ == "__main__": + overlay_files = [ + "remove-google-lifesciences-overlay-1.102.0.yaml", + "fix-duplicate-enums-overlay-1.102.0.yaml", + "fix-duplicate-required-fields-overlay-1.102.0.yaml", + "add-identities-tag-1.102.0.yaml", + "compute-envs-operations-overlay-1.102.0.yaml", + "compute-envs-parameters-overlay-1.102.0.yaml", + "compute-envs-schemas-overlay-1.102.0.yaml", + "data-links-operations-overlay-1.102.0.yaml", + "data-links-parameters-overlay-1.102.0.yaml", + "workflows-operations-overlay-1.102.0.yaml", + "workflows-parameters-overlay-1.102.0.yaml", + "global-schemas-overlay-1.102.0.yaml", + "manual-field-descriptions-overlay-1.102.0.yaml", + ] + + output_file = "consolidated-overlay-1.102.0.yaml" + + consolidate_overlays(overlay_files, output_file) diff --git a/platform-api-docs/scripts/extract-api-tables.mjs b/platform-api-docs/scripts/extract-api-tables.mjs index b557616dd..67c9dfec9 100644 --- a/platform-api-docs/scripts/extract-api-tables.mjs +++ b/platform-api-docs/scripts/extract-api-tables.mjs @@ -7,7 +7,16 @@ import { parse } from 'yaml'; const __filename = fileURLToPath(import.meta.url); const __dirname = path.dirname(__filename); -const SPEC_PATH = path.resolve(__dirname, './specs/seqera-api-latest-decorated.yml'); +// Support both .yaml and .yml extensions for decorated spec +const SPEC_YAML = path.resolve(__dirname, './specs/seqera-api-latest-decorated.yaml'); +const SPEC_YML = path.resolve(__dirname, './specs/seqera-api-latest-decorated.yml'); +const SPEC_PATH = fs.existsSync(SPEC_YAML) ? SPEC_YAML : SPEC_YML; + +if (!fs.existsSync(SPEC_PATH)) { + console.error('❌ Error: seqera-api-latest-decorated.{yaml,yml} not found'); + process.exit(1); +} + const OUTPUT_DIR = path.resolve(__dirname, '../docs/info/parameter-tables'); // Utility to safely dereference $ref fields @@ -138,10 +147,10 @@ for (const [tag, operations] of Object.entries(taggedOps)) { operations.forEach((op) => { const response = op.responses?.['200']?.content?.['application/json']?.schema; if (!response) return; - + const resolved = response.$ref ? resolveRef(response.$ref, spec) : response; const reqList = resolved.required || []; - + const sectionLabel = { Name: `**${op.operationId}**`, Type: '', @@ -149,7 +158,7 @@ for (const [tag, operations] of Object.entries(taggedOps)) { Description: op.summary || '', }; responseRows.push(sectionLabel); - + if (resolved.properties) { responseRows.push(...formatResponseBody(resolved, spec, reqList)); } else { @@ -164,8 +173,8 @@ for (const [tag, operations] of Object.entries(taggedOps)) { }); const safeTag = tag.replace(/\s+/g, '-').toLowerCase(); - const tagDir = path.join(OUTPUT_DIR, safeTag); - + const tagDir = path.join(OUTPUT_DIR, safeTag); + // Deduplicate parameters by name and location const seenParams = new Set(); const uniqueParams = paramRows.filter((param) => { @@ -176,12 +185,12 @@ for (const [tag, operations] of Object.entries(taggedOps)) { }); if (paramRows.length > 0) { - writeYaml(path.join(tagDir, `parameters.yml`), uniqueParams); + writeYaml(path.join(tagDir, `parameters.yml`), uniqueParams); } if (bodyRows.length > 0) { - writeYaml(path.join(tagDir, `request-bodies.yml`), bodyRows); - } + writeYaml(path.join(tagDir, `request-bodies.yml`), bodyRows); + } if (responseRows.length > 0) { writeYaml(path.join(tagDir, `responses.yml`), responseRows); - } + } } diff --git a/platform-api-docs/scripts/overlay_archives/add-identities-tag-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/add-identities-tag-overlay-1.102.0.yaml new file mode 100644 index 000000000..5b6b15dfd --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/add-identities-tag-overlay-1.102.0.yaml @@ -0,0 +1,59 @@ +overlay: 1.0.0 +info: + title: Add identities tag to global tags + version: 1.102.0 +actions: + # ===== ADD MISSING IDENTITIES TAG ===== + + # CRITICAL: Remove entire tags array first to prevent duplicates + - target: "$.tags" + remove: true + + # Replace with complete array including identities tag + - target: "$" + update: + tags: + - name: actions + description: Pipeline actions + - name: avatars + description: Avatars + - name: compute-envs + description: Compute environments + - name: credentials + description: Credentials + - name: data-links + description: Cloud storage directory paths in Data Explorer + - name: datasets + description: Pipeline input datasets (samplesheets) in CSV or TSV format + - name: ga4gh + description: GA4GH workflow execution service runs + - name: identities + description: Managed identities for centralized credential management + - name: labels + description: Labels and resource labels + - name: launch + description: Workflow launch events + - name: orgs + description: Organizations + - name: pipelines + description: Pipelines + - name: pipeline-secrets + description: Pipeline secrets in a user or workspace context + - name: platforms + description: Computing platforms + - name: service-info + description: Seqera Platform API service information + - name: studios + description: Studios and Studio sessions + - name: teams + description: Teams in an organization context + - name: tokens + description: API access tokens + - name: trace + description: Workflow execution traces + - name: users + description: Users + - name: workflows + description: Workflow executions + - name: workspaces + description: Workspaces in an organization context diff --git a/platform-api-docs/scripts/overlay_archives/add-missing-schema-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/add-missing-schema-overlay-1.102.0.yaml new file mode 100644 index 000000000..f10089f52 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/add-missing-schema-overlay-1.102.0.yaml @@ -0,0 +1,43 @@ +overlay: 1.0.0 +info: + title: Add missing LocalComputeConfig schema + version: 1.102.0 +actions: + # ===== ADD MISSING LocalComputeConfig SCHEMA ===== + + # This schema exists in v1.95 base spec but was accidentally excluded from v1.95 decorated spec + # We need to add it before other overlays can reference it + + - target: "$.components.schemas" + update: + LocalComputeConfig: + type: object + title: Local execution configuration + properties: + workDir: + type: string + description: "Compute environment working directory." + preRunScript: + type: string + description: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + description: "Array of environment variables for the compute environment." + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + description: "Additional Nextflow configuration content." + discriminator: + type: string + description: "Property to select the compute config platform." + readOnly: true + waveEnabled: + type: boolean + description: "Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)." + fusion2Enabled: + type: boolean + description: "Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)." diff --git a/platform-api-docs/scripts/overlay_archives/all-changes-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/all-changes-overlay-1.102.0.yaml new file mode 100644 index 000000000..bb315d1b5 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/all-changes-overlay-1.102.0.yaml @@ -0,0 +1,1036 @@ +overlay: 1.0.0 +info: + title: Consolidated overlay for v1.102.0 + version: 0.0.0 +actions: + # ===== VERSION 1.102.0 OVERLAYS ===== + # ===== ADD MISSING IDENTITIES TAG ===== + + # CRITICAL: Remove entire tags array first to prevent duplicates + - target: "$.tags" + remove: true + + # Replace with complete array including identities tag + - target: "$" + update: + tags: + - name: actions + description: Pipeline actions + - name: avatars + description: Avatars + - name: compute-envs + description: Compute environments + - name: credentials + description: Credentials + - name: data-links + description: Cloud storage directory paths in Data Explorer + - name: datasets + description: Pipeline input datasets (samplesheets) in CSV or TSV format + - name: ga4gh + description: GA4GH workflow execution service runs + - name: identities + description: Managed identities for centralized credential management + - name: labels + description: Labels and resource labels + - name: launch + description: Workflow launch events + - name: orgs + description: Organizations + - name: pipelines + description: Pipelines + - name: pipeline-secrets + description: Pipeline secrets in a user or workspace context + - name: platforms + description: Computing platforms + - name: service-info + description: Seqera Platform API service information + - name: studios + description: Studios and Studio sessions + - name: teams + description: Teams in an organization context + - name: tokens + description: API access tokens + - name: trace + description: Workflow execution traces + - name: users + description: Users + - name: workflows + description: Workflow executions + - name: workspaces + description: Workspaces in an organization context + # ===== ADD MISSING LocalComputeConfig SCHEMA ===== + + # This schema exists in v1.95 base spec but was accidentally excluded from v1.95 decorated spec + # We need to add it before other overlays can reference it + + - target: "$.components.schemas" + update: + LocalComputeConfig: + type: object + title: Local execution configuration + properties: + workDir: + type: string + description: "Compute environment working directory." + preRunScript: + type: string + description: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + description: "Array of environment variables for the compute environment." + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + description: "Additional Nextflow configuration content." + discriminator: + type: string + description: "Property to select the compute config platform." + readOnly: true + waveEnabled: + type: boolean + description: "Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)." + fusion2Enabled: + type: boolean + description: "Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)." + # ===== COMPUTE ENVIRONMENTS - OPERATIONS ===== + + # ---- DISABLE COMPUTE ENVIRONMENT ---- + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.summary" + update: "Disable compute environment" + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.description" + update: "Disables the compute environment identified by the given `computeEnvId`. A disabled compute environment cannot be used to launch new workflows or Studio sessions. If the compute environment is primary, it will be automatically unset as primary. See [Disable compute environment](https://docs.seqera.io/platform-cloud/compute-envs/overview#disable-compute-environment)" + + # ---- ENABLE COMPUTE ENVIRONMENT ---- + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.summary" + update: "Enable compute environment" + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.description" + update: "Enables the compute environment identified by the given `computeEnvId`. An enabled compute environment can be used to launch new workflows and Studio sessions." + # ===== COMPUTE ENVIRONMENTS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== + + # ---- DISABLE COMPUTE ENVIRONMENT PARAMETERS ---- + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.parameters[?(@.name=='computeEnvId')].description" + update: "Compute environment string identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.parameters[?(@.name=='workspaceId')].description" + update: "Workspace numeric identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.requestBody.description" + update: "Compute environment disable request" + + # ---- ENABLE COMPUTE ENVIRONMENT PARAMETERS ---- + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.parameters[?(@.name=='computeEnvId')].description" + update: "Compute environment string identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.parameters[?(@.name=='workspaceId')].description" + update: "Workspace numeric identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.requestBody.description" + update: "Compute environment enable request" + # ===== COMPUTE ENVIRONMENTS SCHEMAS - REQUEST/RESPONSE OBJECTS ===== + + # ---- COMPUTE ENVIRONMENT STATUS ENUM ---- + + - target: "$.components.schemas.ComputeEnv.Status" + update: + type: string + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "DISABLED"] + description: "Compute environment status. Accepts `CREATING`, `AVAILABLE`, `ERRORED`, `INVALID`, or `DISABLED`." + # ===== DATA-LINKS - OPERATIONS ===== + + # Update existing operations + + - target: "$.paths./data-links/{dataLinkId}/browse.get.summary" + update: "Explore data-link" + + - target: "$.paths./data-links/{dataLinkId}/browse.get.description" + update: "Retrieves the content of the data-link associated with the given `dataLinkId`." + + - target: "$.paths./data-links/{dataLinkId}/browse/{path}.get.operationId" + update: "ExploreDataLinkWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload.post.summary" + update: "Generate data-link file upload URL" + + - target: "$.paths./data-links/{dataLinkId}/upload.post.description" + update: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint." + + - target: "$.paths./data-links/{dataLinkId}/upload/{dirPath}.post.operationId" + update: "GenerateDataLinkUploadUrlWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.summary" + update: "Finish data-link file upload" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.description" + update: "Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.responses['404'].description" + update: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found." + + - target: "$.paths./data-links/{dataLinkId}/upload/finish/{dirPath}.post.operationId" + update: "FinishDataLinkUploadWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish/{dirPath}.post.responses['200'].description" + update: "FinishDataLinkUploadWithPath 200 response." + + # New endpoint in v1.102.0 + + - target: "$.paths" + update: + /data-links/{dataLinkId}/download/{filePath}: + get: + tags: + - data-links + summary: "Download data-link file at path" + description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`." + operationId: DownloadDataLink + parameters: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: filePath + in: path + description: "Resource path of the file to download." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + responses: + "200": + description: "OK." + content: + application/json: + schema: + type: string + format: binary + "400": + description: "Bad request." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: "Operation not allowed." + security: + - BearerAuth: [] + + # Remove deprecated endpoint + + - target: "$.paths./data-links/{dataLinkId}/download" + remove: true + # ===== DATA-LINKS PARAMETERS ===== + + # ---- /data-links/{dataLinkId}/browse GET ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: search + in: query + description: "Prefix search of data-link content." + schema: + type: string + - name: nextPageToken + in: query + description: "Token used to fetch the next page of items." + schema: + type: string + - name: pageSize + in: query + description: "Number of items to return per page. If omitted, a default maximum value is returned." + schema: + type: integer + format: int32 + + # ---- /data-links/{dataLinkId}/upload POST ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/upload.post.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/upload.post.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + - name: Origin + in: header + schema: + type: string + nullable: true + + # ---- /data-links/{dataLinkId}/upload/finish POST ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + # ===== FIX DUPLICATE ENUM VALUES ===== + + # These duplicate enum values exist in the base decorated spec + # We use the "remove first, then update" pattern to fix them + + # ---- Query Parameter: Status (line 563) ---- + + - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')].schema.enum" + remove: true + + - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')].schema" + update: + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] + + # ---- Query Parameter: Attributes (line 809) ---- + + - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')].schema.items.enum" + remove: true + + - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')].schema.items" + update: + enum: ["labels"] + + # ---- AzBatchConfig.deleteJobsOnCompletion (line 8891) ---- + + - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion.enum" + remove: true + + - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion" + update: + enum: ["on_success", "always", "never"] + + # ---- ComputeEnv_ComputeConfig_.platform (lines 9283-9331) ---- + # This has extensive triplication of values + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform.enum" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform" + update: + enum: + - "aws-batch" + - "aws-cloud" + - "google-batch" + - "google-cloud" + - "azure-batch" + - "azure-cloud" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" + - "moab-platform" + - "local-platform" + - "seqeracompute-platform" + + # ---- ComputeEnv_ComputeConfig_.status (line 9361) ---- + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status.enum" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status" + update: + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] + + # ---- K8sComputeConfig.podCleanup (line 11444) ---- + + - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup.enum" + remove: true + + - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup" + update: + enum: ["on_success", "always", "never"] + # ===== FIX DUPLICATE REQUIRED FIELDS ===== + + # These duplicate required fields exist in the base spec + # We use the "remove first, then update" pattern to fix them + + # ---- AwsBatchConfig ---- + + - target: "$.components.schemas.AwsBatchConfig.required" + remove: true + + - target: "$.components.schemas.AwsBatchConfig" + update: + required: ["region", "workDir"] + + # ---- AwsCloudConfig ---- + + - target: "$.components.schemas.AwsCloudConfig.required" + remove: true + + - target: "$.components.schemas.AwsCloudConfig" + update: + required: ["region", "workDir"] + + # ---- AzBatchConfig ---- + + - target: "$.components.schemas.AzBatchConfig.required" + remove: true + + - target: "$.components.schemas.AzBatchConfig" + update: + required: ["region", "workDir"] + + # ---- AzCloudConfig ---- + + - target: "$.components.schemas.AzCloudConfig.required" + remove: true + + - target: "$.components.schemas.AzCloudConfig" + update: + required: ["location", "workDir"] + + # ---- ConfigEnvVariable ---- + + - target: "$.components.schemas.ConfigEnvVariable.required" + remove: true + + - target: "$.components.schemas.ConfigEnvVariable" + update: + required: ["name", "value"] + + # ---- CreateComputeEnvRequest ---- + + - target: "$.components.schemas.CreateComputeEnvRequest.required" + remove: true + + - target: "$.components.schemas.CreateComputeEnvRequest" + update: + required: ["computeEnv"] + + # ---- GkeComputeConfig ---- + + - target: "$.components.schemas.GkeComputeConfig.required" + remove: true + + - target: "$.components.schemas.GkeComputeConfig" + update: + required: ["region", "clusterName", "workDir"] + + # ---- GoogleBatchConfig ---- + + - target: "$.components.schemas.GoogleBatchConfig.required" + remove: true + + - target: "$.components.schemas.GoogleBatchConfig" + update: + required: ["location", "workDir"] + + # ---- GoogleCloudConfig ---- + + - target: "$.components.schemas.GoogleCloudConfig.required" + remove: true + + - target: "$.components.schemas.GoogleCloudConfig" + update: + required: ["region", "workDir"] + + # ---- K8sComputeConfig ---- + + - target: "$.components.schemas.K8sComputeConfig.required" + remove: true + + - target: "$.components.schemas.K8sComputeConfig" + update: + required: ["server", "sslCert", "workDir"] + + # ---- SeqeraComputeConfig ---- + + - target: "$.components.schemas.SeqeraComputeConfig.required" + remove: true + + - target: "$.components.schemas.SeqeraComputeConfig" + update: + required: ["region", "workDir"] + + # ---- ComputeEnv_ComputeConfig_ ---- + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.required" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_" + update: + required: ["config", "name", "platform"] + + # ---- EksComputeConfig ---- + + - target: "$.components.schemas.EksComputeConfig.required" + remove: true + + - target: "$.components.schemas.EksComputeConfig" + update: + required: ["region", "clusterName", "workDir"] + # ===== GLOBAL SCHEMAS - CREDENTIALS AND COMPUTE CONFIGURATIONS ===== + + # ---- GIT CREDENTIALS ---- + + - target: "$.components.schemas.GitKeys.description" + update: "Git repository credentials." + + - target: "$.components.schemas.GitKeys.properties.discriminator.description" + update: "Property to select the credentials type." + + - target: "$.components.schemas.GitKeys.properties.username.description" + update: "Git username for authentication." + + - target: "$.components.schemas.GitKeys.properties.password.description" + update: "Git password for authentication." + + - target: "$.components.schemas.GitKeys.properties.token.description" + update: "Git personal access token for authentication." + + # ---- SEQERA COMPUTE CLOUD INSTANCE TYPE SIZE ---- + + - target: "$.components.schemas.SeqeraComputeCloudInstanceTypeSize.description" + update: "Data Studios instance size. Accepts `SMALL`, `MEDIUM`, or `LARGE`." + + # ---- SEQERA COMPUTE CONFIG ---- + + - target: "$.components.schemas.SeqeraComputeConfig.properties.instanceTypeSize.description" + update: "Size of the Data Studios instance. Accepts `SMALL`, `MEDIUM`, or `LARGE`." + + # ---- ABSTRACT GRID CONFIG ---- + + - target: "$.components.schemas.AbstractGridConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.AbstractGridConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AbstractGridConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AbstractGridConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.AbstractGridConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.AbstractGridConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.AbstractGridConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.AbstractGridConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.AbstractGridConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.AbstractGridConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.AbstractGridConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.AbstractGridConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.AbstractGridConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.AbstractGridConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.AbstractGridConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- LSF COMPUTE CONFIG ---- + + - target: "$.components.schemas.LsfComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.LsfComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.LsfComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.LsfComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.LsfComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.LsfComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.LsfComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.LsfComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.LsfComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.LsfComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.LsfComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.LsfComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.LsfComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.LsfComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.LsfComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + - target: "$.components.schemas.LsfComputeConfig.properties.unitForLimits.description" + update: "Unit for memory and time limits in LSF." + + - target: "$.components.schemas.LsfComputeConfig.properties.perJobMemLimit.description" + update: "If true, applies memory limit per job. Default: `false`." + + - target: "$.components.schemas.LsfComputeConfig.properties.perTaskReserve.description" + update: "If true, reserves resources per task. Default: `false`." + + # ---- SLURM COMPUTE CONFIG ---- + + - target: "$.components.schemas.SlurmComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.SlurmComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.SlurmComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.SlurmComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.SlurmComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.SlurmComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.SlurmComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.SlurmComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.SlurmComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.SlurmComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.SlurmComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.SlurmComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.SlurmComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.SlurmComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.SlurmComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- ALTAIR PBS COMPUTE CONFIG ---- + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- MOAB COMPUTE CONFIG ---- + + - target: "$.components.schemas.MoabComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.MoabComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.MoabComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.MoabComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.MoabComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.MoabComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.MoabComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.MoabComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.MoabComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.MoabComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.MoabComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.MoabComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.MoabComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.MoabComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.MoabComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- UNIVA COMPUTE CONFIG ---- + + - target: "$.components.schemas.UnivaComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.UnivaComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.UnivaComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.UnivaComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.UnivaComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.UnivaComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.UnivaComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.UnivaComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.UnivaComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.UnivaComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.UnivaComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.UnivaComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.UnivaComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.UnivaComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.UnivaComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- EKS COMPUTE CONFIG ---- + + - target: "$.components.schemas.EksComputeConfig.properties.region.description" + update: "AWS region where the EKS cluster is located." + + - target: "$.components.schemas.EksComputeConfig.properties.clusterName.description" + update: "Name of the AWS EKS cluster." + + # ---- GKE COMPUTE CONFIG ---- + + - target: "$.components.schemas.GkeComputeConfig.properties.region.description" + update: "Google Cloud region or zone where the GKE cluster is located." + + - target: "$.components.schemas.GkeComputeConfig.properties.clusterName.description" + update: "Name of the Google GKE cluster." + + # ---- WORKFLOW AND TASK SCHEMAS ---- + + - target: "$.components.schemas.Task.properties.numSpotInterruptions.description" + update: "Number of spot instance interruptions encountered by this task." + + - target: "$.components.schemas.TraceProgressData.properties.numSpotInterruptions.description" + update: "Total number of spot instance interruptions across all tasks." + + - target: "$.components.schemas.WorkflowLoad.properties.numSpotInterruptions.description" + update: "Number of spot instance interruptions for the workflow." + + # ---- LIST WORKFLOWS RESPONSE ---- + + - target: "$.components.schemas.ListWorkflowsResponse.properties.hasMore.description" + update: "If true, indicates there are more results available beyond this page." + + # ---- ORGANIZATION QUOTAS ---- + + - target: "$.components.schemas.OrganizationQuotas.properties.maxCustomRolesPerOrg.description" + update: "Maximum number of custom roles allowed per organization." + + # ---- DATA STUDIO STOP REASON ---- + + - target: "$.components.schemas.DataStudioStopReason.description" + update: "Reason for Data Studio session termination. Accepts `UNKNOWN`, `USER_REQUEST`, `TIMEOUT`, `ERROR`, `RESOURCE_LIMIT`, or `NO_STATS_AVAIL`." + # ===== PIPELINE SECRETS SCHEMAS ===== + + # ---- CREATE PIPELINE SECRET REQUEST ---- + + - target: "$.components.schemas.CreatePipelineSecretRequest.properties.name.description" + update: "Unique name for the pipeline secret within the workspace. Used to reference the secret in workflow configurations." + + - target: "$.components.schemas.CreatePipelineSecretRequest.properties.value.description" + update: "The secret value to be securely stored. This value will be made available to pipeline executions as an environment variable or configuration value." + + # ---- UPDATE PIPELINE SECRET REQUEST ---- + + - target: "$.components.schemas.UpdatePipelineSecretRequest.properties.value.description" + update: "New secret value to replace the existing value. The secret value is securely stored and made available to pipeline executions." + + # ===== DATASETS SCHEMAS ===== + + # ---- CREATE DATASET REQUEST ---- + + - target: "$.components.schemas.CreateDatasetRequest.properties.name.description" + update: "Unique dataset name within the workspace. Must be a valid identifier that can be referenced in workflow configurations." + + - target: "$.components.schemas.CreateDatasetRequest.properties.description.description" + update: "Optional description of the dataset. Provides context about the dataset contents, source, or intended use." + + # ---- UPDATE DATASET REQUEST ---- + + - target: "$.components.schemas.UpdateDatasetRequest.properties.name.description" + update: "New name for the dataset. Must be unique within the workspace and can be used to reference the dataset in workflow configurations." + + - target: "$.components.schemas.UpdateDatasetRequest.properties.description.description" + update: "Updated description for the dataset. Provides context about the dataset contents, source, or intended use." + + # ===== WORKSPACES SCHEMAS ===== + + # ---- UPDATE WORKSPACE REQUEST ---- + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.name.description" + update: "New short name for the workspace. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters. Must be unique within the organization." + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.fullName.description" + update: "Updated full display name for the workspace. Maximum 100 characters." + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.description.description" + update: "Updated description of the workspace. Maximum 1000 characters." + + # ===== ACTIONS SCHEMAS ===== + + # ---- UPDATE ACTION REQUEST ---- + + - target: "$.components.schemas.UpdateActionRequest.properties.name.description" + update: "New name for the pipeline action. Must be unique within the workspace." + # ===== REMOVE GOOGLE LIFE SCIENCES PLATFORM ===== + + # This platform option is deprecated and should be removed from the API spec + + # ---- Remove from ComputeEnvResponseDto.platform enum (line 9198) ---- + + - target: "$.components.schemas.ComputeEnvResponseDto.properties.platform.enum" + remove: true + + - target: "$.components.schemas.ComputeEnvResponseDto.properties.platform" + update: + enum: + - "aws-batch" + - "aws-cloud" + - "seqeracompute-platform" + - "google-batch" + - "azure-batch" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" + + # ---- Remove from ComputeConfig discriminator mapping (line 9140) ---- + + - target: "$.components.schemas.ComputeConfig.discriminator.mapping.google-lifesciences" + remove: true + + # ---- Replace ComputeConfig oneOf array without GoogleLifeSciencesConfig ---- + + # CRITICAL: Remove entire oneOf array first to prevent duplicates + - target: "$.components.schemas.ComputeConfig.oneOf" + remove: true + + # Replace with correct array (no GoogleLifeSciencesConfig, no duplicates) + - target: "$.components.schemas.ComputeConfig" + update: + oneOf: + - $ref: "#/components/schemas/AwsBatchConfig" + - $ref: "#/components/schemas/AwsCloudConfig" + - $ref: "#/components/schemas/SeqeraComputeConfig" + - $ref: "#/components/schemas/GoogleBatchConfig" + - $ref: "#/components/schemas/GoogleCloudConfig" + - $ref: "#/components/schemas/AzBatchConfig" + - $ref: "#/components/schemas/AzCloudConfig" + - $ref: "#/components/schemas/LsfComputeConfig" + - $ref: "#/components/schemas/SlurmComputeConfig" + - $ref: "#/components/schemas/K8sComputeConfig" + - $ref: "#/components/schemas/EksComputeConfig" + - $ref: "#/components/schemas/GkeComputeConfig" + - $ref: "#/components/schemas/UnivaComputeConfig" + - $ref: "#/components/schemas/AltairPbsComputeConfig" + - $ref: "#/components/schemas/MoabComputeConfig" + - $ref: "#/components/schemas/LocalComputeConfig" + + # ---- Remove GoogleLifeSciencesConfig schema definition (line 11229+) ---- + + - target: "$.components.schemas.GoogleLifeSciencesConfig" + remove: true + # ===== WORKFLOWS - OPERATIONS ===== + + # ---- LAUNCH WORKFLOW ---- + + - target: "$.paths./workflow/launch.post.description" + update: | + Submits a workflow execution. + + **To [resume](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run) a workflow**: First, retrieve the launch configuration using [`GET /workflow/{workflowId}/launch`](https://docs.seqera.io/platform-api/describe-workflow-launch). Then modify the response by setting `workDir` to the value from `resumeDir`, `revision` to the value from `resumeCommitId`, and `resume` to `true`. Submit the modified payload to this endpoint to resume the workflow. + # ===== WORKFLOWS PARAMETERS - QUERY PARAMETERS ===== + + # ---- LIST WORKFLOWS PARAMETERS ---- + + - target: "$.paths./workflow.get.parameters[?(@.name=='includeTotalSize')].description" + update: "If true, includes total result count in the response. Default: `false`." diff --git a/platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes-analysis.json b/platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes-analysis.json new file mode 100644 index 000000000..3f98f1c31 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes-analysis.json @@ -0,0 +1,957 @@ +{ + "new_endpoints": [ + { + "endpoint": "/compute-envs/{computeEnvId}/disable", + "method": "POST", + "operation_id": "DisableComputeEnv", + "tag": "compute-envs", + "summary": "Disable compute environment", + "target": "$[\"paths\"]" + }, + { + "endpoint": "/compute-envs/{computeEnvId}/enable", + "method": "POST", + "operation_id": "EnableComputeEnv", + "tag": "compute-envs", + "summary": "Enable compute environment", + "target": "$[\"paths\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/download/{filePath}", + "method": "GET", + "operation_id": "DownloadDataLink", + "tag": "data-links", + "summary": "Download data-link file at path", + "target": "$[\"paths\"]" + } + ], + "modified_endpoints": [ + { + "endpoint": "/data-links/{dataLinkId}/browse", + "method": "GET", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/browse\"][\"get\"][\"summary\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/browse", + "method": "GET", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/browse\"][\"get\"][\"description\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/browse/{path}", + "method": "GET", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/browse/{path}\"][\"get\"][\"operationId\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload\"][\"post\"][\"summary\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload\"][\"post\"][\"description\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload/finish", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish\"][\"post\"][\"summary\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload/finish", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish\"][\"post\"][\"description\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload/finish", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish\"][\"post\"][\"responses\"][\"404\"][\"description\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload/finish/{dirPath}", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish/{dirPath}\"][\"post\"][\"operationId\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload/finish/{dirPath}", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish/{dirPath}\"][\"post\"][\"responses\"][\"200\"][\"description\"]" + }, + { + "endpoint": "/data-links/{dataLinkId}/upload/{dirPath}", + "method": "POST", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/{dirPath}\"][\"post\"][\"operationId\"]" + } + ], + "new_schemas": [ + { + "schema": "GitKeys", + "target": "$[\"components\"][\"schemas\"]", + "is_property_change": false + }, + { + "schema": "SeqeraComputeCloudInstanceTypeSize", + "target": "$[\"components\"][\"schemas\"]", + "is_property_change": false + } + ], + "modified_schemas": [ + { + "schema": "AbstractGridConfig", + "target": "$[\"components\"][\"schemas\"][\"AbstractGridConfig\"]", + "is_property_change": false + }, + { + "schema": "AbstractGridConfig", + "target": "$[\"components\"][\"schemas\"][\"AbstractGridConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "Action", + "target": "$[\"components\"][\"schemas\"][\"Action.ConfigType\"][\"properties\"][\"discriminator\"][\"readOnly\"]", + "is_property_change": true + }, + { + "schema": "Action", + "target": "$[\"components\"][\"schemas\"][\"Action.EventType\"][\"properties\"][\"discriminator\"][\"readOnly\"]", + "is_property_change": true + }, + { + "schema": "Action", + "target": "$[\"components\"][\"schemas\"][\"Action.TowerActionConfig\"]", + "is_property_change": false + }, + { + "schema": "Action", + "target": "$[\"components\"][\"schemas\"][\"Action.TowerActionEvent\"]", + "is_property_change": false + }, + { + "schema": "AgentSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"AgentSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "AltairPbsComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"AltairPbsComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "AltairPbsComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"AltairPbsComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "AwsBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsBatchConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "AwsBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsBatchConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "AwsBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsBatchConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "AwsBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsBatchConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AwsBatchPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"AwsBatchPlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "AwsBatchPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"AwsBatchPlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AwsCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsCloudConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "AwsCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsCloudConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "AwsCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsCloudConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "AwsCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AwsCloudConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AwsCloudPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"AwsCloudPlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "AwsCloudPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"AwsCloudPlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AwsSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"AwsSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "AzBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AzBatchConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "AzBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AzBatchConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "AzBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AzBatchConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "AzBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"AzBatchConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AzBatchPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"AzBatchPlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "AzBatchPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"AzBatchPlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AzCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AzCloudConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "AzCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AzCloudConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "AzCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AzCloudConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "AzCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"AzCloudConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AzCloudPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"AzCloudPlatformMetaInfo\"]", + "is_property_change": false + }, + { + "schema": "AzCloudPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"AzCloudPlatformMetaInfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "AzureCloudKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureCloudKeys\"]", + "is_property_change": false + }, + { + "schema": "AzureCloudKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureCloudKeys\"]", + "is_property_change": false + }, + { + "schema": "AzureCloudKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureCloudKeys\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "AzureEntraKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureEntraKeys\"]", + "is_property_change": false + }, + { + "schema": "AzureEntraKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureEntraKeys\"]", + "is_property_change": false + }, + { + "schema": "AzureEntraKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureEntraKeys\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "AzureReposSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureReposSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "AzureSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"AzureSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "BitBucketSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"BitBucketSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "CodeCommitSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"CodeCommitSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "ComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"ComputeConfig\"][\"properties\"][\"discriminator\"][\"readOnly\"]", + "is_property_change": true + }, + { + "schema": "ComputeEnv", + "target": "$[\"components\"][\"schemas\"][\"ComputeEnv.Status\"][\"enum\"]", + "is_property_change": false + }, + { + "schema": "ContainerRegistryKeys", + "target": "$[\"components\"][\"schemas\"][\"ContainerRegistryKeys\"]", + "is_property_change": false + }, + { + "schema": "DataStudioStopReason", + "target": "$[\"components\"][\"schemas\"][\"DataStudioStopReason\"][\"enum\"]", + "is_property_change": false + }, + { + "schema": "EksComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"EksComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "EksComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"EksComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "EksPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"EksPlatformMetaInfo\"]", + "is_property_change": false + }, + { + "schema": "EksPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"EksPlatformMetaInfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GitHubSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"GitHubSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "GitLabSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"GitLabSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "GiteaSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"GiteaSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "GithubActionConfig", + "target": "$[\"components\"][\"schemas\"][\"GithubActionConfig\"]", + "is_property_change": false + }, + { + "schema": "GithubActionEvent", + "target": "$[\"components\"][\"schemas\"][\"GithubActionEvent\"]", + "is_property_change": false + }, + { + "schema": "GkeComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"GkeComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "GkeComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"GkeComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "GkePlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"GkePlatformMetaInfo\"]", + "is_property_change": false + }, + { + "schema": "GkePlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"GkePlatformMetaInfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GoogleBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleBatchConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "GoogleBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleBatchConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "GoogleBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleBatchConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "GoogleBatchConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleBatchConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GoogleCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleCloudConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "GoogleCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleCloudConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "GoogleCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleCloudConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "GoogleCloudConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleCloudConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GoogleCloudPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"GoogleCloudPlatformMetaInfo\"]", + "is_property_change": false + }, + { + "schema": "GoogleCloudPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"GoogleCloudPlatformMetaInfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GoogleLifeSciencesConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleLifeSciencesConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "GoogleLifeSciencesConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleLifeSciencesConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "GoogleLifeSciencesConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleLifeSciencesConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "GoogleLifeSciencesConfig", + "target": "$[\"components\"][\"schemas\"][\"GoogleLifeSciencesConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GooglePlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"GooglePlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "GooglePlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"GooglePlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "GoogleSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"GoogleSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "GridPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"GridPlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "GridPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"GridPlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "K8sComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"K8sComputeConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "K8sComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"K8sComputeConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "K8sComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"K8sComputeConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "K8sComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"K8sComputeConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "K8sPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"K8sPlatformMetaInfo\"]", + "is_property_change": false + }, + { + "schema": "K8sPlatformMetaInfo", + "target": "$[\"components\"][\"schemas\"][\"K8sPlatformMetaInfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "K8sSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"K8sSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "ListWorkflowsResponse", + "target": "$[\"components\"][\"schemas\"][\"ListWorkflowsResponse\"][\"properties\"]", + "is_property_change": true + }, + { + "schema": "LocalComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"LocalComputeConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "LocalComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"LocalComputeConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "LocalComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"LocalComputeConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "LocalComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"LocalComputeConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "LocalPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"LocalPlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "LocalPlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"LocalPlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "LsfComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"LsfComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "LsfComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"LsfComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "MoabComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"MoabComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "MoabComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"MoabComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "OrganizationQuotas", + "target": "$[\"components\"][\"schemas\"][\"OrganizationQuotas\"][\"properties\"]", + "is_property_change": true + }, + { + "schema": "PlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"PlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "S3SecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"S3SecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "SSHSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"SSHSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "SecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"SecurityKeys\"][\"properties\"][\"discriminator\"][\"readOnly\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeConfig\"][\"properties\"][\"workDir\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeConfig\"][\"properties\"][\"preRunScript\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeConfig\"][\"properties\"][\"postRunScript\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeConfig\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeConfig\"][\"properties\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputePlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputePlatformMetainfo\"]", + "is_property_change": false + }, + { + "schema": "SeqeraComputePlatformMetainfo", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputePlatformMetainfo\"][\"properties\"][\"discriminator\"]", + "is_property_change": true + }, + { + "schema": "SeqeraComputeSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "SeqeraComputeSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeSecurityKeys\"]", + "is_property_change": false + }, + { + "schema": "SeqeraComputeSecurityKeys", + "target": "$[\"components\"][\"schemas\"][\"SeqeraComputeSecurityKeys\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "ServiceInfo", + "target": "$[\"components\"][\"schemas\"][\"ServiceInfo\"][\"properties\"][\"navbar\"]", + "is_property_change": true + }, + { + "schema": "ServiceInfo", + "target": "$[\"components\"][\"schemas\"][\"ServiceInfo\"][\"properties\"][\"navbar\"][\"deprecated\"]", + "is_property_change": true + }, + { + "schema": "ServiceInfo", + "target": "$[\"components\"][\"schemas\"][\"ServiceInfo\"][\"properties\"][\"navbar\"][\"allOf\"]", + "is_property_change": true + }, + { + "schema": "SlurmComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SlurmComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "SlurmComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"SlurmComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "Task", + "target": "$[\"components\"][\"schemas\"][\"Task\"][\"properties\"]", + "is_property_change": true + }, + { + "schema": "TraceProgressData", + "target": "$[\"components\"][\"schemas\"][\"TraceProgressData\"][\"properties\"]", + "is_property_change": true + }, + { + "schema": "UnivaComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"UnivaComputeConfig\"]", + "is_property_change": false + }, + { + "schema": "UnivaComputeConfig", + "target": "$[\"components\"][\"schemas\"][\"UnivaComputeConfig\"][\"allOf\"]", + "is_property_change": false + }, + { + "schema": "WorkflowLoad", + "target": "$[\"components\"][\"schemas\"][\"WorkflowLoad\"][\"properties\"]", + "is_property_change": true + } + ], + "new_parameters": [ + { + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/browse\"][\"get\"][\"parameters\"][*]", + "update": null + }, + { + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/browse\"][\"get\"][\"parameters\"]", + "update": [ + { + "name": "dataLinkId", + "in": "path", + "description": "Data-link string identifier", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workspaceId", + "in": "query", + "description": "Workspace numeric identifier", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "credentialsId", + "in": "query", + "description": "Credentials string identifier", + "schema": { + "type": "string" + } + }, + { + "name": "search", + "in": "query", + "description": "Prefix search of data-link content", + "schema": { + "type": "string" + } + }, + { + "name": "nextPageToken", + "in": "query", + "description": "Token used to fetch the next page of items", + "schema": { + "type": "string" + } + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page. If ommitted, a default maximum value is returned.", + "schema": { + "type": "integer", + "format": "int32" + } + } + ] + }, + { + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload\"][\"post\"][\"parameters\"][*]", + "update": null + }, + { + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload\"][\"post\"][\"parameters\"]", + "update": [ + { + "name": "dataLinkId", + "in": "path", + "description": "Data-link string identifier", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credentialsId", + "in": "query", + "description": "Credentials string identifier", + "schema": { + "type": "string" + } + }, + { + "name": "workspaceId", + "in": "query", + "description": "Workspace numeric identifier", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "Origin", + "in": "header", + "schema": { + "type": "string", + "nullable": true + } + } + ] + }, + { + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish\"][\"post\"][\"parameters\"][*]", + "update": null + }, + { + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/upload/finish\"][\"post\"][\"parameters\"]", + "update": [ + { + "name": "dataLinkId", + "in": "path", + "description": "Data-link string identifier", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credentialsId", + "in": "query", + "description": "Credentials string identifier", + "schema": { + "type": "string" + } + }, + { + "name": "workspaceId", + "in": "query", + "description": "Workspace numeric identifier", + "schema": { + "type": "integer", + "format": "int64" + } + } + ] + }, + { + "target": "$[\"paths\"][\"/workflow\"][\"get\"][\"parameters\"]", + "update": [ + { + "name": "includeTotalSize", + "in": "query", + "description": "Include total size in the response", + "schema": { + "type": "boolean" + } + } + ] + } + ], + "deprecated_endpoints": [ + { + "endpoint": "/data-links/{dataLinkId}/download", + "method": "UNKNOWN", + "operation_id": null, + "tag": "data-links", + "summary": null, + "target": "$[\"paths\"][\"/data-links/{dataLinkId}/download\"]" + } + ], + "by_tag": { + "compute-envs": { + "endpoints": [ + { + "endpoint": "/compute-envs/{computeEnvId}/disable", + "method": "POST", + "operation_id": "DisableComputeEnv", + "tag": "compute-envs", + "summary": "Disable compute environment", + "target": "$[\"paths\"]" + }, + { + "endpoint": "/compute-envs/{computeEnvId}/enable", + "method": "POST", + "operation_id": "EnableComputeEnv", + "tag": "compute-envs", + "summary": "Enable compute environment", + "target": "$[\"paths\"]" + } + ], + "schemas": [] + }, + "data-links": { + "endpoints": [ + { + "endpoint": "/data-links/{dataLinkId}/download/{filePath}", + "method": "GET", + "operation_id": "DownloadDataLink", + "tag": "data-links", + "summary": "Download data-link file at path", + "target": "$[\"paths\"]" + } + ], + "schemas": [] + } + }, + "summary": { + "total_new_endpoints": 3, + "total_modified_endpoints": 11, + "total_new_schemas": 2, + "total_modified_schemas": 123, + "affected_tags": [ + "compute-envs", + "data-links" + ], + "requires_new_category": true + } +} \ No newline at end of file diff --git a/platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes.yaml b/platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes.yaml new file mode 100644 index 000000000..392d56135 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/base-1.95-to-1.102.0-changes.yaml @@ -0,0 +1,1041 @@ +overlay: 1.0.0 +x-speakeasy-jsonpath: rfc9535 +info: + title: Overlay seqera-api-1.95.yml => seqera-api-1.102.0.yaml + version: 0.0.0 +actions: + - target: $["info"]["version"] + update: 1.102.0 + - target: $["paths"] + update: + /compute-envs/{computeEnvId}/disable: + post: + tags: + - compute-envs + summary: Disable compute environment + description: "Disables the compute environment identified by the given `computeEnvId`. A disabled compute environment cannot be used to launch workflows. If the compute environment is primary, it will be automatically unset as primary." + operationId: DisableComputeEnv + parameters: + - name: computeEnvId + in: path + description: Compute environment string identifier + required: true + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/EmptyBodyRequest" + responses: + "204": + description: OK - No content + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Operation not allowed + security: + - BearerAuth: [] + - target: $["paths"] + update: + /compute-envs/{computeEnvId}/enable: + post: + tags: + - compute-envs + summary: Enable compute environment + description: Enables the compute environment identified by the given `computeEnvId`. An enabled compute environment can be used to launch workflows. + operationId: EnableComputeEnv + parameters: + - name: computeEnvId + in: path + description: Compute environment string identifier + required: true + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/EmptyBodyRequest" + responses: + "204": + description: OK - No content + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Operation not allowed + security: + - BearerAuth: [] + - target: $["paths"]["/data-links/{dataLinkId}/browse"]["get"]["summary"] + update: Explore data-link + - target: $["paths"]["/data-links/{dataLinkId}/browse"]["get"]["description"] + update: Retrieves the content of the data-link associated with the given `dataLinkId` + - target: $["paths"]["/data-links/{dataLinkId}/browse"]["get"]["parameters"][*] + remove: true + - target: $["paths"]["/data-links/{dataLinkId}/browse"]["get"]["parameters"] + update: + - name: dataLinkId + in: path + description: Data-link string identifier + required: true + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + - name: credentialsId + in: query + description: Credentials string identifier + schema: + type: string + - name: search + in: query + description: Prefix search of data-link content + schema: + type: string + - name: nextPageToken + in: query + description: Token used to fetch the next page of items + schema: + type: string + - name: pageSize + in: query + description: "Number of items to return per page. If ommitted, a default maximum value is returned." + schema: + type: integer + format: int32 + - target: $["paths"]["/data-links/{dataLinkId}/browse/{path}"]["get"]["operationId"] + update: ExploreDataLinkWithPath + - target: $["paths"] + update: + /data-links/{dataLinkId}/download/{filePath}: + get: + tags: + - data-links + summary: Download data-link file at path + description: Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. + operationId: DownloadDataLink + parameters: + - name: dataLinkId + in: path + description: Data-link string identifier + required: true + schema: + type: string + - name: filePath + in: path + description: File path to download + required: true + schema: + type: string + - name: credentialsId + in: query + description: Credentials string identifier + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + responses: + "200": + description: OK + content: + application/json: + schema: + type: string + format: binary + "400": + description: BadRequest + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Operation not allowed + security: + - BearerAuth: [] + - target: $["paths"]["/data-links/{dataLinkId}/upload"]["post"]["summary"] + update: Generate data-link file upload URL + - target: $["paths"]["/data-links/{dataLinkId}/upload"]["post"]["description"] + update: |- + Creates a URL to upload files to the data-link associated with the given `dataLinkId`. + For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. + - target: $["paths"]["/data-links/{dataLinkId}/upload"]["post"]["parameters"][*] + remove: true + - target: $["paths"]["/data-links/{dataLinkId}/upload"]["post"]["parameters"] + update: + - name: dataLinkId + in: path + description: Data-link string identifier + required: true + schema: + type: string + - name: credentialsId + in: query + description: Credentials string identifier + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + - name: Origin + in: header + schema: + type: string + nullable: true + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish"]["post"]["summary"] + update: Finish data-link file upload + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish"]["post"]["description"] + update: "Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish"]["post"]["parameters"][*] + remove: true + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish"]["post"]["parameters"] + update: + - name: dataLinkId + in: path + description: Data-link string identifier + required: true + schema: + type: string + - name: credentialsId + in: query + description: Credentials string identifier + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish"]["post"]["responses"]["404"]["description"] + update: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found" + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish/{dirPath}"]["post"]["operationId"] + update: FinishDataLinkUploadWithPath + - target: $["paths"]["/data-links/{dataLinkId}/upload/finish/{dirPath}"]["post"]["responses"]["200"]["description"] + update: FinishDataLinkUploadWithPath 200 response + - target: $["paths"]["/data-links/{dataLinkId}/upload/{dirPath}"]["post"]["operationId"] + update: GenerateDataLinkUploadUrlWithPath + - target: $["paths"]["/workflow"]["get"]["parameters"] + update: + - name: includeTotalSize + in: query + description: Include total size in the response + schema: + type: boolean + - target: $["paths"]["/data-links/{dataLinkId}/download"] + remove: true + - target: $["components"]["schemas"]["AbstractGridConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean + - target: $["components"]["schemas"]["AbstractGridConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["Action.ConfigType"]["properties"]["discriminator"]["readOnly"] + remove: true + - target: $["components"]["schemas"]["Action.EventType"]["properties"]["discriminator"]["readOnly"] + remove: true + - target: $["components"]["schemas"]["Action.TowerActionConfig"] + update: + title: Tower Action Config + - target: $["components"]["schemas"]["Action.TowerActionEvent"] + update: + title: Tower action event + - target: $["components"]["schemas"]["AgentSecurityKeys"] + update: + title: Tower Agent credentials + - target: $["components"]["schemas"]["AltairPbsComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean + - target: $["components"]["schemas"]["AltairPbsComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["AwsBatchConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["AwsBatchConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AwsBatchConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AwsBatchConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["AwsBatchPlatformMetainfo"] + update: + title: AWS Batch platform metainfo + - target: $["components"]["schemas"]["AwsBatchPlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["AwsCloudConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["AwsCloudConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AwsCloudConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AwsCloudConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["AwsCloudPlatformMetainfo"] + update: + title: AWS Cloud platform metainfo + - target: $["components"]["schemas"]["AwsCloudPlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["AwsSecurityKeys"] + update: + title: AWS credentials + - target: $["components"]["schemas"]["AzBatchConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["AzBatchConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AzBatchConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AzBatchConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["AzBatchPlatformMetainfo"] + update: + title: Azure Batch platform metainfo + - target: $["components"]["schemas"]["AzBatchPlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["AzCloudConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["AzCloudConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AzCloudConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["AzCloudConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["AzCloudPlatformMetaInfo"] + update: + title: Azure Cloud platform metainfo + - target: $["components"]["schemas"]["AzCloudPlatformMetaInfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["AzureCloudKeys"] + update: + title: Azure Cloud credentials + - target: $["components"]["schemas"]["AzureCloudKeys"] + update: + properties: + discriminator: + type: string + batchName: + type: string + storageName: + type: string + batchKey: + type: string + writeOnly: true + storageKey: + type: string + writeOnly: true + subscriptionId: + type: string + tenantId: + type: string + clientId: + type: string + clientSecret: + type: string + writeOnly: true + - target: $["components"]["schemas"]["AzureCloudKeys"]["allOf"] + remove: true + - target: $["components"]["schemas"]["AzureEntraKeys"] + update: + title: Azure Entra credentials + - target: $["components"]["schemas"]["AzureEntraKeys"] + update: + properties: + discriminator: + type: string + batchName: + type: string + storageName: + type: string + batchKey: + type: string + writeOnly: true + storageKey: + type: string + writeOnly: true + tenantId: + type: string + clientId: + type: string + clientSecret: + type: string + writeOnly: true + - target: $["components"]["schemas"]["AzureEntraKeys"]["allOf"] + remove: true + - target: $["components"]["schemas"]["AzureReposSecurityKeys"] + update: + title: Azure Repos credentials + - target: $["components"]["schemas"]["AzureSecurityKeys"] + update: + title: Azure credentials + - target: $["components"]["schemas"]["BitBucketSecurityKeys"] + update: + title: BitBucket credentials + - target: $["components"]["schemas"]["CodeCommitSecurityKeys"] + update: + title: AWS CodeCommit credentials + - target: $["components"]["schemas"]["ComputeConfig"]["properties"]["discriminator"]["readOnly"] + remove: true + - target: $["components"]["schemas"]["ComputeEnv.Status"]["enum"] + update: + - DISABLED + - target: $["components"]["schemas"]["ContainerRegistryKeys"] + update: + title: Container registry credentials + - target: $["components"]["schemas"]["DataStudioStopReason"]["enum"] + update: + - NO_STATS_AVAIL + - target: $["components"]["schemas"]["EksComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + server: + type: string + sslCert: + type: string + namespace: + type: string + computeServiceAccount: + type: string + headServiceAccount: + type: string + storageClaimName: + type: string + storageMountPath: + type: string + podCleanup: + $ref: "#/components/schemas/PodCleanupPolicy" + headPodSpec: + type: string + servicePodSpec: + type: string + headJobCpus: + type: integer + format: int32 + headJobMemoryMb: + type: integer + format: int32 + region: + type: string + description: AWS region + clusterName: + type: string + description: The AWS EKS cluster name + waveEnabled: + type: boolean + fusion2Enabled: + type: boolean + - target: $["components"]["schemas"]["EksComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["EksPlatformMetaInfo"] + update: + title: Amazon EKS platform metainfo + - target: $["components"]["schemas"]["EksPlatformMetaInfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["GitHubSecurityKeys"] + update: + title: GitHub credentials + - target: $["components"]["schemas"] + update: + GitKeys: + type: object + properties: + discriminator: + type: string + username: + type: string + password: + type: string + token: + type: string + - target: $["components"]["schemas"]["GitLabSecurityKeys"] + update: + title: GitLab credentials + - target: $["components"]["schemas"]["GiteaSecurityKeys"] + update: + title: Gitea credentials + - target: $["components"]["schemas"]["GithubActionConfig"] + update: + title: GitHub action config + - target: $["components"]["schemas"]["GithubActionEvent"] + update: + title: GitHub action event + - target: $["components"]["schemas"]["GkeComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + server: + type: string + sslCert: + type: string + namespace: + type: string + computeServiceAccount: + type: string + headServiceAccount: + type: string + storageClaimName: + type: string + storageMountPath: + type: string + podCleanup: + $ref: "#/components/schemas/PodCleanupPolicy" + headPodSpec: + type: string + servicePodSpec: + type: string + headJobCpus: + type: integer + format: int32 + headJobMemoryMb: + type: integer + format: int32 + region: + type: string + description: The GKE cluster region - or - zone + clusterName: + type: string + description: The GKE cluster name + fusion2Enabled: + type: boolean + waveEnabled: + type: boolean + - target: $["components"]["schemas"]["GkeComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["GkePlatformMetaInfo"] + update: + title: Google GKE platform metainfo + - target: $["components"]["schemas"]["GkePlatformMetaInfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["GoogleBatchConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["GoogleBatchConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["GoogleBatchConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["GoogleBatchConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["GoogleCloudConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["GoogleCloudConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["GoogleCloudConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["GoogleCloudConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["GoogleCloudPlatformMetaInfo"] + update: + title: Google Cloud platform metainfo + - target: $["components"]["schemas"]["GoogleCloudPlatformMetaInfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["GoogleLifeSciencesConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["GoogleLifeSciencesConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["GoogleLifeSciencesConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["GoogleLifeSciencesConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["GooglePlatformMetainfo"] + update: + title: Google Batch platform metainfo + - target: $["components"]["schemas"]["GooglePlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["GoogleSecurityKeys"] + update: + title: Google credentials + - target: $["components"]["schemas"]["GridPlatformMetainfo"] + update: + title: Grid platform metainfo + - target: $["components"]["schemas"]["GridPlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["K8sComputeConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["K8sComputeConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["K8sComputeConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["K8sComputeConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["K8sPlatformMetaInfo"] + update: + title: Kubernetes platform metainfo + - target: $["components"]["schemas"]["K8sPlatformMetaInfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["K8sSecurityKeys"] + update: + title: Kubernetes credentials + - target: $["components"]["schemas"]["ListWorkflowsResponse"]["properties"] + update: + hasMore: + type: boolean + - target: $["components"]["schemas"]["LocalComputeConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["LocalComputeConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["LocalComputeConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["LocalComputeConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["LocalPlatformMetainfo"] + update: + title: Local platform metainfo + - target: $["components"]["schemas"]["LocalPlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["LsfComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean + unitForLimits: + type: string + perJobMemLimit: + type: boolean + perTaskReserve: + type: boolean + - target: $["components"]["schemas"]["LsfComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["MoabComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean + - target: $["components"]["schemas"]["MoabComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["OrganizationQuotas"]["properties"] + update: + maxCustomRolesPerOrg: + type: integer + format: int64 + - target: $["components"]["schemas"]["PlatformMetainfo"] + update: + properties: + discriminator: + type: string + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["S3SecurityKeys"] + update: + title: S3-compatible credentials + - target: $["components"]["schemas"]["SSHSecurityKeys"] + update: + title: SSH credentials + - target: $["components"]["schemas"]["SecurityKeys"]["properties"]["discriminator"]["readOnly"] + remove: true + - target: $["components"]["schemas"] + update: + SeqeraComputeCloudInstanceTypeSize: + type: string + enum: + - SMALL + - MEDIUM + - LARGE + - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"]["workDir"] + update: + description: Compute environment working directory + - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"]["preRunScript"] + update: + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"]["postRunScript"] + update: + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"]["discriminator"] + update: + description: property to select the compute config platform + - target: $["components"]["schemas"]["SeqeraComputeConfig"]["properties"] + update: + instanceTypeSize: + description: "Size of the Data Studios instance (SMALL, MEDIUM, LARGE)" + allOf: + - $ref: "#/components/schemas/SeqeraComputeCloudInstanceTypeSize" + - target: $["components"]["schemas"]["SeqeraComputePlatformMetainfo"] + update: + title: Seqera Compute platform metainfo + - target: $["components"]["schemas"]["SeqeraComputePlatformMetainfo"]["properties"]["discriminator"] + update: + description: property to select the platform metainfo type + - target: $["components"]["schemas"]["SeqeraComputeSecurityKeys"] + update: + title: Seqera Compute credentials + - target: $["components"]["schemas"]["SeqeraComputeSecurityKeys"] + update: + properties: + discriminator: + type: string + accessKey: + type: string + secretKey: + type: string + writeOnly: true + assumeRoleArn: + type: string + - target: $["components"]["schemas"]["SeqeraComputeSecurityKeys"]["allOf"] + remove: true + - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["navbar"] + update: + $ref: "#/components/schemas/NavbarConfig" + - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["navbar"]["deprecated"] + remove: true + - target: $["components"]["schemas"]["ServiceInfo"]["properties"]["navbar"]["allOf"] + remove: true + - target: $["components"]["schemas"]["SlurmComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean + - target: $["components"]["schemas"]["SlurmComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["Task"]["properties"] + update: + numSpotInterruptions: + type: integer + format: int32 + - target: $["components"]["schemas"]["TraceProgressData"]["properties"] + update: + numSpotInterruptions: + type: integer + format: int32 + - target: $["components"]["schemas"]["UnivaComputeConfig"] + update: + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean + - target: $["components"]["schemas"]["UnivaComputeConfig"]["allOf"] + remove: true + - target: $["components"]["schemas"]["WorkflowLoad"]["properties"] + update: + numSpotInterruptions: + type: integer + format: int32 diff --git a/platform-api-docs/scripts/overlay_archives/claude-generated-overlays.md b/platform-api-docs/scripts/overlay_archives/claude-generated-overlays.md new file mode 100644 index 000000000..2afaff260 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/claude-generated-overlays.md @@ -0,0 +1,1227 @@ +# Generated Overlays for v1.102.0 + +This file contains all the overlay files generated from the base-1.95-to-1.102.0-changes.yaml comparison overlay, plus manual enrichments for field descriptions. + +**CRITICAL FIXES**: +- `data-links-operations-overlay-1.102.0.yaml` now correctly REMOVES the deprecated `/data-links/{dataLinkId}/download` endpoint +- `data-links-parameters-overlay-1.102.0.yaml` includes parameter array removal actions to prevent duplicate parameters + +--- + +# Missing Schemas (Must Apply First) + +## add-missing-schema-overlay-1.102.0.yaml + +**CRITICAL**: This schema exists in v1.95 base spec but was accidentally excluded from v1.95 decorated spec. Must be added BEFORE other overlays can reference it in ComputeConfig.oneOf array. + +```yaml +overlay: 1.0.0 +info: + title: Add missing LocalComputeConfig schema + version: 1.102.0 +actions: + # ===== ADD MISSING LocalComputeConfig SCHEMA ===== + + # This schema exists in v1.95 base spec but was accidentally excluded from v1.95 decorated spec + # We need to add it before other overlays can reference it + + - target: "$.components.schemas" + update: + LocalComputeConfig: + type: object + title: Local execution configuration + properties: + workDir: + type: string + description: "Compute environment working directory." + preRunScript: + type: string + description: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + description: "Array of environment variables for the compute environment." + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + description: "Additional Nextflow configuration content." + discriminator: + type: string + description: "Property to select the compute config platform." + readOnly: true + waveEnabled: + type: boolean + description: "Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)." + fusion2Enabled: + type: boolean + description: "Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)." +``` + +--- + +# Compute Environments Overlays + +## compute-envs-operations-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Compute environments operations overlay + version: 0.0.0 +actions: + # ===== COMPUTE ENVIRONMENTS - OPERATIONS ===== + + # ---- DISABLE COMPUTE ENVIRONMENT ---- + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.summary" + update: "Disable compute environment" + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.description" + update: "Disables the compute environment identified by the given `computeEnvId`. A disabled compute environment cannot be used to launch new workflows or Studio sessions. If the compute environment is primary, it will be automatically unset as primary. See [Disable compute environment](https://docs.seqera.io/platform-cloud/compute-envs/overview#disable-compute-environment)" + + # ---- ENABLE COMPUTE ENVIRONMENT ---- + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.summary" + update: "Enable compute environment" + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.description" + update: "Enables the compute environment identified by the given `computeEnvId`. An enabled compute environment can be used to launch new workflows and Studio sessions." +``` + +## compute-envs-parameters-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Compute environments parameters overlay + version: 0.0.0 +actions: + # ===== COMPUTE ENVIRONMENTS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== + + # ---- DISABLE COMPUTE ENVIRONMENT PARAMETERS ---- + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.parameters[?(@.name=='computeEnvId')].description" + update: "Compute environment string identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.parameters[?(@.name=='workspaceId')].description" + update: "Workspace numeric identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.requestBody.description" + update: "Compute environment disable request" + + # ---- ENABLE COMPUTE ENVIRONMENT PARAMETERS ---- + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.parameters[?(@.name=='computeEnvId')].description" + update: "Compute environment string identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.parameters[?(@.name=='workspaceId')].description" + update: "Workspace numeric identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.requestBody.description" + update: "Compute environment enable request" +``` + +## compute-envs-schemas-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Compute environments schemas overlay + version: 0.0.0 +actions: + # ===== COMPUTE ENVIRONMENTS SCHEMAS - REQUEST/RESPONSE OBJECTS ===== + + # ---- COMPUTE ENVIRONMENT STATUS ENUM ---- + + - target: "$.components.schemas.ComputeEnv.Status" + update: + type: string + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "DISABLED"] + description: "Compute environment status. Accepts `CREATING`, `AVAILABLE`, `ERRORED`, `INVALID`, or `DISABLED`." +``` + +--- + +# Data Links Overlays + +## data-links-operations-overlay-1.102.0.yaml + +```yaml +actions: + # ===== DATA-LINKS - OPERATIONS ===== + + # Update existing operations + + - target: "$.paths./data-links/{dataLinkId}/browse.get.summary" + update: "Explore data-link" + + - target: "$.paths./data-links/{dataLinkId}/browse.get.description" + update: "Retrieves the content of the data-link associated with the given `dataLinkId`." + + - target: "$.paths./data-links/{dataLinkId}/browse/{path}.get.operationId" + update: "ExploreDataLinkWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload.post.summary" + update: "Generate data-link file upload URL" + + - target: "$.paths./data-links/{dataLinkId}/upload.post.description" + update: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint." + + - target: "$.paths./data-links/{dataLinkId}/upload/{dirPath}.post.operationId" + update: "GenerateDataLinkUploadUrlWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.summary" + update: "Finish data-link file upload" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.description" + update: "Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.responses['404'].description" + update: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found." + + - target: "$.paths./data-links/{dataLinkId}/upload/finish/{dirPath}.post.operationId" + update: "FinishDataLinkUploadWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish/{dirPath}.post.responses['200'].description" + update: "FinishDataLinkUploadWithPath 200 response." + + # New endpoint in v1.102.0 + + - target: "$.paths" + update: + /data-links/{dataLinkId}/download/{filePath}: + get: + tags: + - data-links + summary: "Download data-link file at path" + description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`." + operationId: DownloadDataLink + parameters: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: filePath + in: path + description: "Resource path of the file to download." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + responses: + "200": + description: "OK." + content: + application/json: + schema: + type: string + format: binary + "400": + description: "Bad request." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: "Operation not allowed." + security: + - BearerAuth: [] + + # Remove deprecated endpoint + + - target: "$.paths./data-links/{dataLinkId}/download" + remove: true +``` + +## data-links-parameters-overlay-1.102.0.yaml + +**CRITICAL**: This overlay includes parameter array removal actions to prevent duplicate parameters. + +```yaml +overlay: 1.0.0 +info: + title: Data-links parameters overlay + version: 1.102.0 +actions: + # ===== DATA-LINKS PARAMETERS ===== + + # ---- /data-links/{dataLinkId}/browse GET ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: search + in: query + description: "Prefix search of data-link content." + schema: + type: string + - name: nextPageToken + in: query + description: "Token used to fetch the next page of items." + schema: + type: string + - name: pageSize + in: query + description: "Number of items to return per page. If omitted, a default maximum value is returned." + schema: + type: integer + format: int32 + + # ---- /data-links/{dataLinkId}/upload POST ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/upload.post.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/upload.post.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + - name: Origin + in: header + schema: + type: string + nullable: true + + # ---- /data-links/{dataLinkId}/upload/finish POST ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 +``` + +--- + +# Workflows Overlays + +## workflows-parameters-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Workflows parameters overlay + version: 0.0.0 +actions: + # ===== WORKFLOWS PARAMETERS - QUERY PARAMETERS ===== + + # ---- LIST WORKFLOWS PARAMETERS ---- + + - target: "$.paths./workflow.get.parameters[?(@.name=='includeTotalSize')].description" + update: "If true, includes total result count in the response. Default: `false`." +``` + +## workflows-operations-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Workflows operations overlay + version: 0.0.0 +actions: + # ===== WORKFLOWS - OPERATIONS ===== + + # ---- LAUNCH WORKFLOW ---- + + - target: "$.paths./workflow/launch.post.description" + update: | + Submits a workflow execution. + + **To [resume](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run) a workflow**: First, retrieve the launch configuration using [`GET /workflow/{workflowId}/launch`](https://docs.seqera.io/platform-api/describe-workflow-launch). Then modify the response by setting `workDir` to the value from `resumeDir`, `revision` to the value from `resumeCommitId`, and `resume` to `true`. Submit the modified payload to this endpoint to resume the workflow. +``` + +--- + +# Global Schemas Overlay + +## global-schemas-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Global schemas overlay + version: 0.0.0 +actions: + # ===== GLOBAL SCHEMAS - CREDENTIALS AND COMPUTE CONFIGURATIONS ===== + + # ---- GIT CREDENTIALS ---- + + - target: "$.components.schemas.GitKeys.description" + update: "Git repository credentials." + + - target: "$.components.schemas.GitKeys.properties.discriminator.description" + update: "Property to select the credentials type." + + - target: "$.components.schemas.GitKeys.properties.username.description" + update: "Git username for authentication." + + - target: "$.components.schemas.GitKeys.properties.password.description" + update: "Git password for authentication." + + - target: "$.components.schemas.GitKeys.properties.token.description" + update: "Git personal access token for authentication." + + # ---- SEQERA COMPUTE CLOUD INSTANCE TYPE SIZE ---- + + - target: "$.components.schemas.SeqeraComputeCloudInstanceTypeSize.description" + update: "Data Studios instance size. Accepts `SMALL`, `MEDIUM`, or `LARGE`." + + # ---- SEQERA COMPUTE CONFIG ---- + + - target: "$.components.schemas.SeqeraComputeConfig.properties.instanceTypeSize.description" + update: "Size of the Data Studios instance. Accepts `SMALL`, `MEDIUM`, or `LARGE`." + + # ---- ABSTRACT GRID CONFIG ---- + + - target: "$.components.schemas.AbstractGridConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.AbstractGridConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AbstractGridConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AbstractGridConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.AbstractGridConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.AbstractGridConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.AbstractGridConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.AbstractGridConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.AbstractGridConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.AbstractGridConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.AbstractGridConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.AbstractGridConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.AbstractGridConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.AbstractGridConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.AbstractGridConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- LSF COMPUTE CONFIG ---- + + - target: "$.components.schemas.LsfComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.LsfComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.LsfComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.LsfComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.LsfComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.LsfComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.LsfComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.LsfComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.LsfComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.LsfComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.LsfComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.LsfComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.LsfComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.LsfComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.LsfComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + - target: "$.components.schemas.LsfComputeConfig.properties.unitForLimits.description" + update: "Unit for memory and time limits in LSF." + + - target: "$.components.schemas.LsfComputeConfig.properties.perJobMemLimit.description" + update: "If true, applies memory limit per job. Default: `false`." + + - target: "$.components.schemas.LsfComputeConfig.properties.perTaskReserve.description" + update: "If true, reserves resources per task. Default: `false`." + + # ---- SLURM COMPUTE CONFIG ---- + + - target: "$.components.schemas.SlurmComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.SlurmComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.SlurmComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.SlurmComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.SlurmComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.SlurmComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.SlurmComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.SlurmComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.SlurmComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.SlurmComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.SlurmComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.SlurmComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.SlurmComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.SlurmComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.SlurmComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- ALTAIR PBS COMPUTE CONFIG ---- + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- MOAB COMPUTE CONFIG ---- + + - target: "$.components.schemas.MoabComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.MoabComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.MoabComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.MoabComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.MoabComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.MoabComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.MoabComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.MoabComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.MoabComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.MoabComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.MoabComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.MoabComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.MoabComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.MoabComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.MoabComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- UNIVA COMPUTE CONFIG ---- + + - target: "$.components.schemas.UnivaComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.UnivaComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.UnivaComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.UnivaComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.UnivaComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.UnivaComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.UnivaComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.UnivaComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.UnivaComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.UnivaComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.UnivaComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.UnivaComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.UnivaComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.UnivaComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.UnivaComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- EKS COMPUTE CONFIG ---- + + - target: "$.components.schemas.EksComputeConfig.properties.region.description" + update: "AWS region where the EKS cluster is located." + + - target: "$.components.schemas.EksComputeConfig.properties.clusterName.description" + update: "Name of the AWS EKS cluster." + + # ---- GKE COMPUTE CONFIG ---- + + - target: "$.components.schemas.GkeComputeConfig.properties.region.description" + update: "Google Cloud region or zone where the GKE cluster is located." + + - target: "$.components.schemas.GkeComputeConfig.properties.clusterName.description" + update: "Name of the Google GKE cluster." + + # ---- WORKFLOW AND TASK SCHEMAS ---- + + - target: "$.components.schemas.Task.properties.numSpotInterruptions.description" + update: "Number of spot instance interruptions encountered by this task." + + - target: "$.components.schemas.TraceProgressData.properties.numSpotInterruptions.description" + update: "Total number of spot instance interruptions across all tasks." + + - target: "$.components.schemas.WorkflowLoad.properties.numSpotInterruptions.description" + update: "Number of spot instance interruptions for the workflow." + + # ---- LIST WORKFLOWS RESPONSE ---- + + - target: "$.components.schemas.ListWorkflowsResponse.properties.hasMore.description" + update: "If true, indicates there are more results available beyond this page." + + # ---- ORGANIZATION QUOTAS ---- + + - target: "$.components.schemas.OrganizationQuotas.properties.maxCustomRolesPerOrg.description" + update: "Maximum number of custom roles allowed per organization." + + # ---- DATA STUDIO STOP REASON ---- + + - target: "$.components.schemas.DataStudioStopReason.description" + update: "Reason for Data Studio session termination. Accepts `UNKNOWN`, `USER_REQUEST`, `TIMEOUT`, `ERROR`, `RESOURCE_LIMIT`, or `NO_STATS_AVAIL`." +``` + +--- + +# Manual Field Descriptions Overlay + +## manual-field-descriptions-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Manual field descriptions overlay + version: 0.0.0 +actions: + # ===== PIPELINE SECRETS SCHEMAS ===== + + # ---- CREATE PIPELINE SECRET REQUEST ---- + + - target: "$.components.schemas.CreatePipelineSecretRequest.properties.name.description" + update: "Unique name for the pipeline secret within the workspace. Used to reference the secret in workflow configurations." + + - target: "$.components.schemas.CreatePipelineSecretRequest.properties.value.description" + update: "The secret value to be securely stored. This value will be made available to pipeline executions as an environment variable or configuration value." + + # ---- UPDATE PIPELINE SECRET REQUEST ---- + + - target: "$.components.schemas.UpdatePipelineSecretRequest.properties.value.description" + update: "New secret value to replace the existing value. The secret value is securely stored and made available to pipeline executions." + + # ===== DATASETS SCHEMAS ===== + + # ---- CREATE DATASET REQUEST ---- + + - target: "$.components.schemas.CreateDatasetRequest.properties.name.description" + update: "Unique dataset name within the workspace. Must be a valid identifier that can be referenced in workflow configurations." + + - target: "$.components.schemas.CreateDatasetRequest.properties.description.description" + update: "Optional description of the dataset. Provides context about the dataset contents, source, or intended use." + + # ---- UPDATE DATASET REQUEST ---- + + - target: "$.components.schemas.UpdateDatasetRequest.properties.name.description" + update: "New name for the dataset. Must be unique within the workspace and can be used to reference the dataset in workflow configurations." + + - target: "$.components.schemas.UpdateDatasetRequest.properties.description.description" + update: "Updated description for the dataset. Provides context about the dataset contents, source, or intended use." + + # ===== WORKSPACES SCHEMAS ===== + + # ---- UPDATE WORKSPACE REQUEST ---- + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.name.description" + update: "New short name for the workspace. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters. Must be unique within the organization." + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.fullName.description" + update: "Updated full display name for the workspace. Maximum 100 characters." + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.description.description" + update: "Updated description of the workspace. Maximum 1000 characters." + + # ===== ACTIONS SCHEMAS ===== + + # ---- UPDATE ACTION REQUEST ---- + + - target: "$.components.schemas.UpdateActionRequest.properties.name.description" + update: "New name for the pipeline action. Must be unique within the workspace." +``` + +--- + +# Fix Duplicate Required Fields Overlay + +## fix-duplicate-required-fields-overlay-1.102.0.yaml + +**CRITICAL**: This overlay fixes duplicate required fields in compute config schemas using the "remove first, then update" pattern. + +```yaml +overlay: 1.0.0 +info: + title: Fix duplicate required fields overlay + version: 1.102.0 +actions: + # ===== FIX DUPLICATE REQUIRED FIELDS ===== + + # These duplicate required fields exist in the base spec + # We use the "remove first, then update" pattern to fix them + + # ---- AwsBatchConfig ---- + + - target: "$.components.schemas.AwsBatchConfig.required" + remove: true + + - target: "$.components.schemas.AwsBatchConfig" + update: + required: ["region", "workDir"] + + # ---- AwsCloudConfig ---- + + - target: "$.components.schemas.AwsCloudConfig.required" + remove: true + + - target: "$.components.schemas.AwsCloudConfig" + update: + required: ["region", "workDir"] + + # ---- AzBatchConfig ---- + + - target: "$.components.schemas.AzBatchConfig.required" + remove: true + + - target: "$.components.schemas.AzBatchConfig" + update: + required: ["region", "workDir"] + + # ---- AzCloudConfig ---- + + - target: "$.components.schemas.AzCloudConfig.required" + remove: true + + - target: "$.components.schemas.AzCloudConfig" + update: + required: ["location", "workDir"] + + # ---- ConfigEnvVariable ---- + + - target: "$.components.schemas.ConfigEnvVariable.required" + remove: true + + - target: "$.components.schemas.ConfigEnvVariable" + update: + required: ["name", "value"] + + # ---- CreateComputeEnvRequest ---- + + - target: "$.components.schemas.CreateComputeEnvRequest.required" + remove: true + + - target: "$.components.schemas.CreateComputeEnvRequest" + update: + required: ["computeEnv"] + + # ---- GkeComputeConfig ---- + + - target: "$.components.schemas.GkeComputeConfig.required" + remove: true + + - target: "$.components.schemas.GkeComputeConfig" + update: + required: ["region", "clusterName", "workDir"] + + # ---- GoogleBatchConfig ---- + + - target: "$.components.schemas.GoogleBatchConfig.required" + remove: true + + - target: "$.components.schemas.GoogleBatchConfig" + update: + required: ["location", "workDir"] + + # ---- GoogleCloudConfig ---- + + - target: "$.components.schemas.GoogleCloudConfig.required" + remove: true + + - target: "$.components.schemas.GoogleCloudConfig" + update: + required: ["region", "workDir"] + + # ---- K8sComputeConfig ---- + + - target: "$.components.schemas.K8sComputeConfig.required" + remove: true + + - target: "$.components.schemas.K8sComputeConfig" + update: + required: ["server", "sslCert", "workDir"] + + # ---- SeqeraComputeConfig ---- + + - target: "$.components.schemas.SeqeraComputeConfig.required" + remove: true + + - target: "$.components.schemas.SeqeraComputeConfig" + update: + required: ["region", "workDir"] + + # ---- ComputeEnv_ComputeConfig_ ---- + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.required" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_" + update: + required: ["config", "name", "platform"] + + # ---- EksComputeConfig ---- + + - target: "$.components.schemas.EksComputeConfig.required" + remove: true + + - target: "$.components.schemas.EksComputeConfig" + update: + required: ["region", "clusterName", "workDir"] +``` + +--- + +# Fix Duplicate Enum Values Overlay + +## fix-duplicate-enums-overlay-1.102.0.yaml + +**CRITICAL**: This overlay fixes duplicate enum values in query parameters and schemas using the "remove first, then update" pattern. + +```yaml +overlay: 1.0.0 +info: + title: Fix duplicate enum values overlay + version: 1.102.0 +actions: + # ===== FIX DUPLICATE ENUM VALUES ===== + + # These duplicate enum values exist in the base decorated spec + # We use the "remove first, then update" pattern to fix them + + # ---- Query Parameter: Status (line 563) ---- + + - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')].schema.enum" + remove: true + + - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')].schema" + update: + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] + + # ---- Query Parameter: Attributes (line 809) ---- + + - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')].schema.items.enum" + remove: true + + - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')].schema.items" + update: + enum: ["labels"] + + # ---- AzBatchConfig.deleteJobsOnCompletion (line 8891) ---- + + - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion.enum" + remove: true + + - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion" + update: + enum: ["on_success", "always", "never"] + + # ---- ComputeEnv_ComputeConfig_.platform (lines 9283-9331) ---- + # This has extensive triplication of values + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform.enum" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform" + update: + enum: + - "aws-batch" + - "aws-cloud" + - "google-batch" + - "google-cloud" + - "azure-batch" + - "azure-cloud" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" + - "moab-platform" + - "local-platform" + - "seqeracompute-platform" + + # ---- ComputeEnv_ComputeConfig_.status (line 9361) ---- + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status.enum" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status" + update: + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] + + # ---- K8sComputeConfig.podCleanup (line 11444) ---- + + - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup.enum" + remove: true + + - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup" + update: + enum: ["on_success", "always", "never"] +``` + +--- + +# Remove Google Life Sciences Platform + +## remove-google-lifesciences-overlay-1.102.0.yaml + +**CRITICAL**: This overlay removes the deprecated google-lifesciences platform option from the API spec entirely. + +```yaml +overlay: 1.0.0 +info: + title: Remove Google Life Sciences platform overlay + version: 1.102.0 +actions: + # ===== REMOVE GOOGLE LIFE SCIENCES PLATFORM ===== + + # This platform option is deprecated and should be removed from the API spec + + # ---- Remove from ComputeEnvResponseDto.platform enum (line 9198) ---- + + - target: "$.components.schemas.ComputeEnvResponseDto.properties.platform.enum" + remove: true + + - target: "$.components.schemas.ComputeEnvResponseDto.properties.platform" + update: + enum: + - "aws-batch" + - "aws-cloud" + - "seqeracompute-platform" + - "google-batch" + - "azure-batch" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" + + # ---- Remove from ComputeConfig discriminator mapping (line 9140) ---- + + - target: "$.components.schemas.ComputeConfig.discriminator.mapping.google-lifesciences" + remove: true + + # ---- Replace ComputeConfig oneOf array without GoogleLifeSciencesConfig ---- + + # CRITICAL: Remove entire oneOf array first to prevent duplicates + - target: "$.components.schemas.ComputeConfig.oneOf" + remove: true + + # Replace with correct array (no GoogleLifeSciencesConfig, no duplicates) + - target: "$.components.schemas.ComputeConfig" + update: + oneOf: + - $ref: "#/components/schemas/AwsBatchConfig" + - $ref: "#/components/schemas/AwsCloudConfig" + - $ref: "#/components/schemas/SeqeraComputeConfig" + - $ref: "#/components/schemas/GoogleBatchConfig" + - $ref: "#/components/schemas/GoogleCloudConfig" + - $ref: "#/components/schemas/AzBatchConfig" + - $ref: "#/components/schemas/AzCloudConfig" + - $ref: "#/components/schemas/LsfComputeConfig" + - $ref: "#/components/schemas/SlurmComputeConfig" + - $ref: "#/components/schemas/K8sComputeConfig" + - $ref: "#/components/schemas/EksComputeConfig" + - $ref: "#/components/schemas/GkeComputeConfig" + - $ref: "#/components/schemas/UnivaComputeConfig" + - $ref: "#/components/schemas/AltairPbsComputeConfig" + - $ref: "#/components/schemas/MoabComputeConfig" + - $ref: "#/components/schemas/LocalComputeConfig" + + # ---- Remove GoogleLifeSciencesConfig schema definition (line 11229+) ---- + + - target: "$.components.schemas.GoogleLifeSciencesConfig" + remove: true +``` + +--- + +# Add Identities Tag Overlay + +## add-identities-tag-overlay-1.102.0.yaml + +```yaml +overlay: 1.0.0 +info: + title: Add identities tag to global tags + version: 1.102.0 +actions: + # ===== ADD MISSING IDENTITIES TAG ===== + + # CRITICAL: Remove entire tags array first to prevent duplicates + - target: "$.tags" + remove: true + + # Replace with complete array including identities tag + - target: "$" + update: + tags: + - name: actions + description: Pipeline actions + - name: avatars + description: Avatars + - name: compute-envs + description: Compute environments + - name: credentials + description: Credentials + - name: data-links + description: Cloud storage directory paths in Data Explorer + - name: datasets + description: Pipeline input datasets (samplesheets) in CSV or TSV format + - name: ga4gh + description: GA4GH workflow execution service runs + - name: identities + description: Managed identities for centralized credential management + - name: labels + description: Labels and resource labels + - name: launch + description: Workflow launch events + - name: orgs + description: Organizations + - name: pipelines + description: Pipelines + - name: pipeline-secrets + description: Pipeline secrets in a user or workspace context + - name: platforms + description: Computing platforms + - name: service-info + description: Seqera Platform API service information + - name: studios + description: Studios and Studio sessions + - name: teams + description: Teams in an organization context + - name: tokens + description: API access tokens + - name: trace + description: Workflow execution traces + - name: users + description: Users + - name: workflows + description: Workflow executions + - name: workspaces + description: Workspaces in an organization context +``` + +--- + +This completes all the overlay files for version 1.102.0. The overlays are organized by controller/feature and follow all the standards exactly as specified in your style guide. diff --git a/platform-api-docs/scripts/overlay_archives/compute-envs-operations-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/compute-envs-operations-overlay-1.102.0.yaml new file mode 100644 index 000000000..4564d0e28 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/compute-envs-operations-overlay-1.102.0.yaml @@ -0,0 +1,22 @@ +overlay: 1.0.0 +info: + title: Compute environments operations overlay + version: 0.0.0 +actions: + # ===== COMPUTE ENVIRONMENTS - OPERATIONS ===== + + # ---- DISABLE COMPUTE ENVIRONMENT ---- + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.summary" + update: "Disable compute environment" + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.description" + update: "Disables the compute environment identified by the given `computeEnvId`. A disabled compute environment cannot be used to launch new workflows or Studio sessions. If the compute environment is primary, it will be automatically unset as primary. See [Disable compute environment](https://docs.seqera.io/platform-cloud/compute-envs/overview#disable-compute-environment)" + + # ---- ENABLE COMPUTE ENVIRONMENT ---- + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.summary" + update: "Enable compute environment" + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.description" + update: "Enables the compute environment identified by the given `computeEnvId`. An enabled compute environment can be used to launch new workflows and Studio sessions." diff --git a/platform-api-docs/scripts/overlay_archives/compute-envs-parameters-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/compute-envs-parameters-overlay-1.102.0.yaml new file mode 100644 index 000000000..2cee1d9b1 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/compute-envs-parameters-overlay-1.102.0.yaml @@ -0,0 +1,28 @@ +overlay: 1.0.0 +info: + title: Compute environments parameters overlay + version: 0.0.0 +actions: + # ===== COMPUTE ENVIRONMENTS PARAMETERS - PATH, QUERY, AND REQUEST BODY ===== + + # ---- DISABLE COMPUTE ENVIRONMENT PARAMETERS ---- + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.parameters[?(@.name=='computeEnvId')].description" + update: "Compute environment string identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.parameters[?(@.name=='workspaceId')].description" + update: "Workspace numeric identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/disable.post.requestBody.description" + update: "Compute environment disable request" + + # ---- ENABLE COMPUTE ENVIRONMENT PARAMETERS ---- + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.parameters[?(@.name=='computeEnvId')].description" + update: "Compute environment string identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.parameters[?(@.name=='workspaceId')].description" + update: "Workspace numeric identifier." + + - target: "$.paths./compute-envs/{computeEnvId}/enable.post.requestBody.description" + update: "Compute environment enable request" diff --git a/platform-api-docs/scripts/overlay_archives/compute-envs-schemas-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/compute-envs-schemas-overlay-1.102.0.yaml new file mode 100644 index 000000000..c2221dbe9 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/compute-envs-schemas-overlay-1.102.0.yaml @@ -0,0 +1,14 @@ +overlay: 1.0.0 +info: + title: Compute environments schemas overlay + version: 0.0.0 +actions: + # ===== COMPUTE ENVIRONMENTS SCHEMAS - REQUEST/RESPONSE OBJECTS ===== + + # ---- COMPUTE ENVIRONMENT STATUS ENUM ---- + + - target: "$.components.schemas.ComputeEnv.Status" + update: + type: string + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "DISABLED"] + description: "Compute environment status. Accepts `CREATING`, `AVAILABLE`, `ERRORED`, `INVALID`, or `DISABLED`." diff --git a/platform-api-docs/scripts/overlay_archives/data-links-operations-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/data-links-operations-overlay-1.102.0.yaml new file mode 100644 index 000000000..dcf131d89 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/data-links-operations-overlay-1.102.0.yaml @@ -0,0 +1,102 @@ +actions: + # ===== DATA-LINKS - OPERATIONS ===== + + # Update existing operations + + - target: "$.paths./data-links/{dataLinkId}/browse.get.summary" + update: "Explore data-link" + + - target: "$.paths./data-links/{dataLinkId}/browse.get.description" + update: "Retrieves the content of the data-link associated with the given `dataLinkId`." + + - target: "$.paths./data-links/{dataLinkId}/browse/{path}.get.operationId" + update: "ExploreDataLinkWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload.post.summary" + update: "Generate data-link file upload URL" + + - target: "$.paths./data-links/{dataLinkId}/upload.post.description" + update: "Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint." + + - target: "$.paths./data-links/{dataLinkId}/upload/{dirPath}.post.operationId" + update: "GenerateDataLinkUploadUrlWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.summary" + update: "Finish data-link file upload" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.description" + update: "Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." + + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.responses['404'].description" + update: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found." + + - target: "$.paths./data-links/{dataLinkId}/upload/finish/{dirPath}.post.operationId" + update: "FinishDataLinkUploadWithPath" + + - target: "$.paths./data-links/{dataLinkId}/upload/finish/{dirPath}.post.responses['200'].description" + update: "FinishDataLinkUploadWithPath 200 response." + + # New endpoint in v1.102.0 + + - target: "$.paths" + update: + /data-links/{dataLinkId}/download/{filePath}: + get: + tags: + - data-links + summary: "Download data-link file at path" + description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`." + operationId: DownloadDataLink + parameters: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: filePath + in: path + description: "Resource path of the file to download." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + responses: + "200": + description: "OK." + content: + application/json: + schema: + type: string + format: binary + "400": + description: "Bad request." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: "Operation not allowed." + security: + - BearerAuth: [] + + # Remove deprecated endpoint + + - target: "$.paths./data-links/{dataLinkId}/download" + remove: true diff --git a/platform-api-docs/scripts/overlay_archives/data-links-parameters-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/data-links-parameters-overlay-1.102.0.yaml new file mode 100644 index 000000000..bf97eeb56 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/data-links-parameters-overlay-1.102.0.yaml @@ -0,0 +1,108 @@ +overlay: 1.0.0 +info: + title: Data-links parameters overlay + version: 1.102.0 +actions: + # ===== DATA-LINKS PARAMETERS ===== + + # ---- /data-links/{dataLinkId}/browse GET ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/browse.get.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: search + in: query + description: "Prefix search of data-link content." + schema: + type: string + - name: nextPageToken + in: query + description: "Token used to fetch the next page of items." + schema: + type: string + - name: pageSize + in: query + description: "Number of items to return per page. If omitted, a default maximum value is returned." + schema: + type: integer + format: int32 + + # ---- /data-links/{dataLinkId}/upload POST ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/upload.post.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/upload.post.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + - name: Origin + in: header + schema: + type: string + nullable: true + + # ---- /data-links/{dataLinkId}/upload/finish POST ---- + + # CRITICAL: Remove entire parameters array to prevent duplicates + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.parameters[*]" + remove: true + + # Replace with complete array with enriched descriptions + - target: "$.paths./data-links/{dataLinkId}/upload/finish.post.parameters" + update: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 diff --git a/platform-api-docs/scripts/overlay_archives/fix-duplicate-enums-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/fix-duplicate-enums-overlay-1.102.0.yaml new file mode 100644 index 000000000..25ce7a03b --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/fix-duplicate-enums-overlay-1.102.0.yaml @@ -0,0 +1,80 @@ +overlay: 1.0.0 +info: + title: Fix duplicate enum values overlay + version: 1.102.0 +actions: + # ===== FIX DUPLICATE ENUM VALUES ===== + + # These duplicate enum values exist in the base decorated spec + # We use the "remove first, then update" pattern to fix them + + # ---- Query Parameter: Status (line 563) ---- + + - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')].schema.enum" + remove: true + + - target: "$.paths./compute-envs.get.parameters[?(@.name=='status')].schema" + update: + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] + + # ---- Query Parameter: Attributes (line 809) ---- + + - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')].schema.items.enum" + remove: true + + - target: "$.paths./compute-envs/{computeEnvId}.get.parameters[?(@.name=='attributes')].schema.items" + update: + enum: ["labels"] + + # ---- AzBatchConfig.deleteJobsOnCompletion (line 8891) ---- + + - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion.enum" + remove: true + + - target: "$.components.schemas.AzBatchConfig.properties.deleteJobsOnCompletion" + update: + enum: ["on_success", "always", "never"] + + # ---- ComputeEnv_ComputeConfig_.platform (lines 9283-9331) ---- + # This has extensive triplication of values + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform.enum" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.platform" + update: + enum: + - "aws-batch" + - "aws-cloud" + - "google-batch" + - "google-cloud" + - "azure-batch" + - "azure-cloud" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" + - "moab-platform" + - "local-platform" + - "seqeracompute-platform" + + # ---- ComputeEnv_ComputeConfig_.status (line 9361) ---- + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status.enum" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.properties.status" + update: + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] + + # ---- K8sComputeConfig.podCleanup (line 11444) ---- + + - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup.enum" + remove: true + + - target: "$.components.schemas.K8sComputeConfig.properties.podCleanup" + update: + enum: ["on_success", "always", "never"] diff --git a/platform-api-docs/scripts/overlay_archives/fix-duplicate-required-fields-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/fix-duplicate-required-fields-overlay-1.102.0.yaml new file mode 100644 index 000000000..750e910fe --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/fix-duplicate-required-fields-overlay-1.102.0.yaml @@ -0,0 +1,126 @@ +overlay: 1.0.0 +info: + title: Fix duplicate required fields overlay + version: 1.102.0 +actions: + # ===== FIX DUPLICATE REQUIRED FIELDS ===== + + # These duplicate required fields exist in the base spec + # We use the "remove first, then update" pattern to fix them + + # ---- AwsBatchConfig ---- + + - target: "$.components.schemas.AwsBatchConfig.required" + remove: true + + - target: "$.components.schemas.AwsBatchConfig" + update: + required: ["region", "workDir"] + + # ---- AwsCloudConfig ---- + + - target: "$.components.schemas.AwsCloudConfig.required" + remove: true + + - target: "$.components.schemas.AwsCloudConfig" + update: + required: ["region", "workDir"] + + # ---- AzBatchConfig ---- + + - target: "$.components.schemas.AzBatchConfig.required" + remove: true + + - target: "$.components.schemas.AzBatchConfig" + update: + required: ["region", "workDir"] + + # ---- AzCloudConfig ---- + + - target: "$.components.schemas.AzCloudConfig.required" + remove: true + + - target: "$.components.schemas.AzCloudConfig" + update: + required: ["location", "workDir"] + + # ---- ConfigEnvVariable ---- + + - target: "$.components.schemas.ConfigEnvVariable.required" + remove: true + + - target: "$.components.schemas.ConfigEnvVariable" + update: + required: ["name", "value"] + + # ---- CreateComputeEnvRequest ---- + + - target: "$.components.schemas.CreateComputeEnvRequest.required" + remove: true + + - target: "$.components.schemas.CreateComputeEnvRequest" + update: + required: ["computeEnv"] + + # ---- GkeComputeConfig ---- + + - target: "$.components.schemas.GkeComputeConfig.required" + remove: true + + - target: "$.components.schemas.GkeComputeConfig" + update: + required: ["region", "clusterName", "workDir"] + + # ---- GoogleBatchConfig ---- + + - target: "$.components.schemas.GoogleBatchConfig.required" + remove: true + + - target: "$.components.schemas.GoogleBatchConfig" + update: + required: ["location", "workDir"] + + # ---- GoogleCloudConfig ---- + + - target: "$.components.schemas.GoogleCloudConfig.required" + remove: true + + - target: "$.components.schemas.GoogleCloudConfig" + update: + required: ["region", "workDir"] + + # ---- K8sComputeConfig ---- + + - target: "$.components.schemas.K8sComputeConfig.required" + remove: true + + - target: "$.components.schemas.K8sComputeConfig" + update: + required: ["server", "sslCert", "workDir"] + + # ---- SeqeraComputeConfig ---- + + - target: "$.components.schemas.SeqeraComputeConfig.required" + remove: true + + - target: "$.components.schemas.SeqeraComputeConfig" + update: + required: ["region", "workDir"] + + # ---- ComputeEnv_ComputeConfig_ ---- + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_.required" + remove: true + + - target: "$.components.schemas.ComputeEnv_ComputeConfig_" + update: + required: ["config", "name", "platform"] + + # ---- EksComputeConfig ---- + + - target: "$.components.schemas.EksComputeConfig.required" + remove: true + + - target: "$.components.schemas.EksComputeConfig" + update: + required: ["region", "clusterName", "workDir"] diff --git a/platform-api-docs/scripts/overlay_archives/global-schemas-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/global-schemas-overlay-1.102.0.yaml new file mode 100644 index 000000000..a2e85e606 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/global-schemas-overlay-1.102.0.yaml @@ -0,0 +1,366 @@ +overlay: 1.0.0 +info: + title: Global schemas overlay + version: 0.0.0 +actions: + # ===== GLOBAL SCHEMAS - CREDENTIALS AND COMPUTE CONFIGURATIONS ===== + + # ---- GIT CREDENTIALS ---- + + - target: "$.components.schemas.GitKeys.description" + update: "Git repository credentials." + + - target: "$.components.schemas.GitKeys.properties.discriminator.description" + update: "Property to select the credentials type." + + - target: "$.components.schemas.GitKeys.properties.username.description" + update: "Git username for authentication." + + - target: "$.components.schemas.GitKeys.properties.password.description" + update: "Git password for authentication." + + - target: "$.components.schemas.GitKeys.properties.token.description" + update: "Git personal access token for authentication." + + # ---- SEQERA COMPUTE CLOUD INSTANCE TYPE SIZE ---- + + - target: "$.components.schemas.SeqeraComputeCloudInstanceTypeSize.description" + update: "Data Studios instance size. Accepts `SMALL`, `MEDIUM`, or `LARGE`." + + # ---- SEQERA COMPUTE CONFIG ---- + + - target: "$.components.schemas.SeqeraComputeConfig.properties.instanceTypeSize.description" + update: "Size of the Data Studios instance. Accepts `SMALL`, `MEDIUM`, or `LARGE`." + + # ---- ABSTRACT GRID CONFIG ---- + + - target: "$.components.schemas.AbstractGridConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.AbstractGridConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AbstractGridConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AbstractGridConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.AbstractGridConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.AbstractGridConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.AbstractGridConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.AbstractGridConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.AbstractGridConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.AbstractGridConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.AbstractGridConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.AbstractGridConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.AbstractGridConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.AbstractGridConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.AbstractGridConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- LSF COMPUTE CONFIG ---- + + - target: "$.components.schemas.LsfComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.LsfComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.LsfComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.LsfComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.LsfComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.LsfComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.LsfComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.LsfComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.LsfComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.LsfComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.LsfComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.LsfComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.LsfComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.LsfComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.LsfComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + - target: "$.components.schemas.LsfComputeConfig.properties.unitForLimits.description" + update: "Unit for memory and time limits in LSF." + + - target: "$.components.schemas.LsfComputeConfig.properties.perJobMemLimit.description" + update: "If true, applies memory limit per job. Default: `false`." + + - target: "$.components.schemas.LsfComputeConfig.properties.perTaskReserve.description" + update: "If true, reserves resources per task. Default: `false`." + + # ---- SLURM COMPUTE CONFIG ---- + + - target: "$.components.schemas.SlurmComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.SlurmComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.SlurmComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.SlurmComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.SlurmComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.SlurmComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.SlurmComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.SlurmComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.SlurmComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.SlurmComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.SlurmComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.SlurmComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.SlurmComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.SlurmComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.SlurmComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- ALTAIR PBS COMPUTE CONFIG ---- + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.AltairPbsComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- MOAB COMPUTE CONFIG ---- + + - target: "$.components.schemas.MoabComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.MoabComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.MoabComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.MoabComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.MoabComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.MoabComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.MoabComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.MoabComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.MoabComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.MoabComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.MoabComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.MoabComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.MoabComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.MoabComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.MoabComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- UNIVA COMPUTE CONFIG ---- + + - target: "$.components.schemas.UnivaComputeConfig.properties.workDir.description" + update: "Compute environment working directory." + + - target: "$.components.schemas.UnivaComputeConfig.properties.preRunScript.description" + update: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.UnivaComputeConfig.properties.postRunScript.description" + update: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + + - target: "$.components.schemas.UnivaComputeConfig.properties.environment.description" + update: "Array of environment variables for the compute environment." + + - target: "$.components.schemas.UnivaComputeConfig.properties.nextflowConfig.description" + update: "Additional Nextflow configuration content." + + - target: "$.components.schemas.UnivaComputeConfig.properties.discriminator.description" + update: "Property to select the compute config platform." + + - target: "$.components.schemas.UnivaComputeConfig.properties.launchDir.description" + update: "Launch directory for Nextflow execution." + + - target: "$.components.schemas.UnivaComputeConfig.properties.userName.description" + update: "Username for SSH authentication to the HPC cluster." + + - target: "$.components.schemas.UnivaComputeConfig.properties.hostName.description" + update: "Hostname or IP address of the HPC cluster head node." + + - target: "$.components.schemas.UnivaComputeConfig.properties.port.description" + update: "SSH port for connecting to the HPC cluster. Default: `22`." + + - target: "$.components.schemas.UnivaComputeConfig.properties.headQueue.description" + update: "Queue name for submitting the Nextflow head job." + + - target: "$.components.schemas.UnivaComputeConfig.properties.computeQueue.description" + update: "Queue name for submitting Nextflow compute jobs." + + - target: "$.components.schemas.UnivaComputeConfig.properties.maxQueueSize.description" + update: "Maximum number of jobs that can be queued at one time." + + - target: "$.components.schemas.UnivaComputeConfig.properties.headJobOptions.description" + update: "Additional options for the head job submission." + + - target: "$.components.schemas.UnivaComputeConfig.properties.propagateHeadJobOptions.description" + update: "If true, head job options are propagated to compute jobs. Default: `false`." + + # ---- EKS COMPUTE CONFIG ---- + + - target: "$.components.schemas.EksComputeConfig.properties.region.description" + update: "AWS region where the EKS cluster is located." + + - target: "$.components.schemas.EksComputeConfig.properties.clusterName.description" + update: "Name of the AWS EKS cluster." + + # ---- GKE COMPUTE CONFIG ---- + + - target: "$.components.schemas.GkeComputeConfig.properties.region.description" + update: "Google Cloud region or zone where the GKE cluster is located." + + - target: "$.components.schemas.GkeComputeConfig.properties.clusterName.description" + update: "Name of the Google GKE cluster." + + # ---- WORKFLOW AND TASK SCHEMAS ---- + + - target: "$.components.schemas.Task.properties.numSpotInterruptions.description" + update: "Number of spot instance interruptions encountered by this task." + + - target: "$.components.schemas.TraceProgressData.properties.numSpotInterruptions.description" + update: "Total number of spot instance interruptions across all tasks." + + - target: "$.components.schemas.WorkflowLoad.properties.numSpotInterruptions.description" + update: "Number of spot instance interruptions for the workflow." + + # ---- LIST WORKFLOWS RESPONSE ---- + + - target: "$.components.schemas.ListWorkflowsResponse.properties.hasMore.description" + update: "If true, indicates there are more results available beyond this page." + + # ---- ORGANIZATION QUOTAS ---- + + - target: "$.components.schemas.OrganizationQuotas.properties.maxCustomRolesPerOrg.description" + update: "Maximum number of custom roles allowed per organization." + + # ---- DATA STUDIO STOP REASON ---- + + - target: "$.components.schemas.DataStudioStopReason.description" + update: "Reason for Data Studio session termination. Accepts `UNKNOWN`, `USER_REQUEST`, `TIMEOUT`, `ERROR`, `RESOURCE_LIMIT`, or `NO_STATS_AVAIL`." diff --git a/platform-api-docs/scripts/overlay_archives/manual-field-descriptions-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/manual-field-descriptions-overlay-1.102.0.yaml new file mode 100644 index 000000000..35cce6098 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/manual-field-descriptions-overlay-1.102.0.yaml @@ -0,0 +1,57 @@ +overlay: 1.0.0 +info: + title: Manual field descriptions overlay + version: 0.0.0 +actions: + # ===== PIPELINE SECRETS SCHEMAS ===== + + # ---- CREATE PIPELINE SECRET REQUEST ---- + + - target: "$.components.schemas.CreatePipelineSecretRequest.properties.name.description" + update: "Unique name for the pipeline secret within the workspace. Used to reference the secret in workflow configurations." + + - target: "$.components.schemas.CreatePipelineSecretRequest.properties.value.description" + update: "The secret value to be securely stored. This value will be made available to pipeline executions as an environment variable or configuration value." + + # ---- UPDATE PIPELINE SECRET REQUEST ---- + + - target: "$.components.schemas.UpdatePipelineSecretRequest.properties.value.description" + update: "New secret value to replace the existing value. The secret value is securely stored and made available to pipeline executions." + + # ===== DATASETS SCHEMAS ===== + + # ---- CREATE DATASET REQUEST ---- + + - target: "$.components.schemas.CreateDatasetRequest.properties.name.description" + update: "Unique dataset name within the workspace. Must be a valid identifier that can be referenced in workflow configurations." + + - target: "$.components.schemas.CreateDatasetRequest.properties.description.description" + update: "Optional description of the dataset. Provides context about the dataset contents, source, or intended use." + + # ---- UPDATE DATASET REQUEST ---- + + - target: "$.components.schemas.UpdateDatasetRequest.properties.name.description" + update: "New name for the dataset. Must be unique within the workspace and can be used to reference the dataset in workflow configurations." + + - target: "$.components.schemas.UpdateDatasetRequest.properties.description.description" + update: "Updated description for the dataset. Provides context about the dataset contents, source, or intended use." + + # ===== WORKSPACES SCHEMAS ===== + + # ---- UPDATE WORKSPACE REQUEST ---- + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.name.description" + update: "New short name for the workspace. Must be 2-40 characters, start and end with alphanumeric characters, and can contain hyphens or underscores between characters. Must be unique within the organization." + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.fullName.description" + update: "Updated full display name for the workspace. Maximum 100 characters." + + - target: "$.components.schemas.UpdateWorkspaceRequest.properties.description.description" + update: "Updated description of the workspace. Maximum 1000 characters." + + # ===== ACTIONS SCHEMAS ===== + + # ---- UPDATE ACTION REQUEST ---- + + - target: "$.components.schemas.UpdateActionRequest.properties.name.description" + update: "New name for the pipeline action. Must be unique within the workspace." diff --git a/platform-api-docs/scripts/overlay_archives/remove-google-lifesciences-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/remove-google-lifesciences-overlay-1.102.0.yaml new file mode 100644 index 000000000..3c30a52fa --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/remove-google-lifesciences-overlay-1.102.0.yaml @@ -0,0 +1,66 @@ +overlay: 1.0.0 +info: + title: Remove Google Life Sciences platform overlay + version: 1.102.0 +actions: + # ===== REMOVE GOOGLE LIFE SCIENCES PLATFORM ===== + + # This platform option is deprecated and should be removed from the API spec + + # ---- Remove from ComputeEnvResponseDto.platform enum (line 9198) ---- + + - target: "$.components.schemas.ComputeEnvResponseDto.properties.platform.enum" + remove: true + + - target: "$.components.schemas.ComputeEnvResponseDto.properties.platform" + update: + enum: + - "aws-batch" + - "aws-cloud" + - "seqeracompute-platform" + - "google-batch" + - "azure-batch" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" + + # ---- Remove from ComputeConfig discriminator mapping (line 9140) ---- + + - target: "$.components.schemas.ComputeConfig.discriminator.mapping.google-lifesciences" + remove: true + + # ---- Replace ComputeConfig oneOf array without GoogleLifeSciencesConfig ---- + + # CRITICAL: Remove entire oneOf array first to prevent duplicates + - target: "$.components.schemas.ComputeConfig.oneOf" + remove: true + + # Replace with correct array (no GoogleLifeSciencesConfig, no duplicates) + - target: "$.components.schemas.ComputeConfig" + update: + oneOf: + - $ref: "#/components/schemas/AwsBatchConfig" + - $ref: "#/components/schemas/AwsCloudConfig" + - $ref: "#/components/schemas/SeqeraComputeConfig" + - $ref: "#/components/schemas/GoogleBatchConfig" + - $ref: "#/components/schemas/GoogleCloudConfig" + - $ref: "#/components/schemas/AzBatchConfig" + - $ref: "#/components/schemas/AzCloudConfig" + - $ref: "#/components/schemas/LsfComputeConfig" + - $ref: "#/components/schemas/SlurmComputeConfig" + - $ref: "#/components/schemas/K8sComputeConfig" + - $ref: "#/components/schemas/EksComputeConfig" + - $ref: "#/components/schemas/GkeComputeConfig" + - $ref: "#/components/schemas/UnivaComputeConfig" + - $ref: "#/components/schemas/AltairPbsComputeConfig" + - $ref: "#/components/schemas/MoabComputeConfig" + - $ref: "#/components/schemas/LocalComputeConfig" + + # ---- Remove GoogleLifeSciencesConfig schema definition (line 11229+) ---- + + - target: "$.components.schemas.GoogleLifeSciencesConfig" + remove: true diff --git a/platform-api-docs/scripts/overlay_archives/workflows-operations-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/workflows-operations-overlay-1.102.0.yaml new file mode 100644 index 000000000..b2e0a090e --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/workflows-operations-overlay-1.102.0.yaml @@ -0,0 +1,14 @@ +overlay: 1.0.0 +info: + title: Workflows operations overlay + version: 0.0.0 +actions: + # ===== WORKFLOWS - OPERATIONS ===== + + # ---- LAUNCH WORKFLOW ---- + + - target: "$.paths./workflow/launch.post.description" + update: | + Submits a workflow execution. + + **To [resume](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run) a workflow**: First, retrieve the launch configuration using [`GET /workflow/{workflowId}/launch`](https://docs.seqera.io/platform-api/describe-workflow-launch). Then modify the response by setting `workDir` to the value from `resumeDir`, `revision` to the value from `resumeCommitId`, and `resume` to `true`. Submit the modified payload to this endpoint to resume the workflow. diff --git a/platform-api-docs/scripts/overlay_archives/workflows-parameters-overlay-1.102.0.yaml b/platform-api-docs/scripts/overlay_archives/workflows-parameters-overlay-1.102.0.yaml new file mode 100644 index 000000000..9c238b8c9 --- /dev/null +++ b/platform-api-docs/scripts/overlay_archives/workflows-parameters-overlay-1.102.0.yaml @@ -0,0 +1,11 @@ +overlay: 1.0.0 +info: + title: Workflows parameters overlay + version: 0.0.0 +actions: + # ===== WORKFLOWS PARAMETERS - QUERY PARAMETERS ===== + + # ---- LIST WORKFLOWS PARAMETERS ---- + + - target: "$.paths./workflow.get.parameters[?(@.name=='includeTotalSize')].description" + update: "If true, includes total result count in the response. Default: `false`." diff --git a/platform-api-docs/scripts/specs/progress.md b/platform-api-docs/scripts/specs/progress.md new file mode 100644 index 000000000..c2b8a506a --- /dev/null +++ b/platform-api-docs/scripts/specs/progress.md @@ -0,0 +1,1029 @@ +# API Docs v1.102.0 Overlay Workflow Troubleshooting Progress + +## Context + +Working on PR for API docs v1.102.0 updates. The workflow `apply-overlays-and-regenerate.yml` is triggered by adding the `overlays-approved` label to a PR. It should: +1. Extract overlay files from `claude-generated-overlays.md` +2. Consolidate them into one overlay file +3. Apply to `seqera-api-latest-decorated.yaml` +4. Validate and regenerate docs + +## Branch + +`api-docs-v1.102.0` + +## Files Involved + +- `.github/workflows/apply-overlays-and-regenerate.yml` - Main workflow +- `platform-api-docs/scripts/specs/claude-generated-overlays.md` - Source of truth for overlays +- `platform-api-docs/scripts/specs/base-1.95-to-1.102.0-changes.yaml` - Speakeasy comparison overlay +- `platform-api-docs/scripts/specs/seqera-api-latest-decorated.yaml` - Target spec file +- `.claude/skills/openapi-overlay-generator/SKILL.md` - Skill for generating overlays + +## Issues Fixed This Session + +### 1. Empty overlay file breaking workflow ✅ FIXED +**Problem**: Workflow failed with "overlay must define at least one action" +**Root cause**: `data-links-schemas-overlay-1.102.0.yaml` had empty actions list (only comments) +**Fix**: +- Removed empty overlay from `claude-generated-overlays.md` +- Updated openapi-overlay-generator skill to NEVER create empty overlay files +- Added rule in both `~/.claude/skills/openapi-overlay-generator/SKILL.md` and `.claude/skills/openapi-overlay-generator/SKILL.md` + +### 2. Workflow regex couldn't handle backticks in YAML ✅ FIXED +**Problem**: Extraction regex `[^`]+` stopped at first backtick in overlay content +**Root cause**: Overlay descriptions contain backticks like `` `computeEnvId` `` and `` `false` `` +**Fix**: Changed regex pattern from `[^`]+` to `.*?` with proper boundaries: `r'```(?:yaml|yml)\s*\n(.*?)\n```'` +**Commit**: `33aa7ca5` + +### 3. Wrong filename matching in extraction ✅ FIXED +**Problem**: Used `re.search()` which found FIRST match, not closest +**Fix**: Changed to `re.findall()` and take last match (closest to code block) +**Commit**: `33aa7ca5` + +### 4. Version detection picking up decorated spec ✅ FIXED +**Problem**: Workflow detected version as "latest-decorated" instead of "1.102.0" +**Root cause**: `ls -t` sorted by modification time, and `seqera-api-latest-decorated.yaml` was most recent +**Impact**: Consolidation looked for `*-overlay-latest-decorated.yaml` files (don't exist), created empty consolidated overlay +**Fix**: +- Only match base spec files: `seqera-api-[0-9]*.yaml` +- Sort by semantic version number instead of modification time +- Extract version from highest numbered spec +**Commit**: `a3f5828f` + +### 5. Inconsistent .yaml/.yml handling ✅ FIXED +**Problem**: Some parts of workflow used `.yml`, others used `.yaml` +**Fix**: Updated all files to handle both extensions: +- Workflow: All steps now check for both `.yaml` and `.yml` +- `extract-api-tables.mjs`: Checks for both extensions +- `docusaurus.config.js`: Updated to use `.yaml` (current file extension) +- Cleanup step: Now sorts by version, handles both extensions +**Commit**: `a3f5828f` + +### 6. Validation too verbose, exceeded log size ✅ FIXED +**Problem**: Speakeasy validation output 1262KB of INFO hints about missing examples, exceeded 1024KB GitHub limit +**Fix**: +- Capture output to file instead of dumping to logs +- Count errors/warnings/hints separately +- Only fail on actual ERROR-level issues +- Continue if only hints/warnings +**Commit**: `72febe35` + +### 7. Added debugging and artifact upload ✅ FIXED +**Problem**: Hard to diagnose failures in CI +**Fix**: +- List extracted overlay files before consolidation +- Show first 30 lines of consolidated overlay +- Count action items +- Upload all overlay files as artifacts on failure (7 day retention) +**Commits**: `c0516714`, `a3f5828f` + +## Issue #7: Validation errors on applied spec ✅ FIXED + +### Problem +After applying overlays, validation showed 4 ERROR-level issues: + +``` +ERROR: [line 1456] path-params - parameter path must be used in path /data-links/{dataLinkId}/browse +ERROR: [line 1706] path-params - parameter filePath must be used in path /data-links/{dataLinkId}/download +ERROR: [line 1884] path-params - parameter dirPath must be used in path /data-links/{dataLinkId}/upload +ERROR: [line 1950] path-params - parameter dirPath must be used in path /data-links/{dataLinkId}/upload/finish +``` + +### Root Cause +The `base-1.95-to-1.102.0-changes.yaml` file contains `remove: true` actions that delete the entire parameters array before replacing it, but the `claude-generated-overlays.md` file only contained description updates - NOT the parameter removal/replacement actions. This caused duplicate parameters with validation errors. + +### Fix +1. **Updated both SKILL.md files** (in repo and ~/.claude/skills) with critical instructions: + - Added "Preserve ALL Actions from Comparison Overlay" section + - Added "Parameter Array Replacement Pattern" section with examples + - Added to "Common Mistakes to Avoid" list + - Emphasized that EVERY action in comparison overlay must have AT LEAST one corresponding action in generated overlays + +2. **Regenerated all overlay files** with proper removal actions: + - `compute-envs-operations-overlay-1.102.0.yaml` - New enable/disable endpoints + - `data-links-operations-overlay-1.102.0.yaml` - Operations updates + - `data-links-parameters-overlay-1.102.0.yaml` - **WITH 3 critical parameter array removals** + - `workflow-parameters-overlay-1.102.0.yaml` - New parameter + - `compute-config-schemas-overlay-1.102.0.yaml` - Compute config schemas + - `misc-schemas-overlay-1.102.0.yaml` - Misc schemas + +3. **Updated claude-generated-overlays.md** with corrected overlays + +4. **Verified locally**: + - Extracted overlays from markdown + - Consolidated into `all-changes-overlay-1.102.0.yaml` (158 actions) + - Applied to `seqera-api-latest-decorated.yaml` + - Validated result: **0 ERROR-level issues** ✅ + +### Key Learning +When the comparison overlay shows a `remove: true` followed by a parameter array `update`, BOTH actions must be preserved in the generated overlay: + +```yaml +# Remove entire array first +- target: "$.paths./data-links/{dataLinkId}/browse.get.parameters[*]" + remove: true + +# Then replace with new array +- target: "$.paths./data-links/{dataLinkId}/browse.get.parameters" + update: + - name: dataLinkId + # ... complete parameter definitions +``` + +## Next Steps + +1. Commit all changes (overlay files, claude-generated-overlays.md, both SKILL.md files) +2. Push to branch +3. Re-run workflow with `overlays-approved` label + +## Workflow Invocation + +The workflow can be triggered via `workflow_dispatch`: +1. Go to GitHub Actions → "Apply Overlays and Regenerate Docs" +2. Click "Run workflow" +3. **Select branch**: `api-docs-v1.102.0` (important! uses workflow from this branch) +4. Enter PR number +5. Click "Run workflow" + +## Local Testing Commands + +```bash +cd /Users/llewelyn-van-der-berg/Documents/GitHub/docs/platform-api-docs/scripts/specs + +# Extract overlays from markdown +python3 - <<'PYTHON_SCRIPT' +import re +from pathlib import Path + +md_file = Path("claude-generated-overlays.md") +content = md_file.read_text() + +pattern = r'```(?:yaml|yml)\s*\n(.*?)\n```' +filename_pattern = r'(?:^|\n)(?:#+\s*)?(?:\*\*)?([a-zA-Z0-9_-]+-overlay-[0-9.]+\.ya?ml)(?:\*\*)?' + +blocks = re.finditer(pattern, content, re.MULTILINE | re.DOTALL) +extracted_count = 0 +current_pos = 0 + +for block in blocks: + yaml_content = block.group(1).strip() + text_before = content[current_pos:block.start()] + filename_matches = re.findall(filename_pattern, text_before, re.MULTILINE | re.IGNORECASE) + + if filename_matches: + filename = filename_matches[-1] + filename = re.sub(r'\.yml$', '.yaml', filename) + Path(filename).write_text(yaml_content + '\n') + print(f"✅ Extracted: {filename}") + extracted_count += 1 + current_pos = block.end() + +print(f"\n✅ Successfully extracted {extracted_count} overlay file(s)") +PYTHON_SCRIPT + +# Consolidate overlays +cat > all-changes-overlay-1.102.0.yaml <<'EOF' +overlay: 1.0.0 +info: + title: Consolidated overlay for v1.102.0 + version: 0.0.0 +actions: +EOF + +echo " # ===== VERSION 1.102.0 OVERLAYS =====" >> all-changes-overlay-1.102.0.yaml + +for overlay in *-overlay-1.102.0.yaml; do + if [ -f "$overlay" ] && [ "$overlay" != "all-changes-overlay-1.102.0.yaml" ]; then + echo "Adding $overlay" + sed -n '/^actions:/,$ p' "$overlay" | tail -n +2 >> all-changes-overlay-1.102.0.yaml + fi +done + +# Apply overlay +speakeasy overlay apply \ + -s seqera-api-latest-decorated.yaml \ + -o all-changes-overlay-1.102.0.yaml \ + > seqera-api-latest-decorated-new-test.yaml + +# Validate +speakeasy validate openapi -s seqera-api-latest-decorated-new-test.yaml > validation-output.txt 2>&1 + +ERROR_COUNT=$(grep -c "ERROR" validation-output.txt 2>/dev/null || echo "0") +echo "Errors: $ERROR_COUNT" + +if [ "$ERROR_COUNT" -gt 0 ]; then + grep "ERROR" validation-output.txt | head -20 +fi +``` + +## Key Commits + +- `33aa7ca5` - Fix overlay extraction regex to handle backticks +- `c6062bb2` - Update openapi-overlay-generator skill and remove empty overlay +- `a3f5828f` - Support both .yaml and .yml extensions throughout entire workflow +- `72febe35` - Make validation less verbose and more lenient +- `c0516714` - Add debugging output and artifact upload on failure +- `9893a0d2` - Add troubleshooting progress document (this file) +- (pending) - Add parameter array removal instructions to SKILL.md files +- (pending) - Regenerate all v1.102.0 overlays with proper removal actions + +## Skills Updated + +Both copies of the openapi-overlay-generator skill were updated: +- `~/.claude/skills/openapi-overlay-generator/SKILL.md` +- `.claude/skills/openapi-overlay-generator/SKILL.md` (in repo) + +Added critical rules: +- NEVER create overlay files with empty actions lists +- Empty overlays break workflow automation + +## Final Validation - All Errors Fixed! ✅ + +**Date**: 2026-01-20 +**Status**: SUCCESS - 0 validation errors + +### Process Summary + +1. **Extracted 10 overlays** from claude-generated-overlays.md +2. **Consolidated** into single overlay (177 actions) +3. **Applied** to decorated spec +4. **Validated**: 0 ERROR-level issues ✅ + +### All Fixes Applied + +#### Fix #1: Parameter Duplicate Errors (4 → 0) ✅ +- **File**: `data-links-parameters-overlay-1.102.0.yaml` +- **Pattern**: Remove entire parameters array, then replace with enriched descriptions +- **Actions**: 3 removal + 3 replacement pairs + +#### Fix #2: Deprecated Endpoint Removal (1 → 0) ✅ +- **File**: `data-links-operations-overlay-1.102.0.yaml` +- **Action**: `remove: true` on `/data-links/{dataLinkId}/download` + +#### Fix #3: Duplicate Required Fields (12 → 0) ✅ +- **File**: `fix-duplicate-required-fields-overlay-1.102.0.yaml` +- **Pattern**: Remove existing "required" field, then add correct values +- **Schemas fixed**: AwsBatchConfig, AwsCloudConfig, AzBatchConfig, AzCloudConfig, ConfigEnvVariable, CreateComputeEnvRequest, EksComputeConfig, GkeComputeConfig, GoogleBatchConfig, GoogleCloudConfig, K8sComputeConfig, SeqeraComputeConfig + +### Key Pattern Learned + +**"Remove First, Then Update"** applies to: +- Parameter arrays (to prevent duplicates) +- Required field arrays (to fix duplicates) +- Deprecated endpoints (to remove completely) + +### Files Ready for Workflow + +- ✅ `claude-generated-overlays.md` (10 overlays, all fixes included) +- ✅ `seqera-api-latest-decorated.yaml` (base decorated spec) +- ✅ `seqera-api-1.102.0.yaml` (base spec) +- ✅ `.claude/skills/openapi-overlay-generator/SKILL.md` (updated) +- ✅ `~/.claude/skills/openapi-overlay-generator/SKILL.md` (updated) + +All intermediate files cleaned up. Folder is ready for workflow execution. + +### Next Steps + +1. **Commit changes**: + - `claude-generated-overlays.md` + - Both `SKILL.md` files + - `progress.md` + +2. **Push to `api-docs-v1.102.0` branch** + +3. **Add `overlays-approved` label** to trigger workflow + +4. **Workflow will**: + - Extract 10 overlays from MD + - Consolidate into single file (177 actions) + - Apply to decorated spec + - Validate (should pass with 0 errors!) + - Regenerate docs + - Create PR + +## Issue #8: Additional duplicate enums and required fields ✅ FIXED + +### Problem +Workflow validation on 2026-01-20 15:46:40 revealed additional duplicates in the decorated spec that were not covered by previous overlays: +- WARN: enum value 'ERRORED' duplicated at line 563 and 9345 +- ERROR: duplicate required field items at line 9227 + +### Root Cause +The decorated spec (`seqera-api-latest-decorated.yaml`) contains duplicates that were not in the base spec or came from the decoration process: +1. **6 duplicate enum arrays** with values appearing 2-3 times each +2. **12 duplicate required field arrays** - most were already fixed, but ComputeEnv_ComputeConfig_ was missing + +### Comprehensive Scan Results +Used codebase-analyzer agent to scan the ENTIRE OpenAPI spec file. Found **18 total instances**: + +**Duplicate Enums (6 instances)**: +1. Line 563 - Query parameter `status` enum (CREATING, AVAILABLE, ERRORED, INVALID - each 2x) +2. Line 809 - Query parameter `attributes` enum (labels - 2x) +3. Line 8891 - `AzBatchConfig.deleteJobsOnCompletion` (on_success, always, never - each 2x) +4. Lines 9283-9331 - `ComputeEnv_ComputeConfig_.platform` (16+ values - each 3x) +5. Line 9361 - `ComputeEnv_ComputeConfig_.status` (CREATING, AVAILABLE, ERRORED, INVALID - each 2x) +6. Line 11444 - `K8sComputeConfig.podCleanup` (on_success, always, never - each 2x) + +**Duplicate Required Fields (12 instances)**: +- AwsBatchConfig (line 8676) - already fixed +- AwsCloudConfig (line 8806) - already fixed +- AzBatchConfig (line 8912) - already fixed +- AzCloudConfig (line 9018) - already fixed +- **ComputeEnv_ComputeConfig_ (lines 9242-9251) - MISSING! ✅ Added** +- ConfigEnvVariable (line 9408) - already fixed +- CreateComputeEnvRequest (line 9491) - already fixed +- GkeComputeConfig (line 11004) - already fixed +- GoogleBatchConfig (line 11116) - already fixed +- GoogleCloudConfig (line 11185) - already fixed +- K8sComputeConfig (line 11466) - already fixed +- SeqeraComputeConfig (line 12836) - already fixed +- EksComputeConfig - already fixed + +### Fix Applied + +1. **Updated `fix-duplicate-required-fields-overlay-1.102.0.yaml`**: + - Added ComputeEnv_ComputeConfig_ with required: ["config", "name", "platform"] + +2. **Created NEW `fix-duplicate-enums-overlay-1.102.0.yaml`**: + - Fixes all 6 duplicate enum arrays + - Uses "remove first, then update" pattern + - Includes detailed comments with line numbers + +3. **Updated `claude-generated-overlays.md`**: + - Added new enum fixes overlay section + - Updated required fields overlay with missing schema + +### Overlay Count Update +Now have **12 total overlays** for v1.102.0: +1. compute-envs-operations-overlay-1.102.0.yaml +2. compute-envs-parameters-overlay-1.102.0.yaml +3. compute-envs-schemas-overlay-1.102.0.yaml +4. data-links-operations-overlay-1.102.0.yaml +5. data-links-parameters-overlay-1.102.0.yaml +6. workflows-parameters-overlay-1.102.0.yaml +7. workflows-operations-overlay-1.102.0.yaml +8. global-schemas-overlay-1.102.0.yaml +9. manual-field-descriptions-overlay-1.102.0.yaml +10. fix-duplicate-required-fields-overlay-1.102.0.yaml (updated) +11. fix-duplicate-enums-overlay-1.102.0.yaml (NEW - updated to exclude google-lifesciences) +12. remove-google-lifesciences-overlay-1.102.0.yaml (NEW) + +### Deprecated Platform Removal +Added overlay to completely remove the deprecated `google-lifesciences` platform option: +- Removed from `ComputeEnvResponseDto.platform` enum (line 9198) +- Removed from `ComputeEnv_ComputeConfig_.platform` enum (line 9286) - handled by fix-duplicate-enums-overlay +- Removed from `ComputeConfig` discriminator mapping (line 9140) +- Replaced `ComputeConfig` oneOf array without GoogleLifeSciencesConfig ref (line 9146) +- Removed entire `GoogleLifeSciencesConfig` schema definition (line 11229+) + +**Update**: Fixed references - the discriminator and oneOf are in the `ComputeConfig` schema (line 9099), not `ComputeEnv_ComputeConfig_` (which just references ComputeConfig via $ref) + +### Next Workflow Run +Expected total actions: ~200+ (was 177, now adding enum fixes + google-lifesciences removal) + +Ready to commit and re-run workflow! + +## Issue #9: Additional validation errors after applying overlays ✅ FIXED + +### Date +2026-01-20 18:30 - Full validation session + +### Problem +After extracting and applying all 12 overlays from `claude-generated-overlays.md` to a test decorated spec, validation revealed: +- **16 ERRORS** (critical - blocking) +- **13 WARNINGS** (9 actionable, 4 informational) +- **1370 HINTS** (informational only) + +### Root Causes + +#### Error Group 1: GoogleLifeSciencesConfig Reference Issues (3 errors) +The `remove-google-lifesciences-overlay-1.102.0.yaml` correctly: +- ✅ Removed the schema definition +- ✅ Removed the discriminator mapping + +But it was **missing the critical "remove first" step** for the `oneOf` array. It did: +```yaml +# ❌ WRONG - Just update, causing duplicates +- target: "$.components.schemas.ComputeConfig.oneOf" + update: + - $ref: "#/components/schemas/AwsBatchConfig" + # ... +``` + +Should have been: +```yaml +# ✅ CORRECT - Remove first, then update +- target: "$.components.schemas.ComputeConfig.oneOf" + remove: true + +- target: "$.components.schemas.ComputeConfig" + update: + oneOf: + - $ref: "#/components/schemas/AwsBatchConfig" + # ... +``` + +#### Error Group 2: Duplicate Schema References in oneOf (13 errors) +The improper update (without removal) caused each compute config schema to appear **twice** in the oneOf array. + +#### Error Group 3: Missing Config Types in oneOf Array (3 warnings → should be 0) +The replacement oneOf array was missing **3 valid compute config types**: +- ❌ Missing: `GoogleCloudConfig` (line 9603 in base spec) +- ❌ Missing: `AzCloudConfig` (line 9605 in base spec) +- ❌ Missing: `LocalComputeConfig` (line 9614 in base spec) + +These are **NOT deprecated** - they are valid compute environment types and must be included. + +#### Warning Group: Missing "identities" Tag (9 warnings) +Operations use the `identities` tag but it's not defined in the global `tags` array (line 12). + +### Fixes Applied + +#### Fix 1: Corrected remove-google-lifesciences overlay in claude-generated-overlays.md +**Changed from** (line 1070-1086): +```yaml +- target: "$.components.schemas.ComputeConfig.oneOf" + update: + - $ref: "#/components/schemas/AwsBatchConfig" + - $ref: "#/components/schemas/AwsCloudConfig" + - $ref: "#/components/schemas/SeqeraComputeConfig" + - $ref: "#/components/schemas/GoogleBatchConfig" + - $ref: "#/components/schemas/AzBatchConfig" + # ... (missing GoogleCloudConfig, AzCloudConfig, LocalComputeConfig) +``` + +**Changed to**: +```yaml +# CRITICAL: Remove entire oneOf array first to prevent duplicates +- target: "$.components.schemas.ComputeConfig.oneOf" + remove: true + +# Replace with correct array (no GoogleLifeSciencesConfig, no duplicates) +- target: "$.components.schemas.ComputeConfig" + update: + oneOf: + - $ref: "#/components/schemas/AwsBatchConfig" + - $ref: "#/components/schemas/AwsCloudConfig" + - $ref: "#/components/schemas/SeqeraComputeConfig" + - $ref: "#/components/schemas/GoogleBatchConfig" + - $ref: "#/components/schemas/GoogleCloudConfig" # ← ADDED + - $ref: "#/components/schemas/AzBatchConfig" + - $ref: "#/components/schemas/AzCloudConfig" # ← ADDED + - $ref: "#/components/schemas/LsfComputeConfig" + - $ref: "#/components/schemas/SlurmComputeConfig" + - $ref: "#/components/schemas/K8sComputeConfig" + - $ref: "#/components/schemas/EksComputeConfig" + - $ref: "#/components/schemas/GkeComputeConfig" + - $ref: "#/components/schemas/UnivaComputeConfig" + - $ref: "#/components/schemas/AltairPbsComputeConfig" + - $ref: "#/components/schemas/MoabComputeConfig" + - $ref: "#/components/schemas/LocalComputeConfig" # ← ADDED +``` + +#### Fix 2: Added identities tag overlay to claude-generated-overlays.md +Added new section before final closing text: +```yaml +overlay: 1.0.0 +info: + title: Add identities tag to global tags + version: 1.102.0 +actions: + # CRITICAL: Remove entire tags array first to prevent duplicates + - target: "$.tags" + remove: true + + # Replace with complete array including identities tag + - target: "$" + update: + tags: + - name: actions + description: Pipeline actions + # ... (all existing tags) + - name: identities + description: Managed identities for centralized credential management + # ... (rest of tags) +``` + +### Validation Results After Fixes + +**Test File**: `seqera-api-test-decorated-final.yaml` +- ✅ **Errors: 0** (was 16) +- ✅ **Warnings: 3** (was 13) - Only informational warnings about unused schemas remain +- ✅ **Hints: 1370** (informational, non-breaking) + +**Status**: ✅ **SPEC IS VALID** + +### Remaining Warnings (Informational Only) +These 3 warnings don't affect spec validity: +1. `AzCloudConfig` - Potentially unused (but NOW in oneOf, so should resolve) +2. `GoogleCloudConfig` - Potentially unused (but NOW in oneOf, so should resolve) +3. `SeqeraComputePlatformMetainfo` - Potentially unused metadata schema + +### Testing Process +1. ✅ Extracted 12 overlays from `claude-generated-overlays.md` +2. ✅ Consolidated into `all-changes-overlay-1.102.0.yaml` (196 actions) +3. ✅ Applied to test file (NOT production): `seqera-api-test-decorated.yaml` +4. ✅ Identified 16 errors via validation +5. ✅ Created analysis report: `remaining-validation-errors.md` +6. ✅ Created 2 fix overlays (later merged into claude-generated-overlays.md) +7. ✅ Re-applied with fixes to: `seqera-api-test-decorated-final.yaml` +8. ✅ Final validation: **0 ERRORS** +9. ✅ Updated `claude-generated-overlays.md` with fixes inline +10. ✅ Cleaned up all intermediate/test files + +### Files Updated +- ✅ `claude-generated-overlays.md` - Fixed remove-google-lifesciences overlay, added identities tag overlay +- ✅ `progress.md` - This document + +### Files Cleaned Up +Removed all intermediate/test files: +- All individual `*-overlay-1.102.0.yaml` files +- `seqera-api-test-decorated.yaml` +- `seqera-api-test-decorated-final.yaml` +- `all-changes-overlay-1.102.0.yaml` +- `additional-fixes-overlay-1.102.0.yaml` +- `validation-*.txt` files +- `remaining-validation-errors.md` +- `validation-final-results.md` + +### Current State +**Specs directory contains only**: +- ✅ `seqera-api-1.102.0.yaml` - Base spec (unchanged) +- ✅ `seqera-api-latest-decorated.yaml` - Production decorated spec (unchanged) +- ✅ `base-1.95-to-1.102.0-changes.yaml` - Comparison overlay +- ✅ `claude-generated-overlays.md` - Source of truth (updated with all fixes) +- ✅ `progress.md` - This document + +### Key Learning: The "Remove First, Then Update" Pattern +This pattern is CRITICAL for arrays in OpenAPI specs: + +**Applies to**: +- Parameter arrays +- Enum arrays +- Required field arrays +- oneOf/anyOf/allOf arrays +- Tags arrays + +**Pattern**: +```yaml +# Step 1: Remove the entire array +- target: "$.path.to.array" + remove: true + +# Step 2: Update the parent with new array +- target: "$.path.to.parent" + update: + arrayName: + - item1 + - item2 +``` + +**Why**: Simply updating array items creates duplicates. Must remove first, then replace completely. + +### Overlay Count: Still 12 (Content Updated) +The total number of overlay files is still 12, but the content was corrected: +1. compute-envs-operations-overlay-1.102.0.yaml +2. compute-envs-parameters-overlay-1.102.0.yaml +3. compute-envs-schemas-overlay-1.102.0.yaml +4. data-links-operations-overlay-1.102.0.yaml +5. data-links-parameters-overlay-1.102.0.yaml +6. workflows-parameters-overlay-1.102.0.yaml +7. workflows-operations-overlay-1.102.0.yaml +8. global-schemas-overlay-1.102.0.yaml +9. manual-field-descriptions-overlay-1.102.0.yaml +10. fix-duplicate-required-fields-overlay-1.102.0.yaml +11. fix-duplicate-enums-overlay-1.102.0.yaml +12. remove-google-lifesciences-overlay-1.102.0.yaml (**CORRECTED**) +13. add-identities-tag-1.102.0.yaml (**NEW**) + +**Total**: 13 overlays, ~200 actions + +### Next Steps +1. **Commit** `claude-generated-overlays.md` and `progress.md` +2. **Push** to `api-docs-v1.102.0` branch +3. **Trigger workflow** with `overlays-approved` label +4. **Workflow should**: + - Extract 13 overlays + - Consolidate into single file (~200 actions) + - Apply to decorated spec + - **Validate with 0 errors** ✅ + - Regenerate docs + - Archive overlays + +### Confidence Level +**VERY HIGH** - Full local validation passed with 0 errors. The workflow extraction and application process matches exactly what was tested locally. + +## Issue #10: Version mismatch between decorated spec and base spec ⚠️ BLOCKING + +### Date +2026-01-20 19:00+ + +### Problem +While attempting to validate that the overlays in `claude-generated-overlays.md` work correctly, discovered a fundamental version mismatch: + +**Current State**: +- Base spec: `seqera-api-1.102.0.yaml` (version 1.102.0) +- Decorated spec: `seqera-api-latest-decorated.yaml` (version **1.95.0**) +- Overlays: Generated for changes from 1.95 → 1.102.0 + +**The Issue**: +When applying the consolidated overlay (`all-changes-overlay-1.102.0.yaml`) to the v1.95 decorated spec, validation fails with: +``` +ERROR: component #/components/schemas/LocalComputeConfig does not exist in the specification +ERROR: component #/components/schemas/GoogleCloudConfig does not exist +ERROR: component #/components/schemas/AzCloudConfig does not exist +``` + +These schemas **DO exist** in the v1.102.0 base spec (verified at lines 9357, 11482, 12294), but **NOT in the v1.95 decorated spec**. + +### Root Cause Analysis + +The `remove-google-lifesciences-overlay-1.102.0.yaml` in `claude-generated-overlays.md` updates the `ComputeConfig.oneOf` array to include these schemas: +```yaml +- target: "$.components.schemas.ComputeConfig" + update: + oneOf: + # ... + - $ref: "#/components/schemas/GoogleCloudConfig" # Added in v1.102.0 + - $ref: "#/components/schemas/AzCloudConfig" # Added in v1.102.0 + - $ref: "#/components/schemas/LocalComputeConfig" # Added in v1.102.0 +``` + +But the v1.95 decorated spec doesn't have these schema definitions, so the references fail validation. + +### Failed Approach + +**Incorrect Understanding**: Initially thought we should apply overlays directly to the 1.102.0 base spec instead of the decorated spec. + +**Why This Is Wrong**: +- The decorated spec contains **years of accumulated enrichments** (descriptions, examples, documentation) +- The base spec only has auto-generated descriptions from Java annotations +- Applying overlays to the base spec would lose all existing enrichment +- The entire point of the workflow is to **UPDATE the decorated spec** with changes from new versions + +### The Real Problem + +The workflow assumes: +1. Decorated spec is at version N (e.g., 1.95.0) +2. New base spec is at version N+1 (e.g., 1.102.0) +3. Overlays describe the **delta** between N and N+1 +4. Applying overlays to decorated spec brings it from N → N+1 + +**But this breaks when**: +- Schemas are **added** in N+1 (like LocalComputeConfig, GoogleCloudConfig, AzCloudConfig) +- Overlays reference these new schemas +- Decorated spec (still at N) doesn't have them + +### Critical Question + +**How do we update the decorated spec when new schemas are added?** + +The current overlay approach can: +- ✅ Update existing endpoint descriptions +- ✅ Update existing parameter descriptions +- ✅ Update existing schema property descriptions +- ✅ Remove deprecated endpoints/schemas +- ❌ **Add NEW schemas that don't exist in the decorated spec** + +### Hypothesis + +There may be a **missing step** in the workflow: +1. Apply comparison overlay (`base-1.95-to-1.102.0-changes.yaml`) to decorated spec first? + - This would add the new schemas + - Then apply enrichment overlays? +2. Or: Merge the base spec changes INTO the decorated spec before applying enrichments? +3. Or: The decorated spec should have been updated to 1.102.0 already by a different process? + +### What We Need + +**In the next session, we need to**: +1. Use the `research-seqera-codebase` skill to: + - Read the ENTIRE `seqera-api-1.102.0.yaml` (base spec) + - Read the ENTIRE `seqera-api-latest-decorated.yaml` (decorated spec v1.95) + - Read the ENTIRE `claude-generated-overlays.md` (overlay definitions) + - Read the `base-1.95-to-1.102.0-changes.yaml` (Speakeasy comparison) + +2. Analyze and answer: + - What schemas exist in 1.102.0 that DON'T exist in the 1.95 decorated spec? + - What endpoints exist in 1.102.0 that DON'T exist in the 1.95 decorated spec? + - Do the overlays in `claude-generated-overlays.md` properly handle ALL changes? + - Is the comparison overlay (`base-1.95-to-1.102.0-changes.yaml`) meant to be applied BEFORE the enrichment overlays? + - Should the workflow be applying BOTH overlays in sequence? + +3. Determine the correct workflow order: + - Option A: `base-1.95-to-1.102.0-changes.yaml` → `all-changes-overlay-1.102.0.yaml` + - Option B: Merge base spec changes into decorated spec first, then apply enrichments + - Option C: Something else entirely + +### Files to Investigate +- `seqera-api-1.102.0.yaml` - NEW base spec (409 KB) +- `seqera-api-latest-decorated.yaml` - OLD decorated spec v1.95 (451 KB) +- `base-1.95-to-1.102.0-changes.yaml` - Speakeasy comparison overlay (42 KB) +- `claude-generated-overlays.md` - Human-reviewed enrichment overlays +- `.github/workflows/apply-overlays-and-regenerate.yml` - Workflow that applies overlays + +### Current State +**RESOLVED**: Issue #10 has been resolved by adding the missing `LocalComputeConfig` schema via overlay. + +## Issue #11: Missing LocalComputeConfig schema in v1.95 decorated spec ✅ FIXED + +### Date +2026-01-20 17:00+ + +### Problem +Validation error showed: +``` +ERROR: component #/components/schemas/LocalComputeConfig does not exist in the specification +``` + +The `remove-google-lifesciences-overlay-1.102.0.yaml` in `claude-generated-overlays.md` (line 1095) references `LocalComputeConfig` in the `ComputeConfig.oneOf` array, but this schema **does not exist** in the v1.95 decorated spec. + +### Root Cause Analysis + +**Schema Existence:** +| Schema | v1.102.0 Base | v1.95 Decorated | v1.95 Base | +|--------|---------------|-----------------|------------| +| `LocalComputeConfig` | ✅ Yes (line 12294) | ❌ **NO** | ✅ Yes (line 12026) | +| `GoogleCloudConfig` | ✅ Yes (line 11482) | ✅ Yes (line 11122) | ✅ Yes | +| `AzCloudConfig` | ✅ Yes (line 9357) | ✅ Yes (line 8955) | ✅ Yes | + +**Why the comparison overlay didn't help:** +- `base-1.95-to-1.102.0-changes.yaml` was generated by Speakeasy comparing two complete base specs +- Both base specs already contained `LocalComputeConfig` +- So Speakeasy only generated **UPDATE** actions for property descriptions (lines 756-767) +- It did NOT generate an **ADD** action for the entire schema + +**The real issue:** +- `LocalComputeConfig` was accidentally excluded from the v1.95 decorated spec during its creation +- This created an impossible situation where overlays assumed it existed (because it's in both base specs) +- But the decorated spec didn't have it + +### Solution: Add Schema via Overlay + +Created `add-local-compute-config-overlay-1.102.0.yaml` to add the complete schema definition: + +```yaml +- target: "$.components.schemas" + update: + LocalComputeConfig: + type: object + title: Local execution configuration + properties: + workDir: # ... complete definitions with descriptions + preRunScript: # ... + postRunScript: # ... + environment: # ... + nextflowConfig: # ... + discriminator: # ... + waveEnabled: # ... + fusion2Enabled: # ... +``` + +**Critical ordering:** +- Added this overlay to `claude-generated-overlays.md` **BEFORE** other overlays that reference it +- Placed in new "Missing Schemas (Must Apply First)" section at line 11 +- Now consolidated overlay will add the schema before trying to reference it in `ComputeConfig.oneOf` + +### Files Updated +- ✅ `claude-generated-overlays.md` - Added `add-local-compute-config-overlay-1.102.0.yaml` at the beginning + +### Overlay Count: Now 14 Total +1. **add-missing-schema-overlay-1.102.0.yaml** (NEW - must apply first) +2. **add-identities-tag-overlay-1.102.0.yaml** (NEW - fixed filename to match extraction regex) +3. compute-envs-operations-overlay-1.102.0.yaml +4. compute-envs-parameters-overlay-1.102.0.yaml +5. compute-envs-schemas-overlay-1.102.0.yaml +6. data-links-operations-overlay-1.102.0.yaml +7. data-links-parameters-overlay-1.102.0.yaml +8. workflows-parameters-overlay-1.102.0.yaml +9. workflows-operations-overlay-1.102.0.yaml +10. global-schemas-overlay-1.102.0.yaml +11. manual-field-descriptions-overlay-1.102.0.yaml +12. fix-duplicate-required-fields-overlay-1.102.0.yaml +13. fix-duplicate-enums-overlay-1.102.0.yaml +14. remove-google-lifesciences-overlay-1.102.0.yaml + +### Local Validation Results ✅ + +**Date**: 2026-01-20 17:15 + +Extracted 14 overlays → Consolidated into 200 actions → Applied to decorated spec → Validated: + +``` +Errors: 0 ✅ +Warnings: 1 (informational - unused schema) +Hints: 1371 (informational - missing examples) + +✅ SPEC IS VALID +``` + +**Key fixes verified:** +- ✅ `LocalComputeConfig` schema added successfully +- ✅ `identities` tag added to global tags (no more warnings) +- ✅ All schemas exist before being referenced in `ComputeConfig.oneOf` +- ✅ Overlay filename patterns fixed (`add-identities-tag-overlay-1.102.0.yaml` instead of `add-identities-tag-1.102.0.yaml`) + +### Files Ready for Commit +- ✅ `claude-generated-overlays.md` - Updated with 2 new overlays, filename fixes +- ✅ `progress.md` - This document + +### Next Steps +1. **Commit** `claude-generated-overlays.md` and `progress.md` +2. **Push** to `api-docs-v1.102.0` branch +3. **Trigger workflow** with `overlays-approved` label or workflow_dispatch +4. **Expect success** - Local validation passed with 0 errors! + +--- + +## Issue #12: Workflow failures after overlay fixes ⚠️ BLOCKED + +### Date +2026-01-20 17:15 - 20:30 + +### Problem +After successfully fixing the overlay validation issues (Issue #11), the workflow failed at various stages with multiple different errors: + +1. **Submodule checkout error**: `fatal: No url found for submodule path 'platform-repo' in .gitmodules` +2. **Missing multiqc directory**: `The docs folder does not exist for version "current" at multiqc_docs/multiqc_repo/docs/markdown` +3. **OpenAPI plugin null pointer**: `TypeError: Cannot read properties of null (reading '0')` in docusaurus-plugin-openapi-docs + +### Root Causes + +#### 1. Broken `platform-repo` Submodule +- `platform-repo` was registered as a submodule (mode 160000) in git index +- But had NO URL in `.gitmodules` file +- The `generate-openapi-overlays.yml` workflow checks it out as a fresh clone, NOT a submodule +- When `submodules: recursive` was added to fix multiqc, it failed on this broken entry + +#### 2. Missing OSS Repos +- `multiqc_docs/multiqc_repo`, `fusion_docs/fusion_repo`, `wave_docs/wave_repo` are in `.gitignore` (line 37: "OSS repo clones") +- They are NOT tracked by git, NOT submodules +- Don't exist when GitHub Actions checks out the repo +- Docusaurus plugin initialization tried to load them and failed + +#### 3. Disabled Classic Docs Plugin +- OpenAPI plugin configured with `docsPluginId: "classic"` (docusaurus.config.js:62) +- But preset-classic had `docs: false` (docusaurus.config.js:234) +- No "classic" docs plugin existed for OpenAPI plugin to reference +- This caused null pointer error when OpenAPI plugin tried to find it + +### Solutions Applied + +#### Fix 1: Remove Broken Submodule ✅ +**Commit**: `4a7c4644` - "Remove broken platform-repo submodule and fix docusaurus plugin issue" + +```bash +git rm --cached platform-repo +``` + +- Removed broken `platform-repo` submodule entry from git index +- The `generate-openapi-overlays.yml` workflow already checks it out as a fresh clone, doesn't need submodule + +#### Fix 2: Exclude OSS Repo Plugins ✅ +**Commits**: `4a7c4644`, `03496225`, `d5218983` + +Added EXCLUDE flags to docusaurus steps to skip plugins that need gitignored repos: + +```yaml +env: + EXCLUDE_MULTIQC: true + EXCLUDE_FUSION: true + EXCLUDE_WAVE: true +``` + +This prevents docusaurus from trying to load plugins that depend on directories not available in CI. + +#### Fix 3: Enable Classic Docs Plugin ✅ +**Commit**: `88f6ed10` - "Fix OpenAPI plugin by enabling classic docs plugin it depends on" + +Changed `docusaurus.config.js` preset-classic config: + +```js +// Before (broken): +docs: false, + +// After (working): +docs: { + path: "platform-api-docs/docs", + routeBasePath: "/", +}, +``` + +Now the "classic" docs plugin exists for OpenAPI plugin to reference. + +### Workflow Configuration Final State + +**File**: `.github/workflows/apply-overlays-and-regenerate.yml` + +```yaml +- name: Checkout PR branch + uses: actions/checkout@v4 + with: + ref: ${{ github.head_ref || format('refs/pull/{0}/head', github.event.inputs.pr_number) }} + # No submodules: recursive (not needed, was causing issues) + +- name: Clean existing API docs + run: npx docusaurus clean-api-docs platform + env: + EXCLUDE_MULTIQC: true + EXCLUDE_FUSION: true + EXCLUDE_WAVE: true + +- name: Generate new API docs + run: npx docusaurus gen-api-docs platform + env: + EXCLUDE_MULTIQC: true + EXCLUDE_FUSION: true + EXCLUDE_WAVE: true +``` + +### Key Learnings + +1. **Git submodules vs checkout actions**: If a workflow checks out a repo as a fresh clone (`uses: actions/checkout@v4` with `path`), don't also register it as a submodule in `.gitmodules`. Choose one approach. + +2. **Docusaurus plugin dependencies**: The `docusaurus-plugin-openapi-docs` requires a docs plugin with matching `docsPluginId` to exist. Even if you're only generating OpenAPI docs, the underlying docs plugin must be enabled. + +3. **EXCLUDE flags vs targeting specific IDs**: Using `npx docusaurus gen-api-docs platform` with EXCLUDE flags is cleaner than `all` with many exclusions. + +4. **Gitignored dependencies in CI**: If docusaurus plugins depend on directories that are gitignored (OSS repo clones), use EXCLUDE flags to skip those plugins in CI workflows. + +### Commits in This Session + +1. `038135de` - Add missing LocalComputeConfig schema overlay and fix identities tag filename +2. `2cb6b8ed` - Fix submodule checkout in apply-overlays workflow (later reverted) +3. `4a7c4644` - Remove broken platform-repo submodule and fix docusaurus plugin issue +4. `79f6d3f8` - Exclude all docsets except Platform OpenAPI (later revised) +5. `c0f1c139` - Fix docusaurus commands to target specific platform spec +6. `03496225` - Add EXCLUDE flags for gitignored OSS repos +7. `d5218983` - Use 'all' instead of 'platform' (later revised) +8. `88f6ed10` - Fix OpenAPI plugin by enabling classic docs plugin (later superseded) +9. `ac507709` - Document workflow fixes in progress.md (Issue #12 still blocked) +10. `1bcf0775` - Update progress.md - Issue #12 still blocked despite fixes +11. `4c5c7905` - Fix OpenAPI plugin configuration to work with EXCLUDE env vars (Issue #12 RESOLVED) +12. `1eecb749` - Update progress.md - Issue #12 resolved with OpenAPI plugin fix +13. `12b9dde3` - Fix update_sidebar.py script path in workflow +14. `5517a113` - Update progress.md - Document update_sidebar.py path fix +15. `c09a89c0` - Fix detached HEAD issue in workflow by fetching PR branch name (Issue #12 fully resolved) + +### Status +✅ **FIXED** - All workflow issues resolved (commits `4c5c7905`, `12b9dde3`, `c09a89c0`) + +**Root Causes Identified**: +1. **Incorrect docsPluginId**: OpenAPI plugin referenced `docsPluginId: "classic"` but preset-classic's docs plugin uses ID `"default"`, not `"classic"` +2. **Null plugin entries**: When `EXCLUDE_MULTIQC`, `EXCLUDE_FUSION`, `EXCLUDE_WAVE` env vars are set, the plugins array contains null entries, causing the OpenAPI plugin's filter code to crash when accessing `data[0]` +3. **Wrong script path**: Workflow referenced `openapi-overlay-generator/scripts/update_sidebar.py` but script is at `.claude/skills/openapi-overlay-generator/scripts/update_sidebar.py` +4. **Detached HEAD state**: When using workflow_dispatch with a PR number, checking out `refs/pull/{pr_number}/head` results in detached HEAD, causing "fatal: You are not currently on a branch" when pushing + +**Fixes Applied**: +1. ✅ Changed `docsPluginId` from `"classic"` to `"default"` (docusaurus.config.js:62) - commit `4c5c7905` +2. ✅ Added `.filter(Boolean)` to plugins array to remove null entries (docusaurus.config.js:296) - commit `4c5c7905` +3. ✅ Fixed update_sidebar.py script path in workflow (apply-overlays-and-regenerate.yml:312) - commit `12b9dde3` +4. ✅ Added step to fetch PR branch name before checkout to avoid detached HEAD (apply-overlays-and-regenerate.yml:26-44) - commit `c09a89c0` + +**Local Testing Passed**: +```bash +# Both commands now work with EXCLUDE flags +✅ npx docusaurus clean-api-docs platform +✅ npx docusaurus gen-api-docs platform +``` + +**Error Details** (before fix): +``` +TypeError: Cannot read properties of null (reading '0') + at /home/runner/work/docs/docs/node_modules/docusaurus-plugin-openapi-docs/lib/index.js:67:39 + at Array.filter () + at getPluginInstances (/home/runner/work/docs/docs/node_modules/docusaurus-plugin-openapi-docs/lib/index.js:67:18 +``` + +The error occurred because: +- Line 67 does: `plugins.filter((data) => data[0] === "docusaurus-plugin-openapi-docs")` +- When EXCLUDE env vars are set, some entries in `plugins` are `null` +- Accessing `null[0]` throws "Cannot read properties of null" +- The plugin code doesn't filter out nulls before accessing array indices + +### Previous Attempts (All Superseded) +1. ✅ Removed broken `platform-repo` submodule - helped but wasn't the root cause +2. ✅ Added EXCLUDE flags for OSS repos (multiqc, fusion, wave) - correct approach but incomplete +3. ✅ Enabled classic docs plugin in preset-classic config - wrong fix, "classic" isn't the right ID + +### Files Modified +- ✅ `claude-generated-overlays.md` - Added missing schema and identities tag overlays +- ✅ `progress.md` - This document +- ✅ `.github/workflows/apply-overlays-and-regenerate.yml` - Fixed checkout, docusaurus commands, and update_sidebar.py path (commits `88f6ed10`, `12b9dde3`) +- ✅ `docusaurus.config.js` - Fixed docsPluginId and null plugin filtering (commit `4c5c7905`) +- ✅ `.git/index` - Removed broken platform-repo submodule entry + +### Research Document +Full root cause analysis documented at: +`/Users/llewelyn-van-der-berg/Documents/GitHub/research/API docs automation troubleshooting/2026-01-20-overlay-validation-failure-root-cause.md` + +### Next Steps +The workflow should now succeed: +1. Extract overlays from `claude-generated-overlays.md` (14 overlays) +2. Consolidate into single file (~200 actions) +3. Apply to decorated spec +4. Validate (expect 0 errors - tested locally in Issue #11) +5. **Clean and regenerate API docs** ✅ (now unblocked) +6. Archive overlays +7. Commit and push changes diff --git a/platform-api-docs/scripts/specs/seqera-api-1.95.yml b/platform-api-docs/scripts/specs/seqera-api-1.102.0.yaml similarity index 93% rename from platform-api-docs/scripts/specs/seqera-api-1.95.yml rename to platform-api-docs/scripts/specs/seqera-api-1.102.0.yaml index c5f2a84fe..0c584b8a5 100644 --- a/platform-api-docs/scripts/specs/seqera-api-1.95.yml +++ b/platform-api-docs/scripts/specs/seqera-api-1.102.0.yaml @@ -5,7 +5,7 @@ info: contact: url: https://seqera.io email: info@seqera.io - version: 1.95.0 + version: 1.102.0 tags: - name: actions description: Pipeline actions @@ -807,6 +807,85 @@ paths: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] + /compute-envs/{computeEnvId}/disable: + post: + tags: + - compute-envs + summary: Disable compute environment + description: "Disables the compute environment identified by the given `computeEnvId`.\ + \ A disabled compute environment cannot be used to launch workflows. If the\ + \ compute environment is primary, it will be automatically unset as primary." + operationId: DisableComputeEnv + parameters: + - name: computeEnvId + in: path + description: Compute environment string identifier + required: true + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/EmptyBodyRequest" + responses: + "204": + description: OK - No content + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Operation not allowed + security: + - BearerAuth: [] + /compute-envs/{computeEnvId}/enable: + post: + tags: + - compute-envs + summary: Enable compute environment + description: Enables the compute environment identified by the given `computeEnvId`. + An enabled compute environment can be used to launch workflows. + operationId: EnableComputeEnv + parameters: + - name: computeEnvId + in: path + description: Compute environment string identifier + required: true + schema: + type: string + - name: workspaceId + in: query + description: Workspace numeric identifier + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/EmptyBodyRequest" + responses: + "204": + description: OK - No content + "400": + description: Bad request + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Operation not allowed + security: + - BearerAuth: [] /compute-envs/{computeEnvId}/primary: post: tags: @@ -1371,9 +1450,9 @@ paths: get: tags: - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given\ - \ `dataLinkId`, at the given `path`." + summary: Explore data-link + description: Retrieves the content of the data-link associated with the given + `dataLinkId` operationId: ExploreDataLink parameters: - name: dataLinkId @@ -1382,12 +1461,6 @@ paths: required: true schema: type: string - - name: path - in: path - description: Content path - required: true - schema: - type: string - name: workspaceId in: query description: Workspace numeric identifier @@ -1504,7 +1577,7 @@ paths: summary: Explore data-link path description: "Retrieves the content of the data-link associated with the given\ \ `dataLinkId`, at the given `path`." - operationId: ExploreDataLink_1 + operationId: ExploreDataLinkWithPath parameters: - name: dataLinkId in: path @@ -1626,7 +1699,7 @@ paths: description: Operation not allowed security: - BearerAuth: [] - /data-links/{dataLinkId}/download: + /data-links/{dataLinkId}/download/{filePath}: get: tags: - data-links @@ -1813,9 +1886,9 @@ paths: post: tags: - data-links - summary: Generate data-link file upload URL (to given path) + summary: Generate data-link file upload URL description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). + Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. operationId: GenerateDataLinkUploadUrl parameters: @@ -1825,12 +1898,6 @@ paths: required: true schema: type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - name: credentialsId in: query description: Credentials string identifier @@ -1881,11 +1948,11 @@ paths: post: tags: - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`).\ - \ This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize\ - \ a successful file upload, or abort an upload if an error was encountered\ - \ while uploading a file using an upload URL from the `/upload` endpoint." + summary: Finish data-link file upload + description: "Finish upload of a data-link file. This is necessary for AWS S3\ + \ data-links (`DataLinkProvider=aws`) to finalize a successful file upload,\ + \ or abort an upload if an error was encountered while uploading a file using\ + \ an upload URL from the `/upload` endpoint." operationId: FinishDataLinkUpload parameters: - name: dataLinkId @@ -1894,12 +1961,6 @@ paths: required: true schema: type: string - - name: dirPath - in: path - description: Path to the destination directory - required: true - schema: - type: string - name: credentialsId in: query description: Credentials string identifier @@ -1928,7 +1989,7 @@ paths: $ref: "#/components/schemas/ErrorResponse" "404": description: "NotFound — workspace or credentials not found, API disabled\ - \ for the workspace, or data-link or path not found" + \ for the workspace, or data-link not found" content: application/json: schema: @@ -1952,7 +2013,7 @@ paths: \ This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize\ \ a successful file upload, or abort an upload if an error was encountered\ \ while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload_1 + operationId: FinishDataLinkUploadWithPath parameters: - name: dataLinkId in: path @@ -2002,7 +2063,7 @@ paths: "403": description: Operation not allowed "200": - description: FinishDataLinkUpload_1 200 response + description: FinishDataLinkUploadWithPath 200 response content: application/json: schema: @@ -2017,7 +2078,7 @@ paths: description: |- Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl_1 + operationId: GenerateDataLinkUploadUrlWithPath parameters: - name: dataLinkId in: path @@ -7305,6 +7366,11 @@ paths: description: Filter search parameter schema: type: string + - name: includeTotalSize + in: query + description: Include total size in the response + schema: + type: boolean responses: "200": description: OK @@ -8621,37 +8687,47 @@ components: schemas: AbstractGridConfig: type: object - allOf: - - $ref: "#/components/schemas/ComputeConfig" - - properties: - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean AccessToken: required: - name @@ -8679,7 +8755,6 @@ components: properties: discriminator: type: string - readOnly: true discriminator: propertyName: discriminator mapping: @@ -8693,7 +8768,6 @@ components: properties: discriminator: type: string - readOnly: true timestamp: type: string format: date-time @@ -8721,11 +8795,13 @@ components: - ERROR - PAUSED Action.TowerActionConfig: + title: Tower Action Config type: object properties: discriminator: type: string Action.TowerActionEvent: + title: Tower action event type: object properties: discriminator: @@ -8817,6 +8893,7 @@ components: member: $ref: "#/components/schemas/MemberDbDto" AgentSecurityKeys: + title: Tower Agent credentials type: object properties: discriminator: @@ -8837,43 +8914,47 @@ components: AltairPbsComputeConfig: title: Altair PBS configuration type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean Analytics: type: object properties: @@ -8948,6 +9029,26 @@ components: title: AWS Batch configuration type: object properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform storageType: type: string deprecated: true @@ -8958,8 +9059,6 @@ components: type: array items: type: string - discriminator: - type: string region: type: string computeQueue: @@ -8978,22 +9077,12 @@ components: type: string cliPath: type: string - workDir: - type: string - preRunScript: - type: string - postRunScript: - type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" waveEnabled: type: boolean fusion2Enabled: @@ -9002,8 +9091,6 @@ components: type: boolean logGroup: type: string - nextflowConfig: - type: string fusionSnapshots: type: boolean forge: @@ -9014,10 +9101,12 @@ components: type: object additionalProperties: true AwsBatchPlatformMetainfo: + title: AWS Batch platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -9070,30 +9159,36 @@ components: title: AWS Cloud configuration type: object properties: - discriminator: - type: string - allowBuckets: - type: array - items: - type: string - region: - type: string - instanceType: - type: string - imageId: - type: string workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string - nextflowConfig: - type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." environment: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + allowBuckets: + type: array + items: + type: string + region: + type: string + instanceType: + type: string + imageId: + type: string waveEnabled: type: boolean fusion2Enabled: @@ -9123,10 +9218,12 @@ components: type: object additionalProperties: true AwsCloudPlatformMetainfo: + title: AWS Cloud platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -9160,6 +9257,7 @@ components: items: $ref: "#/components/schemas/InstanceType" AwsSecurityKeys: + title: AWS credentials type: object properties: discriminator: @@ -9175,14 +9273,26 @@ components: title: Azure batch configuration type: object properties: - discriminator: - type: string workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform region: type: string headPool: @@ -9198,16 +9308,10 @@ components: $ref: "#/components/schemas/JobCleanupPolicy" deletePoolsOnCompletion: type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" waveEnabled: type: boolean fusion2Enabled: type: boolean - nextflowConfig: - type: string managedIdentityClientId: type: string nullable: true @@ -9228,10 +9332,12 @@ components: items: type: string AzBatchPlatformMetainfo: + title: Azure Batch platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -9252,24 +9358,30 @@ components: title: Azure Cloud configuration type: object properties: - discriminator: - type: string workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." environment: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform waveEnabled: type: boolean fusion2Enabled: type: boolean - nextflowConfig: - type: string instanceType: type: string region: @@ -9297,10 +9409,12 @@ components: items: $ref: "#/components/schemas/Map.Entry_String.String_" AzCloudPlatformMetaInfo: + title: Azure Cloud platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -9314,50 +9428,68 @@ components: items: type: string AzureCloudKeys: + title: Azure Cloud credentials type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - subscriptionId: - type: string - storageName: - type: string - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true + properties: + discriminator: + type: string + batchName: + type: string + storageName: + type: string + batchKey: + type: string + writeOnly: true + storageKey: + type: string + writeOnly: true + subscriptionId: + type: string + tenantId: + type: string + clientId: + type: string + clientSecret: + type: string + writeOnly: true AzureEntraKeys: + title: Azure Entra credentials type: object - allOf: - - $ref: "#/components/schemas/AzureSecurityKeys" - - properties: - discriminator: - type: string - tenantId: - type: string - clientId: - type: string - clientSecret: - type: string - writeOnly: true + properties: + discriminator: + type: string + batchName: + type: string + storageName: + type: string + batchKey: + type: string + writeOnly: true + storageKey: + type: string + writeOnly: true + tenantId: + type: string + clientId: + type: string + clientSecret: + type: string + writeOnly: true AzureReposSecurityKeys: + title: Azure Repos credentials type: object properties: discriminator: type: string - token: - type: string username: type: string password: type: string writeOnly: true + token: + type: string AzureSecurityKeys: + title: Azure credentials type: object properties: discriminator: @@ -9373,6 +9505,7 @@ components: type: string writeOnly: true BitBucketSecurityKeys: + title: BitBucket credentials type: object properties: discriminator: @@ -9406,17 +9539,18 @@ components: - standard - spot CodeCommitSecurityKeys: + title: AWS CodeCommit credentials type: object properties: discriminator: type: string - token: - type: string username: type: string password: type: string writeOnly: true + token: + type: string ComputeConfig: type: object properties: @@ -9440,7 +9574,6 @@ components: discriminator: type: string description: property to select the compute config platform - readOnly: true discriminator: propertyName: discriminator mapping: @@ -9487,6 +9620,7 @@ components: - DELETING - ERRORED - INVALID + - DISABLED ComputeEnvDbDto: type: object properties: @@ -9731,6 +9865,7 @@ components: type: string format: date-time ContainerRegistryKeys: + title: Container registry credentials type: object properties: discriminator: @@ -10561,6 +10696,7 @@ components: - CREDITS_RUN_OUT - LIFESPAN_EXPIRED - SPOT_RECLAMATION + - NO_STATS_AVAIL DataStudioStopResponse: required: - jobSubmitted @@ -10909,30 +11045,70 @@ components: EksComputeConfig: title: Amazon EKS cluster configuration type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - region: - type: string - description: AWS region - clusterName: - type: string - description: The AWS EKS cluster name - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - waveEnabled: - type: boolean - fusion2Enabled: - type: boolean + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + server: + type: string + sslCert: + type: string + namespace: + type: string + computeServiceAccount: + type: string + headServiceAccount: + type: string + storageClaimName: + type: string + storageMountPath: + type: string + podCleanup: + $ref: "#/components/schemas/PodCleanupPolicy" + headPodSpec: + type: string + servicePodSpec: + type: string + headJobCpus: + type: integer + format: int32 + headJobMemoryMb: + type: integer + format: int32 + region: + type: string + description: AWS region + clusterName: + type: string + description: The AWS EKS cluster name + waveEnabled: + type: boolean + fusion2Enabled: + type: boolean EksPlatformMetaInfo: + title: Amazon EKS platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -11068,18 +11244,31 @@ components: items: $ref: "#/components/schemas/WorkflowMetrics" GitHubSecurityKeys: + title: GitHub credentials type: object properties: discriminator: type: string + username: + type: string + password: + type: string + writeOnly: true token: type: string + GitKeys: + type: object + properties: + discriminator: + type: string username: type: string password: type: string - writeOnly: true + token: + type: string GitLabSecurityKeys: + title: GitLab credentials type: object properties: discriminator: @@ -11093,18 +11282,20 @@ components: type: string writeOnly: true GiteaSecurityKeys: + title: Gitea credentials type: object properties: discriminator: type: string - token: - type: string username: type: string password: type: string writeOnly: true + token: + type: string GithubActionConfig: + title: GitHub action config type: object properties: discriminator: @@ -11114,10 +11305,14 @@ components: items: type: string GithubActionEvent: + title: GitHub action event type: object properties: discriminator: type: string + timestamp: + type: string + format: date-time ref: type: string commitId: @@ -11128,36 +11323,73 @@ components: type: string pusherEmail: type: string - timestamp: - type: string - format: date-time GkeComputeConfig: title: Google GKE cluster configuration type: object - allOf: - - $ref: "#/components/schemas/K8sComputeConfig" - - properties: - discriminator: - type: string - region: - type: string - description: The GKE cluster region - or - zone - clusterName: - type: string - description: The GKE cluster name - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" - fusion2Enabled: - type: boolean - waveEnabled: - type: boolean + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + server: + type: string + sslCert: + type: string + namespace: + type: string + computeServiceAccount: + type: string + headServiceAccount: + type: string + storageClaimName: + type: string + storageMountPath: + type: string + podCleanup: + $ref: "#/components/schemas/PodCleanupPolicy" + headPodSpec: + type: string + servicePodSpec: + type: string + headJobCpus: + type: integer + format: int32 + headJobMemoryMb: + type: integer + format: int32 + region: + type: string + description: The GKE cluster region - or - zone + clusterName: + type: string + description: The GKE cluster name + fusion2Enabled: + type: boolean + waveEnabled: + type: boolean GkePlatformMetaInfo: + title: Google GKE platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -11170,12 +11402,28 @@ components: title: Google Batch service configuration type: object properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string discriminator: type: string + description: property to select the compute config platform location: type: string - workDir: - type: string spot: type: boolean bootDiskSizeGb: @@ -11202,26 +11450,16 @@ components: type: object additionalProperties: type: string - preRunScript: - type: string - postRunScript: - type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 - nextflowConfig: - type: string nfsTarget: type: string nfsMount: type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" waveEnabled: type: boolean fusion2Enabled: @@ -11245,20 +11483,26 @@ components: title: Google Cloud configuration type: object properties: - discriminator: + workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string - workDir: - type: string - nextflowConfig: - type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." environment: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform waveEnabled: type: boolean fusion2Enabled: @@ -11288,10 +11532,12 @@ components: type: object additionalProperties: true GoogleCloudPlatformMetaInfo: + title: Google Cloud platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -11334,8 +11580,26 @@ components: title: Google life sciences configuration type: object properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string discriminator: type: string + description: property to select the compute config platform region: type: string zones: @@ -11344,8 +11608,6 @@ components: type: string location: type: string - workDir: - type: string preemptible: type: boolean bootDiskSizeGb: @@ -11368,35 +11630,27 @@ components: type: object additionalProperties: type: string - preRunScript: - type: string - postRunScript: - type: string headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 - nextflowConfig: - type: string nfsTarget: type: string nfsMount: type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" GooglePlatformMetainfo: + title: Google Batch platform metainfo type: object properties: + discriminator: + type: string + description: property to select the platform metainfo type locations: type: array items: type: string - discriminator: - type: string warnings: type: array items: @@ -11428,6 +11682,7 @@ components: location: type: string GoogleSecurityKeys: + title: Google credentials type: object properties: discriminator: @@ -11436,10 +11691,12 @@ components: type: string writeOnly: true GridPlatformMetainfo: + title: Grid platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type Image: required: - arch @@ -11506,14 +11763,26 @@ components: title: Kubernetes compute configuration type: object properties: - discriminator: - type: string workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform server: type: string sslCert: @@ -11534,24 +11803,21 @@ components: type: string servicePodSpec: type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" headJobCpus: type: integer format: int32 headJobMemoryMb: type: integer format: int32 - nextflowConfig: - type: string K8sPlatformMetaInfo: + title: Kubernetes platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type K8sSecurityKeys: + title: Kubernetes credentials type: object properties: discriminator: @@ -11974,6 +12240,8 @@ components: totalSize: type: integer format: int64 + hasMore: + type: boolean ListWorkflowsResponse.ListWorkflowsElement: type: object properties: @@ -12027,29 +12295,37 @@ components: title: Local execution configuration type: object properties: - discriminator: - type: string workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." environment: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform waveEnabled: type: boolean fusion2Enabled: type: boolean - nextflowConfig: - type: string LocalPlatformMetainfo: + title: Local platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type LocalSecurityKeys: title: Local security keys type: object @@ -12088,71 +12364,75 @@ components: $ref: "#/components/schemas/Iterator_String_" rewindToken: type: string - forwardToken: + forwardToken: + type: string + pending: + type: boolean + message: + type: string + downloads: + type: array + items: + $ref: "#/components/schemas/LogPage.Download" + LogPage.Download: + type: object + properties: + saveName: + type: string + fileName: + type: string + displayText: + type: string + LsfComputeConfig: + title: IBM LSF configuration + type: object + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: type: string - pending: - type: boolean - message: + hostName: type: string - downloads: - type: array - items: - $ref: "#/components/schemas/LogPage.Download" - LogPage.Download: - type: object - properties: - saveName: + port: + type: integer + format: int32 + headQueue: type: string - fileName: + computeQueue: type: string - displayText: + maxQueueSize: + type: integer + format: int32 + headJobOptions: type: string - LsfComputeConfig: - title: IBM LSF configuration - type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - unitForLimits: - type: string - perJobMemLimit: - type: boolean - perTaskReserve: - type: boolean - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" + propagateHeadJobOptions: + type: boolean + unitForLimits: + type: string + perJobMemLimit: + type: boolean + perTaskReserve: + type: boolean ManagedCredentialsDbDto: type: object properties: @@ -12214,43 +12494,47 @@ components: MoabComputeConfig: title: Moab configuration type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean MultiRequestFileSchema: type: object properties: @@ -12427,6 +12711,9 @@ components: maxFusionThroughputBytes: type: integer format: int64 + maxCustomRolesPerOrg: + type: integer + format: int64 ParticipantResponseDto: type: object properties: @@ -12629,6 +12916,10 @@ components: readOnly: true PlatformMetainfo: type: object + properties: + discriminator: + type: string + description: property to select the platform metainfo type discriminator: propertyName: discriminator mapping: @@ -12904,6 +13195,7 @@ components: state: $ref: "#/components/schemas/State" S3SecurityKeys: + title: S3-compatible credentials type: object properties: discriminator: @@ -12916,6 +13208,7 @@ components: pathStyleAccessEnabled: type: boolean SSHSecurityKeys: + title: SSH credentials type: object properties: discriminator: @@ -12940,7 +13233,6 @@ components: properties: discriminator: type: string - readOnly: true discriminator: propertyName: discriminator mapping: @@ -12981,33 +13273,51 @@ components: - $ref: "#/components/schemas/SeqeraComputeSecurityKeys" - $ref: "#/components/schemas/S3SecurityKeys" - $ref: "#/components/schemas/LocalSecurityKeys" + SeqeraComputeCloudInstanceTypeSize: + type: string + enum: + - SMALL + - MEDIUM + - LARGE SeqeraComputeConfig: title: Seqera Compute configuration type: object properties: - discriminator: - type: string - region: - type: string workDir: type: string + description: Compute environment working directory preRunScript: type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string - defaultDataRetentionPolicy: - type: boolean - nextflowConfig: - type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." environment: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + region: + type: string + defaultDataRetentionPolicy: + type: boolean + instanceTypeSize: + description: "Size of the Data Studios instance (SMALL, MEDIUM, LARGE)" + allOf: + - $ref: "#/components/schemas/SeqeraComputeCloudInstanceTypeSize" SeqeraComputePlatformMetainfo: + title: Seqera Compute platform metainfo type: object properties: discriminator: type: string + description: property to select the platform metainfo type warnings: type: array items: @@ -13061,12 +13371,18 @@ components: items: $ref: "#/components/schemas/InstanceType" SeqeraComputeSecurityKeys: + title: Seqera Compute credentials type: object - allOf: - - $ref: "#/components/schemas/AwsSecurityKeys" - - properties: - discriminator: - type: string + properties: + discriminator: + type: string + accessKey: + type: string + secretKey: + type: string + writeOnly: true + assumeRoleArn: + type: string ServiceInfo: type: object properties: @@ -13083,9 +13399,7 @@ components: loginPath: type: string navbar: - deprecated: true - allOf: - - $ref: "#/components/schemas/NavbarConfig" + $ref: "#/components/schemas/NavbarConfig" heartbeatInterval: type: integer format: int32 @@ -13145,43 +13459,47 @@ components: SlurmComputeConfig: title: Slurm configuration type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean State: type: string enum: @@ -13358,6 +13676,9 @@ components: invCtxt: type: integer format: int64 + numSpotInterruptions: + type: integer + format: int32 exit: type: integer format: int32 @@ -13555,6 +13876,9 @@ components: peakMemory: type: integer format: int64 + numSpotInterruptions: + type: integer + format: int32 processes: type: array items: @@ -13637,43 +13961,47 @@ components: UnivaComputeConfig: title: Univa Grid Engine configuration type: object - allOf: - - $ref: "#/components/schemas/AbstractGridConfig" - - properties: - discriminator: - type: string - workDir: - type: string - launchDir: - type: string - userName: - type: string - hostName: - type: string - port: - type: integer - format: int32 - headQueue: - type: string - computeQueue: - type: string - maxQueueSize: - type: integer - format: int32 - headJobOptions: - type: string - propagateHeadJobOptions: - type: boolean - preRunScript: - type: string - postRunScript: - type: string - nextflowConfig: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" + properties: + workDir: + type: string + description: Compute environment working directory + preRunScript: + type: string + description: "Add a script that executes in the nf-launch script prior to\ + \ invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Add a script that executes after all Nextflow processes have\ + \ completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + discriminator: + type: string + description: property to select the compute config platform + launchDir: + type: string + userName: + type: string + hostName: + type: string + port: + type: integer + format: int32 + headQueue: + type: string + computeQueue: + type: string + maxQueueSize: + type: integer + format: int32 + headJobOptions: + type: string + propagateHeadJobOptions: + type: boolean UpdateActionRequest: type: object properties: @@ -14534,6 +14862,9 @@ components: peakMemory: type: integer format: int64 + numSpotInterruptions: + type: integer + format: int32 cost: type: number netCpus: diff --git a/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml b/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml index 9a31bc445..060b4c912 100644 --- a/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml +++ b/platform-api-docs/scripts/specs/seqera-api-latest-decorated.yml @@ -5,53 +5,10 @@ info: contact: url: https://seqera.io email: info@seqera.io - version: 1.95.0 + version: 1.102.0 servers: - url: https://api.cloud.seqera.io description: Seqera Platform Cloud API -tags: - - name: actions - description: Pipeline actions - - name: avatars - description: Avatars - - name: compute-envs - description: Compute environments - - name: credentials - description: Credentials - - name: data-links - description: Cloud storage directory paths in Data Explorer - - name: datasets - description: Pipeline input datasets (samplesheets) in CSV or TSV format - - name: ga4gh - description: GA4GH workflow execution service runs - - name: labels - description: Labels and resource labels - - name: launch - description: Workflow launch events - - name: orgs - description: Organizations - - name: pipelines - description: Pipelines - - name: pipeline-secrets - description: Pipeline secrets in a user or workspace context - - name: platforms - description: Computing platforms - - name: service-info - description: Seqera Platform API service information - - name: studios - description: Studios and Studio sessions - - name: teams - description: Teams in an organization context - - name: tokens - description: API access tokens - - name: trace - description: Workflow execution traces - - name: users - description: Users - - name: workflows - description: Workflow executions - - name: workspaces - description: Workspaces in an organization context paths: /actions: get: @@ -560,7 +517,7 @@ paths: description: Filter by compute environment status. schema: type: string - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "CREATING", "AVAILABLE", "ERRORED", "INVALID"] + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] - name: workspaceId in: query description: Workspace numeric identifier. If omitted, lists compute environments in a user context. @@ -806,7 +763,7 @@ paths: items: $ref: "#/components/schemas/ComputeEnvQueryAttribute" type: string - enum: ["labels", "labels"] + enum: ["labels"] responses: "200": description: OK @@ -1456,41 +1413,35 @@ paths: get: tags: - data-links - summary: Explore data-link path - description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." + summary: Explore data-link + description: "Retrieves the content of the data-link associated with the given `dataLinkId`." operationId: ExploreDataLink parameters: - name: dataLinkId in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: path - in: path - description: Content path + description: "Data-link string identifier." required: true schema: type: string - name: workspaceId in: query - description: Workspace numeric identifier + description: "Workspace numeric identifier." schema: type: integer format: int64 - name: credentialsId in: query - description: Credentials string identifier + description: "Credentials string identifier." schema: type: string - name: search in: query - description: Prefix search of data-link content + description: "Prefix search of data-link content." schema: type: string - name: nextPageToken in: query - description: Token used to fetch the next page of items + description: "Token used to fetch the next page of items." schema: type: string - name: pageSize @@ -1583,7 +1534,7 @@ paths: - data-links summary: Explore data-link path description: "Retrieves the content of the data-link associated with the given `dataLinkId`, at the given `path`." - operationId: ExploreDataLink_1 + operationId: ExploreDataLinkWithPath parameters: - name: dataLinkId in: path @@ -1702,61 +1653,6 @@ paths: description: Operation not allowed security: - BearerAuth: [] - /data-links/{dataLinkId}/download: - get: - tags: - - data-links - summary: Download data-link file at path - description: Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`. - operationId: DownloadDataLink - parameters: - - name: dataLinkId - in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: filePath - in: path - description: File path to download - required: true - schema: - type: string - - name: credentialsId - in: query - description: Credentials string identifier - schema: - type: string - - name: workspaceId - in: query - description: Workspace numeric identifier - schema: - type: integer - format: int64 - responses: - "200": - description: OK - content: - application/json: - schema: - type: string - format: binary - "400": - description: BadRequest - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorResponse" - "403": - description: Operation not allowed - security: - - BearerAuth: [] /data-links/{dataLinkId}/generate-download-url: get: tags: @@ -1881,32 +1777,25 @@ paths: post: tags: - data-links - summary: Generate data-link file upload URL (to given path) + summary: Generate data-link file upload URL description: |- - Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). - For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. + Creates a URL to upload files to the data-link associated with the given `dataLinkId`. For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. operationId: GenerateDataLinkUploadUrl parameters: - name: dataLinkId in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory + description: "Data-link string identifier." required: true schema: type: string - name: credentialsId in: query - description: Credentials string identifier + description: "Credentials string identifier." schema: type: string - name: workspaceId in: query - description: Workspace numeric identifier + description: "Workspace numeric identifier." schema: type: integer format: int64 @@ -1948,30 +1837,24 @@ paths: post: tags: - data-links - summary: Finish data-link file upload to given path - description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." + summary: Finish data-link file upload + description: "Finish upload of a data-link file. This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." operationId: FinishDataLinkUpload parameters: - name: dataLinkId in: path - description: Data-link string identifier - required: true - schema: - type: string - - name: dirPath - in: path - description: Path to the destination directory + description: "Data-link string identifier." required: true schema: type: string - name: credentialsId in: query - description: Credentials string identifier + description: "Credentials string identifier." schema: type: string - name: workspaceId in: query - description: Workspace numeric identifier + description: "Workspace numeric identifier." schema: type: integer format: int64 @@ -1991,7 +1874,7 @@ paths: schema: $ref: "#/components/schemas/ErrorResponse" "404": - description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found" + description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link not found." content: application/json: schema: @@ -2012,7 +1895,7 @@ paths: - data-links summary: Finish data-link file upload to given path description: "Finish upload of a data-link file, specifying a file path (`dirPath`). This is necessary for AWS S3 data-links (`DataLinkProvider=aws`) to finalize a successful file upload, or abort an upload if an error was encountered while uploading a file using an upload URL from the `/upload` endpoint." - operationId: FinishDataLinkUpload_1 + operationId: FinishDataLinkUploadWithPath parameters: - name: dataLinkId in: path @@ -2061,7 +1944,7 @@ paths: "403": description: Operation not allowed "200": - description: FinishDataLinkUpload_1 200 response + description: FinishDataLinkUploadWithPath 200 response. content: application/json: schema: @@ -2076,7 +1959,7 @@ paths: description: |- Creates a URL to upload files to the data-link associated with the given `dataLinkId`, specifying a file path (`dirPath`). For AWS S3 data-links, an additional follow-up request must be sent after your file upload has completed (or encountered an error) to finalize the upload - see the `/upload/finish` endpoint. - operationId: GenerateDataLinkUploadUrl_1 + operationId: GenerateDataLinkUploadUrlWithPath parameters: - name: dataLinkId in: path @@ -7110,7 +6993,10 @@ paths: tags: - workflows summary: Launch workflow - description: Submits a workflow execution. + description: | + Submits a workflow execution. + + **To [resume](https://docs.seqera.io/platform-cloud/launch/cache-resume#resume-a-workflow-run) a workflow**: First, retrieve the launch configuration using [`GET /workflow/{workflowId}/launch`](https://docs.seqera.io/platform-api/describe-workflow-launch). Then modify the response by setting `workDir` to the value from `resumeDir`, `revision` to the value from `resumeCommitId`, and `resume` to `true`. Submit the modified payload to this endpoint to resume the workflow. operationId: CreateWorkflowLaunch parameters: - name: workspaceId @@ -8268,6 +8154,61 @@ paths: deprecated: true security: - BearerAuth: [] + /data-links/{dataLinkId}/download/{filePath}: + get: + tags: + - data-links + summary: "Download data-link file at path" + description: "Downloads the content at the given `filePath` in the data-link associated with the given `dataLinkId`." + operationId: DownloadDataLink + parameters: + - name: dataLinkId + in: path + description: "Data-link string identifier." + required: true + schema: + type: string + - name: filePath + in: path + description: "Resource path of the file to download." + required: true + schema: + type: string + - name: credentialsId + in: query + description: "Credentials string identifier." + schema: + type: string + - name: workspaceId + in: query + description: "Workspace numeric identifier." + schema: + type: integer + format: int64 + responses: + "200": + description: "OK." + content: + application/json: + schema: + type: string + format: binary + "400": + description: "Bad request." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: "NotFound — workspace or credentials not found, API disabled for the workspace, or data-link or path not found." + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: "Operation not allowed." + security: + - BearerAuth: [] components: schemas: AbstractGridConfig: @@ -8275,45 +8216,45 @@ components: properties: workDir: type: string - description: Nextflow work directory on the cluster's shared file system. Must be an absolute path and credentials must have read-write access. + description: Compute environment working directory. preRunScript: type: string - description: "Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + description: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." postRunScript: type: string - description: "Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + description: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." nextflowConfig: type: string - description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." + description: "Additional Nextflow configuration content." launchDir: type: string - description: "Directory where Nextflow runs. Must be an absolute path and credentials must have read-write access. If omitted, defaults to `workDir`." + description: "Launch directory for Nextflow execution." userName: type: string - description: "Username for SSH connection to HPC head node." + description: "Username for SSH authentication to the HPC cluster." hostName: type: string - description: "Hostname or IP address of HPC head node." + description: "Hostname or IP address of the HPC cluster head node." port: type: integer format: int32 - description: "SSH port. Default: `22`." + description: "SSH port for connecting to the HPC cluster. Default: `22`." headQueue: type: string - description: "The name of the queue on the cluster used to launch the Nextflow execution." + description: "Queue name for submitting the Nextflow head job." computeQueue: type: string - description: "The name of queue on the cluster to which pipeline jobs are submitted. Can be overridden by the pipeline configuration." + description: "Queue name for submitting Nextflow compute jobs." maxQueueSize: type: integer format: int32 - description: "The maximum number of jobs Nextflow can submit to the queue simultaneously. Default: `100`." + description: "Maximum number of jobs that can be queued at one time." headJobOptions: type: string - description: "Additional submit options for the Nextflow head job." + description: "Additional options for the head job submission." propagateHeadJobOptions: type: boolean - description: "If true, `headJobOptions` are also applied to the Nextflow-submitted compute jobs." + description: "If true, head job options are propagated to compute jobs. Default: `false`." AccessToken: required: - name @@ -8673,7 +8614,7 @@ components: type: object additionalProperties: true description: "Resources created by Batch Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] + required: ["region", "workDir"] AwsBatchPlatformMetainfo: type: object properties: @@ -8803,7 +8744,7 @@ components: type: object additionalProperties: true description: "Resources created by Cloud Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] + required: ["region", "workDir"] AwsCloudPlatformMetainfo: type: object properties: @@ -8888,7 +8829,7 @@ components: deleteJobsOnCompletion: $ref: "#/components/schemas/JobCleanupPolicy" description: "Automatically delete Batch jobs after completion." - enum: ["on_success", "always", "never", "on_success", "always", "never"] + enum: ["on_success", "always", "never"] deletePoolsOnCompletion: type: boolean description: "Automatically delete Batch pools after completion. Default: `false`." @@ -8909,7 +8850,7 @@ components: type: string nullable: true description: "The ID of a [managed identity client](https://docs.seqera.io/platform-cloud/compute-envs/azure-batch#managed-identity) attached to the Azure Batch Pool, used by Nextflow to authenticate to Azure Batch and Storage." - required: ["region", "workDir", "region", "workDir"] + required: ["region", "workDir"] AzBatchForgeConfig: type: object properties: @@ -9015,7 +8956,7 @@ components: items: $ref: "#/components/schemas/Map.Entry_String.String_" description: "Resources created by Cloud Forge (read-only)." - required: ["location", "workDir", "location", "workDir"] + required: ["location", "workDir"] AzureEntraKeys: type: object allOf: @@ -9137,15 +9078,15 @@ components: azure-batch: "#/components/schemas/AzBatchConfig" seqeracompute-platform: "#/components/schemas/SeqeraComputeConfig" eks-platform: "#/components/schemas/EksComputeConfig" - google-lifesciences: "#/components/schemas/GoogleLifeSciencesConfig" uge-platform: "#/components/schemas/UnivaComputeConfig" oneOf: - $ref: "#/components/schemas/AwsBatchConfig" - $ref: "#/components/schemas/AwsCloudConfig" - $ref: "#/components/schemas/SeqeraComputeConfig" - - $ref: "#/components/schemas/GoogleLifeSciencesConfig" - $ref: "#/components/schemas/GoogleBatchConfig" + - $ref: "#/components/schemas/GoogleCloudConfig" - $ref: "#/components/schemas/AzBatchConfig" + - $ref: "#/components/schemas/AzCloudConfig" - $ref: "#/components/schemas/LsfComputeConfig" - $ref: "#/components/schemas/SlurmComputeConfig" - $ref: "#/components/schemas/K8sComputeConfig" @@ -9154,6 +9095,7 @@ components: - $ref: "#/components/schemas/UnivaComputeConfig" - $ref: "#/components/schemas/AltairPbsComputeConfig" - $ref: "#/components/schemas/MoabComputeConfig" + - $ref: "#/components/schemas/LocalComputeConfig" ComputeEnv.Status: type: string readOnly: true @@ -9192,19 +9134,18 @@ components: platform: type: string enum: - - aws-batch - - aws-cloud - - seqeracompute-platform - - google-lifesciences - - google-batch - - azure-batch - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform + - "aws-batch" + - "aws-cloud" + - "seqeracompute-platform" + - "google-batch" + - "azure-batch" + - "k8s-platform" + - "eks-platform" + - "gke-platform" + - "uge-platform" + - "slurm-platform" + - "lsf-platform" + - "altair-platform" config: $ref: "#/components/schemas/ComputeConfig" dateCreated: @@ -9239,16 +9180,6 @@ components: items: $ref: "#/components/schemas/LabelDbDto" ComputeEnv_ComputeConfig_: - required: - - config - - name - - platform - - "name" - - "platform" - - "config" - - "name" - - "platform" - - "config" type: object properties: credentialsId: @@ -9280,39 +9211,8 @@ components: platform: maxLength: 25 type: string + description: "Compute platform provider." enum: - - aws-batch - - aws-cloud - - google-lifesciences - - google-batch - - google-cloud - - azure-batch - - azure-cloud - - k8s-platform - - eks-platform - - gke-platform - - uge-platform - - slurm-platform - - lsf-platform - - altair-platform - - moab-platform - - local-platform - - seqeracompute-platform - - "aws-batch" - - "aws-cloud" - - "google-batch" - - "google-cloud" - - "azure-batch" - - "k8s-platform" - - "eks-platform" - - "gke-platform" - - "slurm-platform" - - "lsf-platform" - - "uge-platform" - - "moab-platform" - - "altair-platform" - - "local-platform" - - "seqeracompute-platform" - "aws-batch" - "aws-cloud" - "google-batch" @@ -9322,14 +9222,13 @@ components: - "k8s-platform" - "eks-platform" - "gke-platform" + - "uge-platform" - "slurm-platform" - "lsf-platform" - - "uge-platform" - - "moab-platform" - "altair-platform" + - "moab-platform" - "local-platform" - "seqeracompute-platform" - description: "Compute platform provider." config: $ref: "#/components/schemas/ComputeConfig" description: "Platform-specific configuration. Structure depends on the selected platform." @@ -9358,13 +9257,14 @@ components: allOf: - $ref: "#/components/schemas/ComputeEnv.Status" description: "Current status of the compute environment (read-only)." - enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID", "CREATING", "AVAILABLE", "ERRORED", "INVALID"] + enum: ["CREATING", "AVAILABLE", "ERRORED", "INVALID"] message: maxLength: 4096 type: string primary: type: boolean readOnly: true + required: ["config", "name", "platform"] ComputePlatform: type: object properties: @@ -9405,7 +9305,7 @@ components: compute: type: boolean description: "Apply this variable to the Nextflow compute jobs." - required: ["name", "value", "name", "value"] + required: ["name", "value"] ContainerData: required: - targetImage @@ -9488,7 +9388,7 @@ components: type: integer format: int64 description: "Array of label IDs to assign to the compute environment." - required: ["computeEnv", "computeEnv"] + required: ["computeEnv"] CreateComputeEnvResponse: type: object properties: @@ -11001,7 +10901,7 @@ components: type: boolean waveEnabled: type: boolean - required: ["region", "clusterName", "workDir", "region", "clusterName", "workDir"] + required: ["region", "clusterName", "workDir"] GkePlatformMetaInfo: type: object properties: @@ -11113,7 +11013,7 @@ components: computeJobsInstanceTemplate: type: string description: "Specify the name or fully-qualified reference of a [VM instance template](https://cloud.google.com/compute/docs/instance-templates), without the `template://` prefix, to use for Nextflow compute jobs." - required: ["location", "workDir", "location", "workDir"] + required: ["location", "workDir"] GoogleBucket: type: object properties: @@ -11182,7 +11082,7 @@ components: type: object additionalProperties: true description: "Resources created by Cloud Forge (read-only)." - required: ["region", "workDir", "region", "workDir"] + required: ["region", "workDir"] GoogleCloudPlatformMetaInfo: type: object properties: @@ -11226,66 +11126,6 @@ components: type: string arch: type: string - GoogleLifeSciencesConfig: - title: Google life sciences configuration - type: object - properties: - discriminator: - type: string - description: property to select the compute config platform - readOnly: true - region: - type: string - zones: - type: array - items: - type: string - location: - type: string - workDir: - type: string - preemptible: - type: boolean - bootDiskSizeGb: - type: integer - format: int32 - projectId: - type: string - sshDaemon: - type: boolean - sshImage: - type: string - debugMode: - type: integer - format: int32 - copyImage: - type: string - usePrivateAddress: - type: boolean - labels: - type: object - additionalProperties: - type: string - preRunScript: - type: string - postRunScript: - type: string - headJobCpus: - type: integer - format: int32 - headJobMemoryMb: - type: integer - format: int32 - nextflowConfig: - type: string - nfsTarget: - type: string - nfsMount: - type: string - environment: - type: array - items: - $ref: "#/components/schemas/ConfigEnvVariable" GooglePlatformMetainfo: type: object properties: @@ -11441,7 +11281,7 @@ components: podCleanup: $ref: "#/components/schemas/PodCleanupPolicy" description: "Pod cleanup policy after job completion." - enum: ["on_success", "always", "never", "on_success", "always", "never"] + enum: ["on_success", "always", "never"] headPodSpec: type: string description: "Custom configuration for the pod running the Nextflow head job, e.g., `nodeSelector` and `affinity` constraints. Must be a valid PodSpec YAML structure starting with `spec:`." @@ -11463,7 +11303,7 @@ components: nextflowConfig: type: string description: "Additional Nextflow configuration to apply. See [Nextflow config file](https://docs.seqera.io/platform-cloud/launch/advanced#nextflow-config-file)." - required: ["server", "sslCert", "workDir", "server", "sslCert", "workDir"] + required: ["server", "sslCert", "workDir"] K8sPlatformMetaInfo: type: object properties: @@ -12833,7 +12673,7 @@ components: type: array items: $ref: "#/components/schemas/ConfigEnvVariable" - required: ["region", "workDir", "region", "workDir"] + required: ["region", "workDir"] SeqeraComputePlatformDescriber: type: object SeqeraComputePlatformMetainfo: @@ -14614,8 +14454,84 @@ components: participantRole: type: string description: "Participant role within the workspace." + LocalComputeConfig: + type: object + title: Local execution configuration + properties: + workDir: + type: string + description: "Compute environment working directory." + preRunScript: + type: string + description: "Script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + postRunScript: + type: string + description: "Script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts)." + environment: + type: array + description: "Array of environment variables for the compute environment." + items: + $ref: "#/components/schemas/ConfigEnvVariable" + nextflowConfig: + type: string + description: "Additional Nextflow configuration content." + discriminator: + type: string + description: "Property to select the compute config platform." + readOnly: true + waveEnabled: + type: boolean + description: "Enable Wave containers support. See [Wave containers](https://docs.seqera.io/platform-cloud/supported_software/wave)." + fusion2Enabled: + type: boolean + description: "Enable Fusion v2 virtual distributed file system. See [Fusion file system](https://docs.seqera.io/platform-cloud/supported_software/fusion)." securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: jwt +tags: + - name: actions + description: Pipeline actions + - name: avatars + description: Avatars + - name: compute-envs + description: Compute environments + - name: credentials + description: Credentials + - name: data-links + description: Cloud storage directory paths in Data Explorer + - name: datasets + description: Pipeline input datasets (samplesheets) in CSV or TSV format + - name: ga4gh + description: GA4GH workflow execution service runs + - name: identities + description: Managed identities for centralized credential management + - name: labels + description: Labels and resource labels + - name: launch + description: Workflow launch events + - name: orgs + description: Organizations + - name: pipelines + description: Pipelines + - name: pipeline-secrets + description: Pipeline secrets in a user or workspace context + - name: platforms + description: Computing platforms + - name: service-info + description: Seqera Platform API service information + - name: studios + description: Studios and Studio sessions + - name: teams + description: Teams in an organization context + - name: tokens + description: API access tokens + - name: trace + description: Workflow execution traces + - name: users + description: Users + - name: workflows + description: Workflow executions + - name: workspaces + description: Workspaces in an organization context