Skip to content

Commit f013ba2

Browse files
committed
docs: note that deploy_component mount options require package
Addresses PR review: - `deployComponentValidator` declares `.with('urlPath','package').with('host','package')`, so both are rejected on a payload-only deploy. The "Additional parameters" list implied otherwise; state the requirement and point payload deploys at the root-config entry. - Badge the new `host` parameter with v5.2.0 per the versioning rule. - Use a relative link for the middleware-routing reference, matching the rest of the file (21 relative links vs the one absolute one this PR introduced).
1 parent b36d21e commit f013ba2

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

reference/operations-api/operations.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -604,11 +604,13 @@ Deploys a component. The `package` option accepts any valid NPM reference includ
604604

605605
Additional parameters:
606606

607-
- `urlPath` — the HTTP URL path the component is mounted at (e.g. `"/api/v2"`). Must not contain `..` or `.` path segments. Persisted on the component's root-config entry; see [HTTP middleware routing](/reference/v5/http/overview#middleware-routing).
608-
- `host` — the virtual hostname the component is served on (e.g. `"api.example.com"`). Must be a bare hostname or IPv6 literal — no scheme, port, path, or brackets. Persisted alongside `urlPath`.
607+
- `urlPath` — the HTTP URL path the component is mounted at (e.g. `"/api/v2"`). Must not contain `..` or `.` path segments. Persisted on the component's root-config entry; see [HTTP middleware routing](../http/overview.md#middleware-routing).
608+
- `host` <VersionBadge version="v5.2.0" /> — the virtual hostname the component is served on (e.g. `"api.example.com"`). Must be a bare hostname or IPv6 literal — no scheme, port, path, or brackets. Persisted alongside `urlPath`.
609609
- `install_allow_scripts` — set to `true` to allow npm pre/post install scripts (disabled by default)
610610
- `credentials` — credentials for installing a component from a private npm registry or private git repository (see below)
611611

612+
`urlPath` and `host` both require `package` and are rejected on a payload-only deploy. To mount a payload-deployed component, add `host`/`urlPath` to its entry in the root `harper-config.yaml` instead.
613+
612614
#### Deploy credentials (`credentials`)
613615

614616
When a component is installed from a private source, `credentials` supplies the authentication. It is an array of entries; each entry is one of two kinds, identified by its key:

0 commit comments

Comments
 (0)