Skip to content

docs: document POST /models/reload under model management - #11656

Closed
pos-ei-don wants to merge 1 commit into
mudler:masterfrom
pos-ei-don:docs/runtime-reload-and-aliases
Closed

docs: document POST /models/reload under model management#11656
pos-ei-don wants to merge 1 commit into
mudler:masterfrom
pos-ei-don:docs/runtime-reload-and-aliases

Conversation

@pos-ei-don

@pos-ei-don pos-ei-don commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

What

Adds POST /models/reload to the model-management docs, plus one missing row in the model config field table.

/models/reload is currently mentioned only in operations/middleware.md, in the context of router configs. Someone managing models reads Advanced usage → Install models using the API, finds only /models/apply — which installs from a gallery definition and downloads files — and concludes that a locally written YAML needs a restart. This puts the endpoint next to /models/apply and states the difference.

It also records a limit that is documented nowhere and is easy to get wrong: reloading adds new configurations and replaces changed ones, but does not drop a configuration whose file was deleted — that entry stays in /v1/models until restart.

The second hunk is a single row adding alias to the field table in the model configuration reference, linking to the existing Model Aliases page.

Verified

Against a running v4.7.1, not inferred from the source: adding an alias config and re-pointing an existing one both took effect after /models/reload without a restart; deleting the file did not remove the entry.

Docs only — no code changes.


Assisted-by: Claude:claude-opus-5 — per CONTRIBUTING.md, I have reviewed the change and am responsible for it.

`/models/reload` is currently mentioned only in `operations/middleware.md`, in
the context of router configs. Someone managing models reads
`advanced-usage.md`, finds only `/models/apply` — which downloads from a gallery
definition — and concludes that a locally written YAML needs a restart. This
adds the endpoint next to `/models/apply` and states the difference.

It also records a limit that is documented nowhere and is easy to get wrong:
reloading adds new configurations and replaces changed ones, but does not drop a
configuration whose file was deleted. That entry stays in `/v1/models` until
restart.

Verified against a running v4.7.1: adding an alias config and re-pointing an
existing one both took effect after /models/reload; deleting the file did not
remove the entry.

Also adds the `alias` field to the model config field table, linking to the
existing Model Aliases page.

Assisted-by: Claude:claude-opus-5
@pos-ei-don pos-ei-don changed the title docs: document /models/reload and the model alias field docs: document POST /models/reload under model management Aug 21, 2026
@pos-ei-don
pos-ei-don force-pushed the docs/runtime-reload-and-aliases branch from 3393ae0 to 127d005 Compare August 21, 2026 09:20

@localai-org-maint-bot localai-org-maint-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation matches the endpoint implementation and current additive reload behavior. The alias field and link are also accurate. The only blocker is DCO: the commit lacks a human Signed-off-by trailer, and the DCO check fails. Please amend the commit with your own sign-off and force-push it. I cannot add that attestation for you.

@pos-ei-don pos-ei-don closed this Aug 21, 2026
@pos-ei-don
pos-ei-don deleted the docs/runtime-reload-and-aliases branch August 21, 2026 12:26
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.

2 participants