Skip to content

docs: document config.json resolution — served at /.blocks-sandbox/config.json, {"_placeholder":true} expected locally, /config.json 404s #238

Description

@hfurkanbozkurt

Which package(s) are affected?

@aws-blocks/core (client config resolution) + Developer Guide

Describe the problem

The runtime config is fetched from /.blocks-sandbox/config.json (a dotted directory), NOT /config.json. Undocumented: (1) locally the file is {"_placeholder":true} by design - the real apiUrl is injected at deploy, so the placeholder locally is CORRECT; (2) curl /config.json returns 404, so people wrongly conclude config is missing. Only discoverable by reading compiled client source.

Impact

Wasted debugging cycles and false "config broken" conclusions; agents curl /config.json, get 404, mis-diagnose the app.

Proposed fix

Document in the Developer Guide (local-dev + deploy) and client getApiUrl docs: config is served at /.blocks-sandbox/config.json (dotted dir); {"_placeholder":true} is the expected local body (real apiUrl injected at deploy); /config.json is intentionally not a route (the 404 is expected).

Related

#173 (placeholder config served long-term post-deploy) - a library bug on the same file; this is the docs gap.

Metadata

Metadata

Assignees

No one assigned

    Labels

    pending-maintainer-responseWaiting on a response from the maintainerspending-triageIssue is pending triage by the maintainers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions