Skip to content

docs(policy): publish a versioned policy schema reference; the linked page returns 404 #4292

Closed

Description

@anthonychung

Version. OpenShell 0.1.2. Observed 2026-09-29.

Observed. The policy schema reference page linked from the docs returned HTTP 404. To write a working policy we derived the schema by hand from proto/sandbox.proto, crates/openshell-policy/src/l7_validate.rs and the fixture YAMLs in the repo.

Why it matters. Policy is the security boundary. An integrator who cannot read the schema either copies a fixture they do not fully understand or reverse-engineers the validator, and both produce policies that are hard to review.

Ask. Generate a schema reference from sandbox.proto and publish it versioned with each release, so the page can never drift from the binary.

Related: #3388 (public policy protobuf) would make this straightforward; #4035 (a policy check command) would pair well with it.

Activity

  1. TaylorMutch commented on Oct 21, 2026

    @TaylorMutch
    Collaborator

    📋 triage-agent

    The reported documentation failure is resolved:

    The reference is not automatically generated, but generating it from sandbox.proto is no longer the correct source-of-truth model. The canonical authored policy representation now lives in openshell-policy-schema, with protobuf adaptation handled separately. Automated drift detection can be tracked as a narrower follow-up if desired.

    Closing as completed because the reported 404 and versioned-reference requirement are resolved.

  2. added
    state:acceptedA maintainer decided OpenShell should pursue this issue
    and removed
    state:triage-neededOpened without agent diagnostics and needs triage
    on Oct 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    state:acceptedA maintainer decided OpenShell should pursue this issue

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions