Skip to content

docs: capture Forge spec-vs-runtime findings#20

Merged
fbarrento merged 1 commit into
mainfrom
docs/forge-api-findings
May 19, 2026
Merged

docs: capture Forge spec-vs-runtime findings#20
fbarrento merged 1 commit into
mainfrom
docs/forge-api-findings

Conversation

@fbarrento
Copy link
Copy Markdown
Contributor

Summary

Small docs-only PR adding `docs/FINDINGS.md`. Records five concrete places where Forge's runtime behavior diverges from `docs/forge.openapi.json` (or where we made a deliberate design call around an ambiguity), each with the spec claim, the actual behavior, and which SDK code accommodates it.

Entries:

  • `hetzner.size_id` only accepts the size code, not the Forge id
  • `hetzner.network_id` is runtime-required despite being optional in spec
  • Fresh (202 async) servers return `revoked: null` / `connection_status: null`
  • `meta.sudo_password` leaks on create response
  • Compute provider slugs / disk types / architectures are open strings, not enums

Test plan

  • No code changes; `composer test` unaffected.

🤖 Generated with Claude Code

Captures the four spec mismatches surfaced while building the Servers
slice (#18 + #19) plus the open-strings-not-enums decision from the
Providers slice (#16 + #17). Append future findings here so the next
debugging session can find the answer without re-running live-fire
investigations.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@fbarrento fbarrento self-assigned this May 19, 2026
@fbarrento fbarrento merged commit 1e91d39 into main May 19, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant