Skip to content

Commit 71dda58

Browse files
github-actions[bot]llewellyn-slbebosudoCopilotclaude
authored
API Documentation Updates for v1.97 (#983)
* Draft: API docs overlays for v1.96 * chore: Add helm to v25.3 sidebar, bump helm chart to v0.20.1 (#986) * Add helm to v25.3 sidebar * Bump helm chart version to 0.20.1 * Add all available seqera compute regions to Platform Cloud docs (#988) * Add all available seqera compute regions to Platform Cloud docs * Expand SA into South Africa Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> --------- Signed-off-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add API docs phase 2 automation workflows (#991) * Add phase 2 automation workflows * Add claude-generated-overlays.md to YAML extraction * Update apply-overlays-and-regenerate.yml * Fix YML extension handling in regenerate GH workflow * Add logging to phase 2 workflow to troubleshooting failing spec validation * Fix another batch of YAML extension handling issues * Improved stdout and stderr and better error handling * Fix branch fetching and commits so files actually show up * Fix version detection picking up "latest decorated" * Document array replacement pattern and apply schema deduplication Add critical guidance on using remove-then-update pattern when replacing arrays (enums, required fields) in OpenAPI overlays. Direct update actions append to existing arrays instead of replacing them, creating invalid YAML with duplicate values. Documentation changes: - Add "Array Replacement Pattern" section to overlay-patterns.md with detailed examples of the problem and solution - Add troubleshooting guidance to platform-api-docs/README.md - Include examples for fixing duplicate required fields and enums - Add workflow progress log (claude-progress.md) Spec improvements: - Apply schema deduplication overlay to decorated spec - Fix 12 validate-json-schema errors (duplicate items in required arrays) - Archive schema-required-duplicates-overlay-1.96.yaml - Replace seqera-api-latest-decorated.yml with deduplicated .yaml version Cleanup: - Remove intermediate backup files - Remove unused data-links path params overlay (API design issue) - Keep only clean deduplicated decorated spec The decorated spec now passes all schema validation checks except for the 4 known path-params errors requiring backend API fixes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Remove intermediate files to be recreated by workflow * Put back 1.96 spec to fix workflow * Fix workflow to accept flattened spec, decorate flatten spec, update docs for v1.97 --------- Signed-off-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Co-authored-by: Llewellyn vd Berg <113503285+llewellyn-sl@users.noreply.github.com> Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 2b5e977 commit 71dda58

File tree

219 files changed

+17999
-1996
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

219 files changed

+17999
-1996
lines changed

.claude/skills/openapi-overlay-generator/references/overlay-patterns.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,67 @@ $.components.schemas.DatasetRequest.required
350350

351351
---
352352

353+
## Array Replacement Pattern
354+
355+
**CRITICAL**: When replacing array values (enums, required fields, etc.), the `update` action will APPEND to existing arrays instead of replacing them. This creates invalid YAML and duplicate values.
356+
357+
### The Problem
358+
359+
**WRONG - Direct update appends to array**
360+
```yaml
361+
# This will APPEND to the existing array, creating duplicates!
362+
- target: "$.components.schemas.AwsBatchConfig.required"
363+
update:
364+
- region
365+
- workDir
366+
```
367+
368+
Result: `required: ["region", "workDir", "region", "workDir", region, workDir]` (INVALID!)
369+
370+
### The Solution
371+
372+
✅ **CORRECT - Remove then update**
373+
```yaml
374+
# Step 1: Remove the existing array
375+
- target: "$.components.schemas.AwsBatchConfig.required"
376+
remove: true
377+
378+
# Step 2: Add back the corrected array
379+
- target: "$.components.schemas.AwsBatchConfig"
380+
update:
381+
required:
382+
- region
383+
- workDir
384+
```
385+
386+
Result: `required: ["region", "workDir"]` (VALID!)
387+
388+
### When to Use This Pattern
389+
390+
Use the remove-then-update pattern for:
391+
- **Required field arrays**: Fixing duplicate entries in schema required fields
392+
- **Enum arrays**: Correcting duplicate enum values
393+
- **Any array that needs complete replacement**: When you need to change the entire array content
394+
395+
### Example: Fixing Duplicate Enums
396+
397+
```yaml
398+
# Remove duplicate enum values
399+
- target: "$.components.schemas.WorkflowStatus.properties.status.enum"
400+
remove: true
401+
402+
- target: "$.components.schemas.WorkflowStatus.properties.status"
403+
update:
404+
enum:
405+
- SUBMITTED
406+
- RUNNING
407+
- SUCCEEDED
408+
- FAILED
409+
- CANCELLED
410+
```
411+
412+
---
413+
353414
## Common Mistakes to Avoid
354415

355416
❌ **Summaries with periods**

0 commit comments

Comments
 (0)