docs: simplify audit log, update BYOK apiKey docs (PLT-809, PLT-810) - #11
Closed
factory-austin wants to merge 1 commit into
Closed
docs: simplify audit log, update BYOK apiKey docs (PLT-809, PLT-810)#11factory-austin wants to merge 1 commit into
factory-austin wants to merge 1 commit into
Conversation
- Replace detailed audit-log.mdx event schema/tables/examples with a general spec listing event categories at a high level - PLT-809: Document that the managed-settings endpoint rejects net-new static-apiKey custom models; add apiKeyHelper, apiKeyHelperTtlMs, and authMode fields to the org-managed customModels schema; update the full org-managed settings example to use apiKeyHelper - PLT-810: Make apiKey optional in the BYOK overview supported-fields table (keyless HTTP custom models now validate without a key); update Ollama and LM Studio notes to say apiKey can be omitted entirely - Apply matching updates to the Japanese (jp) translations Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Contributor
|
Droid encountered an error —— View job |
Contributor
Author
|
Closing — changes will be made in the factory-public-web repo instead. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three documentation updates in one PR:
1. Simplify audit log page to a general spec
Replaced the detailed event schema, source tables, event-type payloads, and JSON examples in
docs/enterprise/audit-log.mdxwith a high-level overview that lists the event categories at a general level. The full event structure is still available via the public API schema or account team.2. PLT-809 — Block net-new static-apiKey custom models in managed settings
PLT-809 | Source PR: factory-mono#17655
The managed-settings endpoint now rejects any net-new custom model that includes a static
apiKeyvalue with a 400. Updateddocs/enterprise/hierarchical-settings-and-org-control.mdxto:customModels[].apiKeyfrom required to optionalapiKeyHelper, env-var reference, system-managed MDM file)apiKeyHelper,apiKeyHelperTtlMs, andauthModefields to the schemaapiKeyHelperinstead of a static key3. PLT-810 — Support keyless custom models
PLT-810 | Source PR: factory-mono#17819
The CLI now validates and constructs clients for HTTP custom models without a key. Updated BYOK docs to:
apiKeyfrom required to optional in the supported-fields table (docs/cli/byok/overview.mdx)apiKeycan be omitted entirely for local serversJapanese translations
All of the above changes are mirrored in the
docs/jp/translations.