Establish canonical documentation links
This commit is contained in:
@@ -1,14 +1,14 @@
|
||||
# HTTP API Integration
|
||||
# HTTP API Reference
|
||||
|
||||
## Scope
|
||||
|
||||
This document defines the implemented inbound HTTP contract for Scriptorium.
|
||||
This document is the canonical public HTTP contract for Scriptorium.
|
||||
|
||||
Current scope is only:
|
||||
|
||||
- `POST /v1/runs`
|
||||
|
||||
For CLI behavior, see the [CLI reference](../cli.md).
|
||||
For CLI behavior, see the [CLI reference](cli.md).
|
||||
|
||||
## Endpoint
|
||||
|
||||
@@ -20,8 +20,8 @@ go run ./cmd/scriptorium render \
|
||||
|
||||
Integration references:
|
||||
|
||||
- [HTTP contract](integrations/http-api.md)
|
||||
- [Narratio subprocess contract](integrations/narratio.md)
|
||||
- [HTTP API reference](api.md)
|
||||
- [Subprocess integration](integrations/subprocess.md)
|
||||
|
||||
## Common Argument Rules
|
||||
|
||||
|
||||
@@ -328,5 +328,5 @@ examples/schemas/dnd/structured_events.schema.json
|
||||
|
||||
## Integration References
|
||||
|
||||
- [Inbound HTTP contract](integrations/http-api.md)
|
||||
- [HTTP API reference](api.md)
|
||||
- [Outbound OpenAI-compatible contract](integrations/openai-compatible-chat.md)
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Scriptorium can be used by consumers through three implemented surfaces:
|
||||
|
||||
- CLI commands, documented in [CLI reference](../cli.md).
|
||||
- HTTP `POST /v1/runs`, documented in [HTTP API integration](../integrations/http-api.md).
|
||||
- HTTP `POST /v1/runs`, documented in [HTTP API reference](../api.md).
|
||||
- Go package `gitea.maximumdirect.net/eric/scriptorium`, documented in [pkg-scriptorium](pkg-scriptorium.md).
|
||||
|
||||
The Go package is the typed in-process API. It prepares prompts, runs prompts, accepts file or inline artifacts, supports per-request execution overrides, and exposes stable public errors for `errors.Is`.
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# Narratio Subprocess Integration
|
||||
# Subprocess Integration
|
||||
|
||||
## Purpose
|
||||
|
||||
This document defines the supported subprocess contract for Narratio invoking Scriptorium through the public CLI.
|
||||
This document defines the supported subprocess contract for downstream applications invoking Scriptorium through the public CLI.
|
||||
|
||||
This is a CLI contract, not an internal Go package integration.
|
||||
|
||||
## Supported Commands
|
||||
|
||||
Narratio should invoke:
|
||||
Downstream applications should invoke:
|
||||
|
||||
- `scriptorium run`
|
||||
- `scriptorium render`
|
||||
@@ -37,7 +37,7 @@ scriptorium render \
|
||||
--format json
|
||||
```
|
||||
|
||||
Narratio may add:
|
||||
Callers may add:
|
||||
|
||||
- `--config <path>`
|
||||
- `--profile <profile_id>`
|
||||
@@ -47,7 +47,7 @@ Narratio may add:
|
||||
|
||||
## Config And Directory Behavior
|
||||
|
||||
Narratio can rely on resolved app config or pass explicit paths.
|
||||
Callers can rely on resolved app config or pass explicit paths.
|
||||
|
||||
- default config search order:
|
||||
1. `/usr/local/etc/scriptorium/config.yml`
|
||||
@@ -63,7 +63,7 @@ Profile selection follows runner behavior:
|
||||
2. prompt `default_profile`
|
||||
3. error if neither is available
|
||||
|
||||
Narratio should treat prompt/profile IDs as deployment configuration, not hardcoded logic.
|
||||
Callers should treat prompt/profile IDs as deployment configuration, not hardcoded logic.
|
||||
|
||||
## Input And Variable Contract
|
||||
|
||||
@@ -91,7 +91,7 @@ Narratio should treat prompt/profile IDs as deployment configuration, not hardco
|
||||
- stdout: prepared-run output unless `--out` is used
|
||||
- stderr: errors
|
||||
|
||||
Narratio should capture stdout and stderr separately.
|
||||
Callers should capture stdout and stderr separately.
|
||||
|
||||
## Exit Status Contract
|
||||
|
||||
@@ -176,7 +176,7 @@ Relevant links:
|
||||
|
||||
- [CLI reference](cli.md)
|
||||
- [Configuration reference](config.md)
|
||||
- [HTTP API integration](integrations/http-api.md)
|
||||
- [HTTP API reference](api.md)
|
||||
|
||||
## Prompt Template Render Failures
|
||||
|
||||
|
||||
Reference in New Issue
Block a user