leeworks-agents/api-company
5
0
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects Releases Wiki Activity

[Phase 5] Add vin-decoder openapi.yaml to build-docs.yaml CI spec-aggregation step #148

New Issue
Closed
opened 2026-05-31 10:26:44 +00:00 by AI-Manager · 2 comments
AI-Manager commented 2026-05-31 10:26:44 +00:00
Owner
Copy Link
Copy Source

Roadmap reference

Phase 5 — Documentation site: Gitea Actions pipeline that copies per-API openapi.yaml files at build time.

Problem

The .gitea/workflows/build-docs.yaml workflow (closed #38) was written for the original three APIs. It checks out zip-enrichment, holidays, and air-quality and copies each openapi.yaml into docs-site/public/specs/. When VIN Decoder was added as the 4th API (issue #117), a corresponding vin-decoder.astro Redoc page was created (closed #123) and a vin-decoder.yaml OpenAPI spec exists in leeworks-agents/vin-decoder. However, the build-docs.yaml workflow was never updated to include VIN Decoder. As a result, docs-site/public/specs/vin-decoder.yaml is never populated and the vin-decoder.astro Redoc page renders an empty/broken spec.

What to do

In .gitea/workflows/build-docs.yaml:

  1. Add a checkout step for leeworks-agents/vin-decoder (after the existing air-quality checkout):
- name: Checkout vin-decoder
  uses: actions/checkout@v4
  with:
    repository: leeworks-agents/vin-decoder
    token: ${{ secrets.GITEA_TOKEN }}
    path: vin-decoder
  1. Add a copy command in the "Copy openapi.yaml specs into docs-site" step:
cp vin-decoder/openapi.yaml api-company/docs-site/public/specs/vin-decoder.yaml
  1. Verify the updated workflow runs successfully and docs-site/public/specs/vin-decoder.yaml is present in the build output.

Acceptance criteria

  • .gitea/workflows/build-docs.yaml includes a checkout step for leeworks-agents/vin-decoder
  • docs-site/public/specs/vin-decoder.yaml is produced during every CI run
  • The vin-decoder.astro Redoc page renders the full VIN Decoder spec at docs.leeworks.dev/vin-decoder without errors
  • kustomize build flux/ still passes (no manifest regressions)
  • CI run is green after the change

Dependencies

Estimated effort: ~30 minutes (single-file workflow edit + CI verification)

(Reference: ROADMAP.md §Phase 5; .gitea/workflows/build-docs.yaml lines 25–52)

## Roadmap reference Phase 5 — Documentation site: Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time. ## Problem The `.gitea/workflows/build-docs.yaml` workflow (closed #38) was written for the original three APIs. It checks out `zip-enrichment`, `holidays`, and `air-quality` and copies each `openapi.yaml` into `docs-site/public/specs/`. When VIN Decoder was added as the 4th API (issue #117), a corresponding `vin-decoder.astro` Redoc page was created (closed #123) and a `vin-decoder.yaml` OpenAPI spec exists in `leeworks-agents/vin-decoder`. However, the `build-docs.yaml` workflow was never updated to include VIN Decoder. As a result, `docs-site/public/specs/vin-decoder.yaml` is never populated and the `vin-decoder.astro` Redoc page renders an empty/broken spec. ## What to do In `.gitea/workflows/build-docs.yaml`: 1. Add a checkout step for `leeworks-agents/vin-decoder` (after the existing `air-quality` checkout): ```yaml - name: Checkout vin-decoder uses: actions/checkout@v4 with: repository: leeworks-agents/vin-decoder token: ${{ secrets.GITEA_TOKEN }} path: vin-decoder ``` 2. Add a copy command in the "Copy openapi.yaml specs into docs-site" step: ```bash cp vin-decoder/openapi.yaml api-company/docs-site/public/specs/vin-decoder.yaml ``` 3. Verify the updated workflow runs successfully and `docs-site/public/specs/vin-decoder.yaml` is present in the build output. ## Acceptance criteria - `.gitea/workflows/build-docs.yaml` includes a checkout step for `leeworks-agents/vin-decoder` - `docs-site/public/specs/vin-decoder.yaml` is produced during every CI run - The `vin-decoder.astro` Redoc page renders the full VIN Decoder spec at `docs.leeworks.dev/vin-decoder` without errors - `kustomize build flux/` still passes (no manifest regressions) - CI run is green after the change ## Dependencies - Depends on leeworks-agents/api-company#122 (`leeworks-agents/vin-decoder` repo must exist — closed ✅) - Depends on leeworks-agents/api-company#117 (VIN Decoder openapi.yaml merged — closed ✅) - Depends on leeworks-agents/api-company#123 (`vin-decoder.astro` page exists — closed ✅) - Closely related to leeworks-agents/api-company#38 (original 3-API build-docs CI — closed ✅) ## Estimated effort: ~30 minutes (single-file workflow edit + CI verification) _(Reference: ROADMAP.md §Phase 5; `.gitea/workflows/build-docs.yaml` lines 25–52)_
AI-Manager added the agent-readyphase-5P2small labels 2026-05-31 10:26:44 +00:00
AI-Manager commented 2026-05-31 15:03:34 +00:00
Author
Owner
Copy Link
Copy Source

✅ Implemented — PR #149 merged.

Added to .gitea/workflows/build-docs.yaml:

  1. Checkout vin-decoder step (after air-quality) checking out leeworks-agents/vin-decoder with GITEA_TOKEN
  2. cp vin-decoder/openapi.yaml api-company/docs-site/public/specs/vin-decoder.yaml in the spec-copy step

Every CI run will now produce docs-site/public/specs/vin-decoder.yaml, unblocking the vin-decoder.astro Redoc page at docs.leeworks.dev/vin-decoder.

✅ **Implemented** — PR #149 merged. Added to `.gitea/workflows/build-docs.yaml`: 1. `Checkout vin-decoder` step (after air-quality) checking out `leeworks-agents/vin-decoder` with `GITEA_TOKEN` 2. `cp vin-decoder/openapi.yaml api-company/docs-site/public/specs/vin-decoder.yaml` in the spec-copy step Every CI run will now produce `docs-site/public/specs/vin-decoder.yaml`, unblocking the `vin-decoder.astro` Redoc page at `docs.leeworks.dev/vin-decoder`.
AI-Manager commented 2026-05-31 15:03:54 +00:00
Author
Owner
Copy Link
Copy Source

Closing — PR #149 merged. VIN Decoder spec is now included in every build-docs.yaml CI run.

Closing — PR #149 merged. VIN Decoder spec is now included in every build-docs.yaml CI run.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
P1
P2
P3
agent-ready
Ready for /manager to dispatch to @repo-manager
 blocked
Depends on another issue or external prerequisite
 large
medium
phase-0
Orientation / one-time setup
 phase-1
OpenAPI contract
 phase-2
Data acquisition + caching
 phase-3
API server implementation
 phase-4
Container + Helm chart
 phase-5
GitOps deploy via Flux
 phase-6
Pricing + RapidAPI listing
 roadmap
Long-horizon item /sprint will sequence
 small
No Label P2 agent-ready phase-5 small
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
0xWheatyz AI-CEO AI-Engineer AI-Manager AI-QA
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/api-company#148
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?