Adopt the Promptkit v0.9 compatibility baseline

2026-08-29 14:08:35 +00:00
parent c35ac5a0cb
commit 1806df9888
19 changed files with 136 additions and 43 deletions
--- a/docs/api.md
+++ b/docs/api.md
@@ -67,15 +67,19 @@ The optional `model` object accepts `endpoint`, `model`, `temperature`,
 `max_tokens`, `top_p`, `timeout_seconds`, `service_tier`,
 `reasoning_effort`, `api_key_env`, and `extra_params`. Numeric ranges and
 framework credential semantics are defined by the
-[Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md).
+[Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md).
 Explicit zero values for the numeric fields are overrides; zero
 `timeout_seconds` disables the per-generation deadline only, retaining the
 request context and configured transport cap. The timeout layers are defined in
-the [Promptkit outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation).
+the [Promptkit outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation).

 Raw API-key values are not accepted. `api_key` and any other unknown model
 field cause `400 invalid_json`.

+`model.reasoning_effort` is an optional JSON string with three states: omission
+inherits the selected profile, a non-empty string replaces its value, and an
+empty string explicitly clears it. JSON `null` is treated as omission.
+
 ### Strict JSON

 Request decoding rejects malformed JSON, unknown fields at every request level,
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -69,7 +69,7 @@ only; the caller context and configured transport cap remain active. CLI
 durations are converted to whole seconds by truncation toward zero, so any
 duration whose absolute value is below one second becomes an explicit
 zero-second override. The timeout layers are defined in the
-[Promptkit outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation).
+[Promptkit outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation).

 There is no raw API-key flag. Use `--api-key-env`.

--- a/docs/config.md
+++ b/docs/config.md
@@ -3,7 +3,7 @@
 This is the canonical reference for Scriptorium application settings. Prompt,
 profile, schema, execution-setting, built-in profile, and framework credential
 semantics are defined by the
-[Promptkit v0.1.0 format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md).
+[Promptkit v0.9.0 format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md).
 For command syntax, see the [CLI reference](cli.md); for HTTP request shapes and
 outcomes, see the [HTTP API reference](api.md).

@@ -58,7 +58,7 @@ parse those framework file formats.
  contracts.

 See the
-[tagged Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md)
+[tagged Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
 for all of those definitions. The files under
 [`examples/prompts`](../examples/prompts/),
 [`examples/profiles`](../examples/profiles/), and
@@ -73,8 +73,20 @@ their names in configuration or framework source files. Do not place raw keys
 in configuration, prompts, profiles, CLI arguments, examples, or HTTP
 payloads.

+An optional `api_key_env` whose environment value is absent or empty can result
+in an unauthenticated provider request. A profile that declares credentials
+required still fails as an invalid request when no credential source is
+selected, and fails with `ErrAPIKeyEnvMissing` when its selected environment
+source is absent or empty. Scriptorium never reads or emits the environment
+value itself.
+
+Unset optional provider controls are omitted from compatible provider requests.
+A positive Promptkit `repair_attempts` budget can add provider calls, latency,
+token use, and cost; see the tagged format reference for its permitted values
+and validation-mode requirements.
+
 Promptkit's
-[OpenAI-compatible integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/integrations/openai-compatible-chat.md)
+[OpenAI-compatible integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/integrations/openai-compatible-chat.md)
 defines outbound authentication, provider request mapping, transport limits,
 and timeout layering.

@@ -83,4 +95,4 @@ and timeout layering.
 - [CLI reference](cli.md)
 - [HTTP API reference](api.md)
 - [Operations guide](operations.md)
- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md)
+- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
--- a/docs/consumers/api.md
+++ b/docs/consumers/api.md
@@ -14,7 +14,7 @@ and the HTTP service according to the boundary your application needs.

 Go applications that need an in-process prompt framework should import
 Promptkit directly. The tagged
