-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Context
This issue tracks the consolidation of duplicate OpenAPI specification files identified in PR #26.
Current state:
packages/examples/resources/train-travel.yamlpackages/zenko/src/resources/train-travel.yaml
These files are currently identical copies, which increases maintenance burden and risk of divergence.
Related PR: #26
Discussion: #26 (comment)
Proposed Solutions
Consider one of these approaches:
1. Use symbolic links
Move the canonical spec to one location and create symlinks from the other package(s):
cd packages/examples/resources
ln -s ../../zenko/src/resources/train-travel.yaml train-travel.yaml2. Shared location at repo root
Move the spec to a shared location (e.g., specs/train-travel.yaml at the monorepo root) and reference it from both packages.
3. Document intentional duplication
If duplication is intentional (e.g., examples should be self-contained), add a comment at the top of both files indicating they should be kept in sync, and consider adding a test to verify they match.
Acceptance Criteria
- Canonical location established for train-travel.yaml
- Duplicate eliminated or documented with sync mechanism
- CI check added to prevent future drift (if using symlinks or requiring sync)
- Documentation updated if necessary
Target: Future resources package PR
Metadata
Metadata
Assignees
Labels
No labels