Skip to content

Document the endpoint preview method - #145

Draft
simsinght wants to merge 1 commit into
mainfrom
verify-endpoint-previews
Draft

Document the endpoint preview method#145
simsinght wants to merge 1 commit into
mainfrom
verify-endpoint-previews

Conversation

@simsinght

Copy link
Copy Markdown
Contributor

Adds documentation for the endpoint preview method in Verify:

  • Preview YAML reference: a method field on preview entries (sandbox remains the default; existing configs unchanged), with a new endpoint fields section.
  • Concepts: Previews: an "Externally hosted previews" section — responsibility split, wait-then-degrade behavior, and when to choose endpoint over sandbox.
  • New how-to: Registering an external preview — the registration API shape (POST/DELETE /api/v1/verify/preview-environment), a CI example, the credentials contract ({{ secrets.NAME }}), re-registration, expiry, and deregistration.
  • SUMMARY entry plus a pointer from Creating a preview.

https://claude.ai/code/session_01YT9NoKuriUGiRkRCzMw7AE

Verify preview configs gain a method field: sandbox (the default,
today's image-based previews) and endpoint, where a CI pipeline
registers the URL of an environment it deployed. Covers the config
schema, the registration API, waiting and degrade behavior, credential
handling, re-registration, and expiry.

Claude-Session: https://claude.ai/code/session_01YT9NoKuriUGiRkRCzMw7AE
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.

1 participant