-[Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
+[Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md)
 owns that interface; Scriptorium does not provide a Go library package.
 Consumers arriving from the former Scriptorium Go API should follow the
 [migration guide](migrating-to-promptkit.md).
@@ -35,4 +35,4 @@ Scriptorium does not persist run state. A retry can produce different output
 and can incur another provider request. CLI exits belong to the
 [CLI reference](../cli.md), HTTP status behavior belongs to the
 [HTTP API reference](../api.md), and framework semantics belong to
-[Promptkit v0.1.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md).
+[Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md).
--- a/docs/consumers/migrating-to-promptkit.md
+++ b/docs/consumers/migrating-to-promptkit.md
@@ -4,7 +4,7 @@

 Scriptorium `v0.11.1` at
 `gitea.maximumdirect.net/eric/scriptorium` is the final release that provides
-the former in-process Go framework. Promptkit `v0.1.0` at
+the former in-process Go framework. Promptkit `v0.9.0` at
 `gitea.maximumdirect.net/eric/promptkit` is the destination for that framework
 API. Scriptorium `v0.12.0` and later provide the CLI and HTTP application only.

@@ -19,7 +19,7 @@ Start from a clean consumer checkout and review the pending diff before
 committing it. Add the published Promptkit module:

 ```sh
-go get gitea.maximumdirect.net/eric/promptkit@v0.1.0
+go get gitea.maximumdirect.net/eric/promptkit@v0.9.0
 ```

 For an ordinary consumer that imports the former root package under its
@@ -51,14 +51,14 @@ go mod tidy
 go test ./...
 ```

-Confirm that `go.mod` selects Promptkit `v0.1.0` and that no Go file imports
+Confirm that `go.mod` selects Promptkit `v0.9.0` and that no Go file imports
 the former Scriptorium package:

 ```sh
 test "$(
  go list -m -f '{{.Path}}@{{.Version}}' \
    gitea.maximumdirect.net/eric/promptkit
-)" = 'gitea.maximumdirect.net/eric/promptkit@v0.1.0'
+)" = 'gitea.maximumdirect.net/eric/promptkit@v0.9.0'
 if git grep -n \
  'gitea.maximumdirect.net/eric/scriptorium' \
  -- '*.go'
@@ -73,20 +73,20 @@ fi
 Promptkit preserves the established engine, request, result, profile,
 source-option, model-client, artifact, validation-value, and public-error
 shapes where practical. Exact declarations and current behavior belong to the
-tagged [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
+tagged [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md)
 and Go source.

 Promptkit also includes migration-relevant public contracts that were not in
 Scriptorium `v0.11.1`:

- [`WithArtifactReader`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/engine.go#L96-L105)
+- [`WithArtifactReader`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/engine.go#L182)
  and the
-  [`ArtifactReader` declaration](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/types.go#L129-L135)
+  [`ArtifactReader` declaration](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/types.go#L304)
  provide the artifact-reading extension described by the tagged
-  [extension-interface guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md#extension-interfaces).
- [`ErrProfileRequired` and `ErrAPIKeyEnvMissing`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/engine.go#L28-L40)
+  [extension-interface guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md#extension-interfaces).
+- [`ErrProfileRequired` and `ErrAPIKeyEnvMissing`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/engine.go#L46-L61)
  provide the specific identities described by the tagged
-  [error guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md#errors).
+  [error guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md#errors).

 Use those tagged owners for exact signatures, wrapping guarantees, and
 extension behavior.
--- a/docs/development.md
+++ b/docs/development.md
@@ -2,7 +2,7 @@

 This is the contributor entry point for Scriptorium. Scriptorium is an
 application that consumes the public
-[Promptkit v0.1.0 package](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md);
+[Promptkit v0.9.0 package](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md);
 framework implementation work belongs in Promptkit.

 ## Initial Orientation
@@ -27,12 +27,12 @@ tests.
 | HTTP routes, DTOs, limits, status mapping, or artifact policy | [HTTP API contract](api.md), [adapter internals](internal/adapters.md), and [source internals](internal/sources.md) |
 | Application configuration or precedence | [Configuration contract](config.md), [adapter internals](internal/adapters.md), and [source internals](internal/sources.md) |
 | Prepared-run presentation | [CLI contract](cli.md), [adapter internals](internal/adapters.md), and `internal/format` |
-| Prompt, profile, schema, generation, or validation semantics | [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md) and the [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md) |
-| OpenAI-compatible outbound behavior or timeout layering | [Promptkit integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/integrations/openai-compatible-chat.md) |
+| Prompt, profile, schema, generation, or validation semantics | [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md) and the [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md) |
+| OpenAI-compatible outbound behavior or timeout layering | [Promptkit integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/integrations/openai-compatible-chat.md) |
 | Subprocess behavior | [Subprocess integration](integrations/subprocess.md) and [CLI contract](cli.md) |
 | Runtime operation or recovery | [Operations](operations.md) |
 | Release packaging or publication | The [release procedure](release.md), [hosted release workflow](../.woodpecker/release.yml), and [architecture policy](policy/architecture.md) |
-| Examples or copyable assets | The owning Scriptorium contract, the relevant [Promptkit format contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md), and the related files under `examples/` |
+| Examples or copyable assets | The owning Scriptorium contract, the relevant [Promptkit format contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md), and the related files under `examples/` |
 | Architecture decisions or future work | The [documentation policy](policy/documentation.md), relevant accepted ADRs, and relevant roadmap documents |

 Cross-project changes land and release in Promptkit before Scriptorium adopts
--- a/docs/internal/adapters.md
+++ b/docs/internal/adapters.md
@@ -9,7 +9,7 @@ own IO and presentation mechanics, not framework decisions.
 External contracts are canonical in the [CLI reference](../cli.md) and
 [HTTP API reference](../api.md). Promptkit's public engine contract is
 described by its tagged
-[Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md).
+[Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md).

 ## Components And Collaborators

--- a/docs/internal/overview.md
+++ b/docs/internal/overview.md
@@ -14,5 +14,5 @@ public behavior belongs in the linked contracts.
 | `internal/format` | Formats Promptkit prepared-run values for CLI text or JSON output. | [CLI contract](../cli.md), [adapter internals](adapters.md) |

 Framework implementation packages are provided by
-[Promptkit v0.1.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
+[Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md)
 and are not part of this repository.
--- a/docs/internal/sources.md
+++ b/docs/internal/sources.md
@@ -5,7 +5,7 @@
 This document covers Scriptorium-owned source locations and the restricted HTTP
 artifact reader. Prompt, profile, schema, and ordinary artifact semantics are
 owned by the tagged
-[Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md).
+[Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md).

 ## Application Source Locations

--- a/docs/operations.md
+++ b/docs/operations.md
@@ -9,7 +9,7 @@ fields, or HTTP wire behavior.
 - [CLI reference](cli.md): commands, output destinations, and exit codes.
 - [Configuration reference](config.md): application settings, source
  locations, defaults, and credential mapping.
- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md):
+- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md):
  prompt, profile, schema, execution-setting, and framework credential
  contracts.
 - [HTTP API reference](api.md): route, request/response schema, status codes,
--- a/docs/policy/architecture.md
+++ b/docs/policy/architecture.md
@@ -10,7 +10,7 @@ Scriptorium is an executable application with three entry paths: CLI `run`, CLI
 root Go package.

 The application consumes
-[Promptkit v0.1.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
+[Promptkit v0.9.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/consumers/pkg-promptkit.md)
 through its supported root package. Promptkit owns prompt execution,
 preparation, source formats, built-in profiles, model-client behavior, and
 validation. Scriptorium owns application configuration, executable adapters,
@@ -33,6 +33,7 @@ gitea.maximumdirect.net/eric/promptkit

 - Retained application packages may import Promptkit's root package.
 - They must not import Promptkit `internal` packages.
+- They must not import Promptkit catalog modules directly.
 - They must not import the removed Scriptorium root facade or recreate former
  framework package families.
 - Adapter-owned interfaces use Promptkit public values when a consumer-side
@@ -54,9 +55,9 @@ invariants.
 - `internal/defaults` owns Scriptorium application and HTTP defaults only.
 - `internal/format` owns deterministic prepared-run text and JSON presentation.
 - Promptkit owns framework orchestration and contracts. Its
-  [format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/formats.md)
+  [format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
  and
-  [outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/integrations/openai-compatible-chat.md)
+  [outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/integrations/openai-compatible-chat.md)
  are canonical.

 ## HTTP Artifact Security Boundary
--- a/docs/release.md
+++ b/docs/release.md
@@ -103,7 +103,7 @@ test "$(
 )" = 'gitea.maximumdirect.net/eric/scriptorium 1.25.5'
 ```

-Require Promptkit `v0.1.0` as both the direct module-graph edge and the selected
+Require Promptkit `v0.9.0` as both the direct module-graph edge and the selected
 module version:

 ```sh
@@ -117,11 +117,11 @@ direct_promptkit=$(
        '
 )
 test "$direct_promptkit" = \
-    'gitea.maximumdirect.net/eric/promptkit@v0.1.0'
+    'gitea.maximumdirect.net/eric/promptkit@v0.9.0'
 test "$(
    GOWORK=off go list -m -f '{{.Path}}@{{.Version}}' \
        gitea.maximumdirect.net/eric/promptkit
-)" = 'gitea.maximumdirect.net/eric/promptkit@v0.1.0'
+)" = 'gitea.maximumdirect.net/eric/promptkit@v0.9.0'
 GOWORK=off go list -m all
 ```

--- a/docs/roadmap/implementation.md
+++ b/docs/roadmap/implementation.md
@@ -31,6 +31,8 @@ stage's completion conditions are unmet.

 ## Stage 1: Adopt The Promptkit v0.9.0 Compatibility Baseline

+**Completion: Complete.**
+
 Make the released dependency the build baseline before adding new application
 surface area.